Merge pull request #1335 from Harshagracy/master

samples/react-webpartdetails/.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# we recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

samples/react-webpartdetails/.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules
+
+# Build generated files
+dist
+lib
+solution
+temp
+*.sppkg
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# OSX
+.DS_Store
+
+# Visual Studio files
+.ntvs_analysis.dat
+.vs
+bin
+obj
+
+# Resx Generated Code
+*.resx.ts
+
+# Styles Generated Code
+*.scss.ts

samples/react-webpartdetails/.yo-rc.json

@@ -0,0 +1,12 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "version": "1.10.0",
+    "libraryName": "getallwebpart",
+    "libraryId": "08fd2f74-80dc-45d6-9c3a-63dab7bf93d9",
+    "environment": "spo",
+    "packageManager": "npm",
+    "isCreatingSolution": true,
+    "isDomainIsolated": false,
+    "componentType": "webpart"
+  }
+}

samples/react-webpartdetails/README.md

@@ -0,0 +1,41 @@
+### React Webpart Details
+
+## Summary
+
+The web part illustrates how to get all the web part present in the current page, bind them in a multi-select dropdown.
+
+On selecting the web part title from the dropdown, it will be hidden. You can use this sample to as per the requirement.
+
+![React web part Details](./assets/webpartDetails.png)
+Note: This sample will not work in workbench as it loads the web part from current page and will not work for workbench.aspx.  To test locally, build the development package (using `gulp bundle` and `gulp package-solution`) and test it using `gulp serve`.
+
+## Used SharePoint Framework Version 
+
+![1.10.0](https://img.shields.io/badge/version-1.10.0-green.svg)
+
+## Applies to
+
+* [SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview)
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+React-webpartdetails| Harsha Vardhini ([@harshagracy](https://twitter.com/harshagracy) / [Harsha's Blog](https://harshagracy.com/))
+
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|June 13, 2020|Initial release
+
+## Minimal Path to Awesome
+
+- Clone this repository
+- in the command line run:
+  - `npm install`
+  - `gulp serve`
+
+
+<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-webpartdetails" />

samples/react-webpartdetails/config/config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "webpart-details-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/webpartDetails/WebpartDetailsWebPart.js",
+          "manifest": "./src/webparts/webpartDetails/WebpartDetailsWebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "WebpartDetailsWebPartStrings": "lib/webparts/webpartDetails/loc/{locale}.js"
+  }
+}

samples/react-webpartdetails/config/copy-assets.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/copy-assets.schema.json",
+  "deployCdnPath": "temp/deploy"
+}

samples/react-webpartdetails/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./temp/deploy/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "getallwebpart",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/react-webpartdetails/config/package-solution.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "getallwebpart-client-side-solution",
+    "id": "08fd2f74-80dc-45d6-9c3a-63dab7bf93d9",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true,
+    "isDomainIsolated": false
+  },
+  "paths": {
+    "zippedPackage": "solution/getallwebpart.sppkg"
+  }
+}

samples/react-webpartdetails/config/serve.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://localhost:5432/workbench",
+  "api": {
+    "port": 5432,
+    "entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
+  }
+}

samples/react-webpartdetails/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/react-webpartdetails/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const build = require('@microsoft/sp-build-web');
+
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+
+build.initialize(require('gulp'));

samples/react-webpartdetails/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "getallwebpart",
+  "version": "0.0.1",
+  "private": true,
+  "main": "lib/index.js",
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@microsoft/sp-core-library": "1.10.0",
+    "@microsoft/sp-lodash-subset": "1.10.0",
+    "@microsoft/sp-office-ui-fabric-core": "1.10.0",
+    "@microsoft/sp-property-pane": "1.10.0",
+    "@microsoft/sp-webpart-base": "1.10.0",
+    "@pnp/sp": "^2.0.5",
+    "@types/es6-promise": "0.0.33",
+    "@types/react": "16.8.8",
+    "@types/react-dom": "16.8.3",
+    "@types/webpack-env": "1.13.1",
+    "office-ui-fabric-react": "6.189.2",
+    "react": "16.8.5",
+    "react-dom": "16.8.5"
+  },
+  "resolutions": {
+    "@types/react": "16.8.8"
+  },
+  "devDependencies": {
+    "@microsoft/sp-build-web": "1.10.0",
+    "@microsoft/sp-tslint-rules": "1.10.0",
+    "@microsoft/sp-module-interfaces": "1.10.0",
+    "@microsoft/sp-webpart-workbench": "1.10.0",
+    "@microsoft/rush-stack-compiler-3.3": "0.3.5",
+    "gulp": "~3.9.1",
+    "@types/chai": "3.4.34",
+    "@types/mocha": "2.2.38",
+    "ajv": "~5.2.2"
+  }
+}

samples/react-webpartdetails/src/index.ts

@@ -0,0 +1 @@
+// A file is required to be in the root of the /src directory by the TypeScript compiler

samples/react-webpartdetails/src/webparts/webpartDetails/WebpartDetailsWebPart.manifest.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "a5fb382b-c805-405b-99e0-2e450f1324d9",
+  "alias": "WebpartDetailsWebPart",
+  "componentType": "WebPart",
+
+  // The "*" signifies that the version should be taken from the package.json
+  "version": "*",
+  "manifestVersion": 2,
+
+  // If true, the component can only be installed on sites where Custom Script is allowed.
+  // Components that allow authors to embed arbitrary script code should set this to true.
+  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
+  "requiresCustomScript": false,
+  "supportedHosts": ["SharePointWebPart"],
+
+  "preconfiguredEntries": [{
+    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
+    "group": { "default": "Other" },
+    "title": { "default": "webpartDetails" },
+    "description": { "default": "webpartDetails description" },
+    "officeFabricIconFontName": "Page",
+    "properties": {
+      "description": "webpartDetails"
+    }
+  }]
+}

samples/react-webpartdetails/src/webparts/webpartDetails/WebpartDetailsWebPart.ts

@@ -0,0 +1,70 @@
+import * as React from 'react';
+import * as ReactDom from 'react-dom';
+import { Version } from '@microsoft/sp-core-library';
+import {
+  IPropertyPaneConfiguration,
+  PropertyPaneTextField
+} from '@microsoft/sp-property-pane';
+import { BaseClientSideWebPart, WebPartContext } from '@microsoft/sp-webpart-base';
+
+import * as strings from 'WebpartDetailsWebPartStrings';
+import WebpartDetails from './components/WebpartDetails';
+import { IWebpartDetailsProps } from './components/IWebpartDetailsProps';
+import { sp } from "@pnp/sp/presets/all";
+export interface IWebpartDetailsWebPartProps {
+  description: string;
+  context: WebPartContext;
+}
+
+export default class WebpartDetailsWebPart extends BaseClientSideWebPart <IWebpartDetailsWebPartProps> {
+  protected onInit(): Promise<void> {
+
+    return super.onInit().then(_ => {
+  
+      // other init code may be present
+  
+      sp.setup({
+        spfxContext: this.context
+      });
+    });
+  }
+  public render(): void {
+    const element: React.ReactElement<IWebpartDetailsProps> = React.createElement(
+      WebpartDetails,
+      {
+        description: this.properties.description,
+        context: this.context
+      }
+    );
+
+    ReactDom.render(element, this.domElement);
+  }
+
+  protected onDispose(): void {
+    ReactDom.unmountComponentAtNode(this.domElement);
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: [
+        {
+          header: {
+            description: ''
+          },
+          groups: [
+            {
+              groupName: "No Configuration Required",
+              groupFields: [
+              
+              ]
+            }
+          ]
+        }
+      ]
+    };
+  }
+}

samples/react-webpartdetails/src/webparts/webpartDetails/components/IWebpartDetailState.ts

@@ -0,0 +1,5 @@
+export interface IWebpartDetailState {
+    webpartData: any[];
+    selectedWebpart: any;
+    selectedKeys: any[];
+}

samples/react-webpartdetails/src/webparts/webpartDetails/components/IWebpartDetailsProps.ts

@@ -0,0 +1,6 @@
+import { WebPartContext } from "@microsoft/sp-webpart-base";
+
+export interface IWebpartDetailsProps {
+  description: string;
+  context: WebPartContext;
+}

samples/react-webpartdetails/src/webparts/webpartDetails/components/WebpartDetails.module.scss

@@ -0,0 +1,83 @@
+@import '~office-ui-fabric-react/dist/sass/References.scss';
+
+.webpartDetails {
+  .container {
+    max-width: 700px;
+    margin: 0px auto;
+    box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
+  }
+
+  .row {
+    @include ms-Grid-row;
+    @include ms-fontColor-white;
+    background-color: $ms-color-themeDark;
+    padding: 20px;
+  }
+
+  .itemContent {
+    position: 'relative';
+    box-sizing: 'border-box';
+    display: 'block';
+    border-left: '3px solid '+ $ms-color-themePrimary;
+    padding-left: 27;
+
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .description {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .button {
+    // Our button
+    text-decoration: none;
+    height: 32px;
+
+    // Primary Button
+    min-width: 80px;
+    background-color: $ms-color-themePrimary;
+    border-color: $ms-color-themePrimary;
+    color: $ms-color-white;
+
+    // Basic Button
+    outline: transparent;
+    position: relative;
+    font-family: "Segoe UI WestEuropean", "Segoe UI", -apple-system, BlinkMacSystemFont, Roboto, "Helvetica Neue", sans-serif;
+    -webkit-font-smoothing: antialiased;
+    font-size: $ms-font-size-m;
+    font-weight: $ms-font-weight-regular;
+    border-width: 0;
+    text-align: center;
+    cursor: pointer;
+    display: inline-block;
+    padding: 0 16px;
+
+    .label {
+      font-weight: $ms-font-weight-semibold;
+      font-size: $ms-font-size-m;
+      height: 32px;
+      line-height: 32px;
+      margin: 0 4px;
+      vertical-align: top;
+      display: inline-block;
+    }
+  }
+}

samples/react-webpartdetails/src/webparts/webpartDetails/components/WebpartDetails.tsx

@@ -0,0 +1,85 @@
+import * as React from 'react';
+import styles from './WebpartDetails.module.scss';
+import { IWebpartDetailsProps } from './IWebpartDetailsProps';
+import { sp } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { IFile } from '@pnp/sp/files/types';
+import { ClientsidePageFromFile, IClientsidePage } from "@pnp/sp/clientside-pages";
+import { Dropdown, IDropdownOption } from 'office-ui-fabric-react/lib/Dropdown';
+import { IWebpartDetailState } from './IWebpartDetailState';
+
+export default class WebpartDetails extends React.Component<IWebpartDetailsProps, IWebpartDetailState> {
+  constructor(props: IWebpartDetailsProps, state: any) {
+    super(props);
+    this.state = {
+      webpartData: [],
+      selectedWebpart: null,
+      selectedKeys: []
+    };
+  }
+  public componentWillMount() {
+    this.getallwebpart();
+  }
+  public async getallwebpart() {
+    let webpartdata = [];
+    let file: IFile = sp.web.getFileByServerRelativePath(this.props.context.pageContext.site.serverRequestPath);
+    let page: IClientsidePage = await ClientsidePageFromFile(file);
+    page.sections.forEach(section => {
+      //loop through each section
+      section.columns.forEach(column => {
+        //loop through each column and control in the selected section
+        column.controls.forEach(control => {
+          //exclude the current webpart
+          if (this.props.context.instanceId !== control.data.id) {
+            let webpart = {
+              key: control.data.id,
+              text: (control.data.webPartData && control.data.webPartData.title) || this.htmlToText(control.data.innerHTML)
+            };
+            webpartdata.push(webpart);
+          }
+        });
+      });
+    });
+    this.setState({
+      webpartData: webpartdata
+    });
+  }
+  public htmlToText(html: string) {
+    //create a temporary div and get the text of the div and remove the div from DOM
+    let tempDiv = document.createElement('div');
+    tempDiv.innerHTML = html;
+    let displayTitle = tempDiv.textContent.substring(0, tempDiv.textContent.length > 20 ? 20 : tempDiv.textContent.length) + '...';
+    tempDiv.remove();
+    return displayTitle;
+  }
+  public onDropdownChange = (event: React.FormEvent<HTMLDivElement>, item: IDropdownOption): void => {
+    if (item) {
+      let selectedNode = document.querySelectorAll('[data-sp-feature-instance-id="' + item.key + '"]');
+      let parentNode: HTMLElement = selectedNode[0].parentNode as HTMLElement;
+      if (item.selected) {
+        //hide the webpart
+        parentNode.style.display = "none";
+      } else {
+        //unhide the webpart
+        parentNode.style.display = "flex";
+      }
+      this.setState({
+        selectedKeys: item.selected ? [...this.state.selectedKeys, item.key as string] : this.state.selectedKeys.filter(key => key !== item.key),
+      });
+    }
+  }
+  public render(): React.ReactElement<IWebpartDetailsProps> {
+    return (
+      <span>
+        <Dropdown
+          label="Select the webpart to hide"
+          selectedKeys={this.state.selectedKeys}
+          onChange={this.onDropdownChange}
+          multiSelect
+          placeholder="Select webparts"
+          options={this.state.webpartData}
+        />
+      </span>
+    );
+  }
+}

samples/react-webpartdetails/src/webparts/webpartDetails/loc/en-us.js

@@ -0,0 +1,7 @@
+define([], function() {
+  return {
+    "PropertyPaneDescription": "Description",
+    "BasicGroupName": "Group Name",
+    "DescriptionFieldLabel": "Description Field"
+  }
+});

samples/react-webpartdetails/src/webparts/webpartDetails/loc/mystrings.d.ts

@@ -0,0 +1,10 @@
+declare interface IWebpartDetailsWebPartStrings {
+  PropertyPaneDescription: string;
+  BasicGroupName: string;
+  DescriptionFieldLabel: string;
+}
+
+declare module 'WebpartDetailsWebPartStrings' {
+  const strings: IWebpartDetailsWebPartStrings;
+  export = strings;
+}

samples/react-webpartdetails/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "extends": "./node_modules/@microsoft/rush-stack-compiler-3.3/includes/tsconfig-web.json",
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "inlineSources": false,
+    "strictNullChecks": false,
+    "noUnusedLocals": false,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "lib"
+  ]
+}

samples/react-webpartdetails/tslint.json

@@ -0,0 +1,30 @@
+{
+  "extends": "@microsoft/sp-tslint-rules/base-tslint.json",
+  "rules": {
+    "class-name": false,
+    "export-name": false,
+    "forin": false,
+    "label-position": false,
+    "member-access": true,
+    "no-arg": false,
+    "no-console": false,
+    "no-construct": false,
+    "no-duplicate-variable": true,
+    "no-eval": false,
+    "no-function-expression": true,
+    "no-internal-module": true,
+    "no-shadowed-variable": true,
+    "no-switch-case-fall-through": true,
+    "no-unnecessary-semicolons": true,
+    "no-unused-expression": true,
+    "no-use-before-declare": true,
+    "no-with-statement": true,
+    "semicolon": true,
+    "trailing-comma": false,
+    "typedef": false,
+    "typedef-whitespace": false,
+    "use-named-parameter": true,
+    "variable-name": false,
+    "whitespace": false
+  }
+}