├── Demos ├── .DS_Store ├── 01-appcustomizer │ ├── src │ │ ├── index.ts │ │ └── extensions │ │ │ └── helloAppCustomizer │ │ │ ├── loc │ │ │ ├── en-us.js │ │ │ └── myStrings.d.ts │ │ │ ├── HelloAppCustomizerApplicationCustomizer.module.scss │ │ │ ├── HelloAppCustomizerApplicationCustomizer.manifest.json │ │ │ └── HelloAppCustomizerApplicationCustomizer.ts │ ├── config │ │ ├── sass.json │ │ ├── write-manifests.json │ │ ├── deploy-azure-storage.json │ │ ├── config.json │ │ ├── serve.json │ │ └── package-solution.json │ ├── .npmignore │ ├── sharepoint │ │ └── assets │ │ │ ├── elements.xml │ │ │ └── ClientSideInstance.xml │ ├── gulpfile.js │ ├── .vscode │ │ ├── settings.json │ │ └── launch.json │ ├── .gitignore │ ├── .yo-rc.json │ ├── tsconfig.json │ ├── package.json │ ├── README.md │ └── .eslintrc.js ├── 02-fieldcustomizer │ ├── src │ │ ├── index.ts │ │ └── extensions │ │ │ └── helloFieldCustomizer │ │ │ ├── loc │ │ │ ├── en-us.js │ │ │ └── myStrings.d.ts │ │ │ ├── HelloFieldCustomizerFieldCustomizer.module.scss │ │ │ ├── HelloFieldCustomizerFieldCustomizer.manifest.json │ │ │ └── HelloFieldCustomizerFieldCustomizer.ts │ ├── config │ │ ├── sass.json │ │ ├── write-manifests.json │ │ ├── deploy-azure-storage.json │ │ ├── config.json │ │ ├── serve.json │ │ └── package-solution.json │ ├── .npmignore │ ├── gulpfile.js │ ├── .vscode │ │ ├── settings.json │ │ └── launch.json │ ├── sharepoint │ │ └── assets │ │ │ └── elements.xml │ ├── .gitignore │ ├── .yo-rc.json │ ├── tsconfig.json │ ├── package.json │ ├── README.md │ └── .eslintrc.js ├── 03-listviewcommandset │ ├── src │ │ ├── index.ts │ │ └── extensions │ │ │ └── commandSetDemo │ │ │ ├── loc │ │ │ ├── en-us.js │ │ │ └── myStrings.d.ts │ │ │ ├── CommandSetDemoCommandSet.manifest.json │ │ │ └── CommandSetDemoCommandSet.ts │ ├── config │ │ ├── sass.json │ │ ├── write-manifests.json │ │ ├── deploy-azure-storage.json │ │ ├── config.json │ │ ├── serve.json │ │ └── package-solution.json │ ├── .npmignore │ ├── gulpfile.js │ ├── .vscode │ │ ├── settings.json │ │ └── launch.json │ ├── .gitignore │ ├── sharepoint │ │ └── assets │ │ │ ├── ClientSideInstance.xml │ │ │ └── elements.xml │ ├── .yo-rc.json │ ├── tsconfig.json │ ├── package.json │ ├── README.md │ └── .eslintrc.js └── README.md ├── 03 commandset.pptx ├── 02 fieldcustomizer.pptx ├── 01 into+appcustomizer.pptx ├── .gitignore ├── LICENSE ├── SECURITY.md └── README.md /Demos/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sharepoint/sp-dev-training-spfx-extensions/master/Demos/.DS_Store -------------------------------------------------------------------------------- /03 commandset.pptx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sharepoint/sp-dev-training-spfx-extensions/master/03 commandset.pptx -------------------------------------------------------------------------------- /02 fieldcustomizer.pptx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sharepoint/sp-dev-training-spfx-extensions/master/02 fieldcustomizer.pptx -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/index.ts: -------------------------------------------------------------------------------- 1 | // A file is required to be in the root of the /src directory by the TypeScript compiler 2 | -------------------------------------------------------------------------------- /01 into+appcustomizer.pptx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sharepoint/sp-dev-training-spfx-extensions/master/01 into+appcustomizer.pptx -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/index.ts: -------------------------------------------------------------------------------- 1 | // A file is required to be in the root of the /src directory by the TypeScript compiler 2 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/src/index.ts: -------------------------------------------------------------------------------- 1 | // A file is required to be in the root of the /src directory by the TypeScript compiler 2 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/sass.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/core-build/sass.schema.json" 3 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/sass.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/core-build/sass.schema.json" 3 | } -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/sass.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/core-build/sass.schema.json" 3 | } -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/extensions/helloAppCustomizer/loc/en-us.js: -------------------------------------------------------------------------------- 1 | define([], function() { 2 | return { 3 | "Title": "HelloAppCustomizerApplicationCustomizer" 4 | } 5 | }); -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/extensions/helloFieldCustomizer/loc/en-us.js: -------------------------------------------------------------------------------- 1 | define([], function() { 2 | return { 3 | "Title": "HelloFieldCustomizerFieldCustomizer" 4 | } 5 | }); -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/src/extensions/commandSetDemo/loc/en-us.js: -------------------------------------------------------------------------------- 1 | define([], function() { 2 | return { 3 | "Command1": "Command 1", 4 | "Command2": "Command 2" 5 | } 6 | }); -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/write-manifests.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json", 3 | "cdnBasePath": "" 4 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/write-manifests.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json", 3 | "cdnBasePath": "" 4 | } -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.npmignore: -------------------------------------------------------------------------------- 1 | !dist 2 | config 3 | 4 | gulpfile.js 5 | 6 | release 7 | src 8 | temp 9 | 10 | tsconfig.json 11 | tslint.json 12 | 13 | *.log 14 | 15 | .yo-rc.json 16 | .vscode 17 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/write-manifests.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json", 3 | "cdnBasePath": "" 4 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.npmignore: -------------------------------------------------------------------------------- 1 | !dist 2 | config 3 | 4 | gulpfile.js 5 | 6 | release 7 | src 8 | temp 9 | 10 | tsconfig.json 11 | tslint.json 12 | 13 | *.log 14 | 15 | .yo-rc.json 16 | .vscode 17 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.npmignore: -------------------------------------------------------------------------------- 1 | !dist 2 | config 3 | 4 | gulpfile.js 5 | 6 | release 7 | src 8 | temp 9 | 10 | tsconfig.json 11 | tslint.json 12 | 13 | *.log 14 | 15 | .yo-rc.json 16 | .vscode 17 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/extensions/helloFieldCustomizer/HelloFieldCustomizerFieldCustomizer.module.scss: -------------------------------------------------------------------------------- 1 | .HelloFieldCustomizer { 2 | .cell { 3 | display: 'inline-block'; 4 | } 5 | .filledBackground { 6 | background-color: #cccccc; 7 | width: 100px; 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/extensions/helloFieldCustomizer/loc/myStrings.d.ts: -------------------------------------------------------------------------------- 1 | declare interface IHelloFieldCustomizerFieldCustomizerStrings { 2 | Title: string; 3 | } 4 | 5 | declare module 'HelloFieldCustomizerFieldCustomizerStrings' { 6 | const strings: IHelloFieldCustomizerFieldCustomizerStrings; 7 | export = strings; 8 | } 9 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/src/extensions/commandSetDemo/loc/myStrings.d.ts: -------------------------------------------------------------------------------- 1 | declare interface ICommandSetDemoCommandSetStrings { 2 | Command1: string; 3 | Command2: string; 4 | } 5 | 6 | declare module 'CommandSetDemoCommandSetStrings' { 7 | const strings: ICommandSetDemoCommandSetStrings; 8 | export = strings; 9 | } 10 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/deploy-azure-storage.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json", 3 | "workingDir": "./release/assets/", 4 | "account": "", 5 | "container": "sp-fx-app-customizer", 6 | "accessKey": "" 7 | } -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/deploy-azure-storage.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json", 3 | "workingDir": "./release/assets/", 4 | "account": "", 5 | "container": "sp-fx-command-set", 6 | "accessKey": "" 7 | } -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/extensions/helloAppCustomizer/loc/myStrings.d.ts: -------------------------------------------------------------------------------- 1 | declare interface IHelloAppCustomizerApplicationCustomizerStrings { 2 | Title: string; 3 | } 4 | 5 | declare module 'HelloAppCustomizerApplicationCustomizerStrings' { 6 | const strings: IHelloAppCustomizerApplicationCustomizerStrings; 7 | export = strings; 8 | } 9 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/deploy-azure-storage.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json", 3 | "workingDir": "./release/assets/", 4 | "account": "", 5 | "container": "sp-fx-field-customizer", 6 | "accessKey": "" 7 | } -------------------------------------------------------------------------------- /Demos/01-appcustomizer/sharepoint/assets/elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 9 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/sharepoint/assets/ClientSideInstance.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 9 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/gulpfile.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const build = require('@microsoft/sp-build-web'); 4 | 5 | build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`); 6 | 7 | var getTasks = build.rig.getTasks; 8 | build.rig.getTasks = function () { 9 | var result = getTasks.call(build.rig); 10 | 11 | result.set('serve', result.get('serve-deprecated')); 12 | 13 | return result; 14 | }; 15 | 16 | build.initialize(require('gulp')); 17 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/gulpfile.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const build = require('@microsoft/sp-build-web'); 4 | 5 | build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`); 6 | 7 | var getTasks = build.rig.getTasks; 8 | build.rig.getTasks = function () { 9 | var result = getTasks.call(build.rig); 10 | 11 | result.set('serve', result.get('serve-deprecated')); 12 | 13 | return result; 14 | }; 15 | 16 | build.initialize(require('gulp')); 17 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/gulpfile.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const build = require('@microsoft/sp-build-web'); 4 | 5 | build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`); 6 | 7 | var getTasks = build.rig.getTasks; 8 | build.rig.getTasks = function () { 9 | var result = getTasks.call(build.rig); 10 | 11 | result.set('serve', result.get('serve-deprecated')); 12 | 13 | return result; 14 | }; 15 | 16 | build.initialize(require('gulp')); 17 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.vscode/settings.json: -------------------------------------------------------------------------------- 1 | // Place your settings in this file to overwrite default and user settings. 2 | { 3 | // Configure glob patterns for excluding files and folders in the file explorer. 4 | "files.exclude": { 5 | "**/.git": true, 6 | "**/.DS_Store": true, 7 | "**/bower_components": true, 8 | "**/coverage": true, 9 | "**/jest-output": true, 10 | "**/lib-amd": true, 11 | "src/**/*.scss.ts": true 12 | }, 13 | "typescript.tsdk": ".\\node_modules\\typescript\\lib" 14 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.vscode/settings.json: -------------------------------------------------------------------------------- 1 | // Place your settings in this file to overwrite default and user settings. 2 | { 3 | // Configure glob patterns for excluding files and folders in the file explorer. 4 | "files.exclude": { 5 | "**/.git": true, 6 | "**/.DS_Store": true, 7 | "**/bower_components": true, 8 | "**/coverage": true, 9 | "**/jest-output": true, 10 | "**/lib-amd": true, 11 | "src/**/*.scss.ts": true 12 | }, 13 | "typescript.tsdk": ".\\node_modules\\typescript\\lib" 14 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/sharepoint/assets/elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 11 | 12 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Dependency directories 7 | node_modules 8 | 9 | # Build generated files 10 | dist 11 | lib 12 | release 13 | solution 14 | temp 15 | *.sppkg 16 | .heft 17 | 18 | # Coverage directory used by tools like istanbul 19 | coverage 20 | 21 | # OSX 22 | .DS_Store 23 | 24 | # Visual Studio files 25 | .ntvs_analysis.dat 26 | .vs 27 | bin 28 | obj 29 | 30 | # Resx Generated Code 31 | *.resx.ts 32 | 33 | # Styles Generated Code 34 | *.scss.ts 35 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Dependency directories 7 | node_modules 8 | 9 | # Build generated files 10 | dist 11 | lib 12 | release 13 | solution 14 | temp 15 | *.sppkg 16 | .heft 17 | 18 | # Coverage directory used by tools like istanbul 19 | coverage 20 | 21 | # OSX 22 | .DS_Store 23 | 24 | # Visual Studio files 25 | .ntvs_analysis.dat 26 | .vs 27 | bin 28 | obj 29 | 30 | # Resx Generated Code 31 | *.resx.ts 32 | 33 | # Styles Generated Code 34 | *.scss.ts 35 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.vscode/settings.json: -------------------------------------------------------------------------------- 1 | // Place your settings in this file to overwrite default and user settings. 2 | { 3 | // Configure glob patterns for excluding files and folders in the file explorer. 4 | "files.exclude": { 5 | "**/.git": true, 6 | "**/.DS_Store": true, 7 | "**/bower_components": true, 8 | "**/coverage": true, 9 | "**/jest-output": true, 10 | "**/lib-amd": true, 11 | "src/**/*.scss.ts": true 12 | }, 13 | "typescript.tsdk": ".\\node_modules\\typescript\\lib" 14 | } -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Dependency directories 7 | node_modules 8 | 9 | # Build generated files 10 | dist 11 | lib 12 | release 13 | solution 14 | temp 15 | *.sppkg 16 | .heft 17 | 18 | # Coverage directory used by tools like istanbul 19 | coverage 20 | 21 | # OSX 22 | .DS_Store 23 | 24 | # Visual Studio files 25 | .ntvs_analysis.dat 26 | .vs 27 | bin 28 | obj 29 | 30 | # Resx Generated Code 31 | *.resx.ts 32 | 33 | # Styles Generated Code 34 | *.scss.ts 35 | -------------------------------------------------------------------------------- /Demos/README.md: -------------------------------------------------------------------------------- 1 | # Microsoft SharePoint Framework Training Module - Getting Started with SharePoint Framework Extensions 2 | 3 | This folder contains demos associated with the slide decks in this module. 4 | 5 | ## Demos 6 | 7 | - [Create an application customizer extension](./01-appcustomizer) 8 | - [Create a field customizer extension](./02-fieldcustomizer) 9 | - [Customize lists with command set extensions](./03-listviewcommandset) 10 | 11 | ## Running demonstrations 12 | 13 | Each demonstration is included as source code for convenience. 14 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/sharepoint/assets/ClientSideInstance.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 9 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/sharepoint/assets/elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 10 | 11 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json", 3 | "version": "2.0", 4 | "bundles": { 5 | "command-set-demo-command-set": { 6 | "components": [ 7 | { 8 | "entrypoint": "./lib/extensions/commandSetDemo/CommandSetDemoCommandSet.js", 9 | "manifest": "./src/extensions/commandSetDemo/CommandSetDemoCommandSet.manifest.json" 10 | } 11 | ] 12 | } 13 | }, 14 | "externals": {}, 15 | "localizedResources": { 16 | "CommandSetDemoCommandSetStrings": "lib/extensions/commandSetDemo/loc/{locale}.js" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json", 3 | "version": "2.0", 4 | "bundles": { 5 | "hello-field-customizer-field-customizer": { 6 | "components": [ 7 | { 8 | "entrypoint": "./lib/extensions/helloFieldCustomizer/HelloFieldCustomizerFieldCustomizer.js", 9 | "manifest": "./src/extensions/helloFieldCustomizer/HelloFieldCustomizerFieldCustomizer.manifest.json" 10 | } 11 | ] 12 | } 13 | }, 14 | "externals": {}, 15 | "localizedResources": { 16 | "HelloFieldCustomizerFieldCustomizerStrings": "lib/extensions/helloFieldCustomizer/loc/{locale}.js" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json", 3 | "version": "2.0", 4 | "bundles": { 5 | "hello-app-customizer-application-customizer": { 6 | "components": [ 7 | { 8 | "entrypoint": "./lib/extensions/helloAppCustomizer/HelloAppCustomizerApplicationCustomizer.js", 9 | "manifest": "./src/extensions/helloAppCustomizer/HelloAppCustomizerApplicationCustomizer.manifest.json" 10 | } 11 | ] 12 | } 13 | }, 14 | "externals": {}, 15 | "localizedResources": { 16 | "HelloAppCustomizerApplicationCustomizerStrings": "lib/extensions/helloAppCustomizer/loc/{locale}.js" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Hosted workbench", 6 | "type": "msedge", 7 | "request": "launch", 8 | "url": "https://{tenantDomain}/_layouts/workbench.aspx", 9 | "webRoot": "${workspaceRoot}", 10 | "sourceMaps": true, 11 | "sourceMapPathOverrides": { 12 | "webpack:///.././src/*": "${webRoot}/src/*", 13 | "webpack:///../../../src/*": "${webRoot}/src/*", 14 | "webpack:///../../../../src/*": "${webRoot}/src/*", 15 | "webpack:///../../../../../src/*": "${webRoot}/src/*" 16 | }, 17 | "runtimeArgs": [ 18 | "--remote-debugging-port=9222", 19 | "-incognito" 20 | ] 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Hosted workbench", 6 | "type": "msedge", 7 | "request": "launch", 8 | "url": "https://{tenantDomain}/_layouts/workbench.aspx", 9 | "webRoot": "${workspaceRoot}", 10 | "sourceMaps": true, 11 | "sourceMapPathOverrides": { 12 | "webpack:///.././src/*": "${webRoot}/src/*", 13 | "webpack:///../../../src/*": "${webRoot}/src/*", 14 | "webpack:///../../../../src/*": "${webRoot}/src/*", 15 | "webpack:///../../../../../src/*": "${webRoot}/src/*" 16 | }, 17 | "runtimeArgs": [ 18 | "--remote-debugging-port=9222", 19 | "-incognito" 20 | ] 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Hosted workbench", 6 | "type": "msedge", 7 | "request": "launch", 8 | "url": "https://{tenantDomain}/_layouts/workbench.aspx", 9 | "webRoot": "${workspaceRoot}", 10 | "sourceMaps": true, 11 | "sourceMapPathOverrides": { 12 | "webpack:///.././src/*": "${webRoot}/src/*", 13 | "webpack:///../../../src/*": "${webRoot}/src/*", 14 | "webpack:///../../../../src/*": "${webRoot}/src/*", 15 | "webpack:///../../../../../src/*": "${webRoot}/src/*" 16 | }, 17 | "runtimeArgs": [ 18 | "--remote-debugging-port=9222", 19 | "-incognito" 20 | ] 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/extensions/helloAppCustomizer/HelloAppCustomizerApplicationCustomizer.module.scss: -------------------------------------------------------------------------------- 1 | @import '~@microsoft/sp-office-ui-fabric-core/dist/sass/SPFabricCore.scss'; 2 | 3 | .app { 4 | .top { 5 | height:60px; 6 | text-align:center; 7 | line-height:2.5; 8 | font-weight:bold; 9 | display: flex; 10 | align-items: center; 11 | justify-content: center; 12 | background-color: $ms-color-themePrimary; 13 | color: $ms-color-white; 14 | } 15 | 16 | .bottom { 17 | height:40px; 18 | text-align:center; 19 | line-height:2.5; 20 | font-weight:bold; 21 | display: flex; 22 | align-items: center; 23 | justify-content: center; 24 | background-color: $ms-color-themePrimary; 25 | color: $ms-color-white; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.yo-rc.json: -------------------------------------------------------------------------------- 1 | { 2 | "@microsoft/generator-sharepoint": { 3 | "plusBeta": false, 4 | "isCreatingSolution": true, 5 | "nodeVersion": "18.20.4", 6 | "sdksVersions": { 7 | "@microsoft/microsoft-graph-client": "3.0.2", 8 | "@microsoft/teams-js": "2.24.0" 9 | }, 10 | "version": "1.20.0", 11 | "libraryName": "sp-fx-command-set", 12 | "libraryId": "ed92dbcf-b688-4b57-bd40-2b125f7de708", 13 | "environment": "spo", 14 | "packageManager": "npm", 15 | "solutionName": "SPFxCommandSet", 16 | "solutionShortDescription": "SPFxCommandSet description", 17 | "skipFeatureDeployment": true, 18 | "isDomainIsolated": false, 19 | "componentType": "extension", 20 | "extensionType": "ListViewCommandSet" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.yo-rc.json: -------------------------------------------------------------------------------- 1 | { 2 | "@microsoft/generator-sharepoint": { 3 | "plusBeta": false, 4 | "isCreatingSolution": true, 5 | "nodeVersion": "18.20.4", 6 | "sdksVersions": { 7 | "@microsoft/microsoft-graph-client": "3.0.2", 8 | "@microsoft/teams-js": "2.24.0" 9 | }, 10 | "version": "1.20.0", 11 | "libraryName": "sp-fx-app-customizer", 12 | "libraryId": "6f6559b3-4e6b-4d3e-b883-9ad65d1efa73", 13 | "environment": "spo", 14 | "packageManager": "npm", 15 | "solutionName": "SPFxAppCustomizer", 16 | "solutionShortDescription": "SPFxAppCustomizer description", 17 | "skipFeatureDeployment": true, 18 | "isDomainIsolated": false, 19 | "componentType": "extension", 20 | "extensionType": "ApplicationCustomizer" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.yo-rc.json: -------------------------------------------------------------------------------- 1 | { 2 | "@microsoft/generator-sharepoint": { 3 | "plusBeta": false, 4 | "isCreatingSolution": true, 5 | "nodeVersion": "18.20.4", 6 | "sdksVersions": { 7 | "@microsoft/microsoft-graph-client": "3.0.2", 8 | "@microsoft/teams-js": "2.24.0" 9 | }, 10 | "version": "1.20.0", 11 | "libraryName": "sp-fx-field-customizer", 12 | "libraryId": "82bef6a4-bb7a-4bb2-b924-638cbdb3c3ca", 13 | "environment": "spo", 14 | "packageManager": "npm", 15 | "solutionName": "SPFxFieldCustomizer", 16 | "solutionShortDescription": "SPFxFieldCustomizer description", 17 | "skipFeatureDeployment": true, 18 | "isDomainIsolated": false, 19 | "componentType": "extension", 20 | "extensionType": "FieldCustomizer" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/extensions/helloFieldCustomizer/HelloFieldCustomizerFieldCustomizer.manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-extension-manifest.schema.json", 3 | 4 | "id": "da7a95bf-646c-4812-b014-fee30e6ece2e", 5 | "alias": "HelloFieldCustomizerFieldCustomizer", 6 | "componentType": "Extension", 7 | "extensionType": "FieldCustomizer", 8 | 9 | // The "*" signifies that the version should be taken from the package.json 10 | "version": "*", 11 | "manifestVersion": 2, 12 | 13 | // If true, the component can only be installed on sites where Custom Script is allowed. 14 | // Components that allow authors to embed arbitrary script code should set this to true. 15 | // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f 16 | "requiresCustomScript": false 17 | } 18 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/extensions/helloAppCustomizer/HelloAppCustomizerApplicationCustomizer.manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-extension-manifest.schema.json", 3 | 4 | "id": "342e615e-2efd-41f6-aa02-4993f5a84db2", 5 | "alias": "HelloAppCustomizerApplicationCustomizer", 6 | "componentType": "Extension", 7 | "extensionType": "ApplicationCustomizer", 8 | 9 | // The "*" signifies that the version should be taken from the package.json 10 | "version": "*", 11 | "manifestVersion": 2, 12 | 13 | // If true, the component can only be installed on sites where Custom Script is allowed. 14 | // Components that allow authors to embed arbitrary script code should set this to true. 15 | // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f 16 | "requiresCustomScript": false 17 | } 18 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./node_modules/@microsoft/rush-stack-compiler-4.7/includes/tsconfig-web.json", 3 | "compilerOptions": { 4 | "target": "es5", 5 | "forceConsistentCasingInFileNames": true, 6 | "module": "esnext", 7 | "moduleResolution": "node", 8 | "jsx": "react", 9 | "declaration": true, 10 | "sourceMap": true, 11 | "experimentalDecorators": true, 12 | "skipLibCheck": true, 13 | "outDir": "lib", 14 | "inlineSources": false, 15 | "noImplicitAny": true, 16 | 17 | "typeRoots": [ 18 | "./node_modules/@types", 19 | "./node_modules/@microsoft" 20 | ], 21 | "types": [ 22 | "webpack-env" 23 | ], 24 | "lib": [ 25 | "es5", 26 | "dom", 27 | "es2015.collection", 28 | "es2015.promise" 29 | ] 30 | }, 31 | "include": [ 32 | "src/**/*.ts", 33 | "src/**/*.tsx" 34 | ] 35 | } 36 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/serve.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json", 3 | "port": 4321, 4 | "https": true, 5 | "serveConfigurations": { 6 | "default": { 7 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 8 | "fieldCustomizers": { 9 | "InternalFieldName": { 10 | "id": "da7a95bf-646c-4812-b014-fee30e6ece2e", 11 | "properties": { 12 | "sampleText": "Value" 13 | } 14 | } 15 | } 16 | }, 17 | "helloFieldCustomizer": { 18 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 19 | "fieldCustomizers": { 20 | "InternalFieldName": { 21 | "id": "da7a95bf-646c-4812-b014-fee30e6ece2e", 22 | "properties": { 23 | "sampleText": "Value" 24 | } 25 | } 26 | } 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./node_modules/@microsoft/rush-stack-compiler-4.7/includes/tsconfig-web.json", 3 | "compilerOptions": { 4 | "target": "es5", 5 | "forceConsistentCasingInFileNames": true, 6 | "module": "esnext", 7 | "moduleResolution": "node", 8 | "jsx": "react", 9 | "declaration": true, 10 | "sourceMap": true, 11 | "experimentalDecorators": true, 12 | "skipLibCheck": true, 13 | "outDir": "lib", 14 | "inlineSources": false, 15 | "noImplicitAny": true, 16 | 17 | "typeRoots": [ 18 | "./node_modules/@types", 19 | "./node_modules/@microsoft" 20 | ], 21 | "types": [ 22 | "webpack-env" 23 | ], 24 | "lib": [ 25 | "es5", 26 | "dom", 27 | "es2015.collection", 28 | "es2015.promise" 29 | ] 30 | }, 31 | "include": [ 32 | "src/**/*.ts", 33 | "src/**/*.tsx" 34 | ] 35 | } 36 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./node_modules/@microsoft/rush-stack-compiler-4.7/includes/tsconfig-web.json", 3 | "compilerOptions": { 4 | "target": "es5", 5 | "forceConsistentCasingInFileNames": true, 6 | "module": "esnext", 7 | "moduleResolution": "node", 8 | "jsx": "react", 9 | "declaration": true, 10 | "sourceMap": true, 11 | "experimentalDecorators": true, 12 | "skipLibCheck": true, 13 | "outDir": "lib", 14 | "inlineSources": false, 15 | "noImplicitAny": true, 16 | 17 | "typeRoots": [ 18 | "./node_modules/@types", 19 | "./node_modules/@microsoft" 20 | ], 21 | "types": [ 22 | "webpack-env" 23 | ], 24 | "lib": [ 25 | "es5", 26 | "dom", 27 | "es2015.collection", 28 | "es2015.promise" 29 | ] 30 | }, 31 | "include": [ 32 | "src/**/*.ts", 33 | "src/**/*.tsx" 34 | ] 35 | } 36 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/serve.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json", 3 | "port": 4321, 4 | "https": true, 5 | "serveConfigurations": { 6 | "default": { 7 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 8 | "customActions": { 9 | "342e615e-2efd-41f6-aa02-4993f5a84db2": { 10 | "location": "ClientSideExtension.ApplicationCustomizer", 11 | "properties": { 12 | "testMessage": "Test message" 13 | } 14 | } 15 | } 16 | }, 17 | "helloAppCustomizer": { 18 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 19 | "customActions": { 20 | "342e615e-2efd-41f6-aa02-4993f5a84db2": { 21 | "location": "ClientSideExtension.ApplicationCustomizer", 22 | "properties": { 23 | "testMessage": "Test message" 24 | } 25 | } 26 | } 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sp-fx-field-customizer", 3 | "version": "0.0.1", 4 | "private": true, 5 | "engines": { 6 | "node": ">=18.17.1 <19.0.0" 7 | }, 8 | "main": "lib/index.js", 9 | "scripts": { 10 | "build": "gulp bundle", 11 | "clean": "gulp clean", 12 | "test": "gulp test" 13 | }, 14 | "dependencies": { 15 | "tslib": "2.3.1", 16 | "@microsoft/sp-core-library": "1.20.0", 17 | "@microsoft/decorators": "1.20.0", 18 | "@microsoft/sp-listview-extensibility": "1.20.0" 19 | }, 20 | "devDependencies": { 21 | "@microsoft/rush-stack-compiler-4.7": "0.1.0", 22 | "@rushstack/eslint-config": "4.0.1", 23 | "@microsoft/eslint-plugin-spfx": "1.20.2", 24 | "@microsoft/eslint-config-spfx": "1.20.2", 25 | "@microsoft/sp-build-web": "1.20.2", 26 | "@types/webpack-env": "~1.15.2", 27 | "ajv": "^6.12.5", 28 | "eslint": "8.57.0", 29 | "gulp": "4.0.2", 30 | "typescript": "4.7.4", 31 | "@microsoft/sp-module-interfaces": "1.20.2" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sp-fx-app-customizer", 3 | "version": "0.0.1", 4 | "private": true, 5 | "engines": { 6 | "node": ">=18.17.1 <19.0.0" 7 | }, 8 | "main": "lib/index.js", 9 | "scripts": { 10 | "build": "gulp bundle", 11 | "clean": "gulp clean", 12 | "test": "gulp test" 13 | }, 14 | "dependencies": { 15 | "tslib": "2.3.1", 16 | "@microsoft/sp-core-library": "1.20.0", 17 | "@microsoft/decorators": "1.20.0", 18 | "@microsoft/sp-dialog": "1.20.0", 19 | "@microsoft/sp-application-base": "1.20.0" 20 | }, 21 | "devDependencies": { 22 | "@microsoft/rush-stack-compiler-4.7": "0.1.0", 23 | "@rushstack/eslint-config": "4.0.1", 24 | "@microsoft/eslint-plugin-spfx": "1.20.2", 25 | "@microsoft/eslint-config-spfx": "1.20.2", 26 | "@microsoft/sp-build-web": "1.20.2", 27 | "@types/webpack-env": "~1.15.2", 28 | "ajv": "^6.12.5", 29 | "eslint": "8.57.0", 30 | "gulp": "4.0.2", 31 | "typescript": "4.7.4", 32 | "@microsoft/sp-module-interfaces": "1.20.2" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sp-fx-command-set", 3 | "version": "0.0.1", 4 | "private": true, 5 | "engines": { 6 | "node": ">=18.17.1 <19.0.0" 7 | }, 8 | "main": "lib/index.js", 9 | "scripts": { 10 | "build": "gulp bundle", 11 | "clean": "gulp clean", 12 | "test": "gulp test" 13 | }, 14 | "dependencies": { 15 | "tslib": "2.3.1", 16 | "@microsoft/sp-core-library": "1.20.0", 17 | "@microsoft/decorators": "1.20.0", 18 | "@microsoft/sp-listview-extensibility": "1.20.0", 19 | "@microsoft/sp-dialog": "1.20.0" 20 | }, 21 | "devDependencies": { 22 | "@microsoft/rush-stack-compiler-4.7": "0.1.0", 23 | "@rushstack/eslint-config": "4.0.1", 24 | "@microsoft/eslint-plugin-spfx": "1.20.2", 25 | "@microsoft/eslint-config-spfx": "1.20.2", 26 | "@microsoft/sp-build-web": "1.20.2", 27 | "@types/webpack-env": "~1.15.2", 28 | "ajv": "^6.12.5", 29 | "eslint": "8.57.0", 30 | "gulp": "4.0.2", 31 | "typescript": "4.7.4", 32 | "@microsoft/sp-module-interfaces": "1.20.2" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/serve.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json", 3 | "port": 4321, 4 | "https": true, 5 | "serveConfigurations": { 6 | "default": { 7 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 8 | "customActions": { 9 | "2f61e499-40b4-4b13-9a0c-eaf3e3241382": { 10 | "location": "ClientSideExtension.ListViewCommandSet.CommandBar", 11 | "properties": { 12 | "sampleTextOne": "One item is selected in the list", 13 | "sampleTextTwo": "This command is always visible." 14 | } 15 | } 16 | } 17 | }, 18 | "commandSetDemo": { 19 | "pageUrl": "https://{tenantDomain}/SitePages/myPage.aspx", 20 | "customActions": { 21 | "2f61e499-40b4-4b13-9a0c-eaf3e3241382": { 22 | "location": "ClientSideExtension.ListViewCommandSet.CommandBar", 23 | "properties": { 24 | "sampleTextOne": "One item is selected in the list", 25 | "sampleTextTwo": "This command is always visible." 26 | } 27 | } 28 | } 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Microsoft Corporation. All rights reserved. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE 22 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/src/extensions/commandSetDemo/CommandSetDemoCommandSet.manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx/command-set-extension-manifest.schema.json", 3 | 4 | "id": "2f61e499-40b4-4b13-9a0c-eaf3e3241382", 5 | "alias": "CommandSetDemoCommandSet", 6 | "componentType": "Extension", 7 | "extensionType": "ListViewCommandSet", 8 | 9 | // The "*" signifies that the version should be taken from the package.json 10 | "version": "*", 11 | "manifestVersion": 2, 12 | 13 | // If true, the component can only be installed on sites where Custom Script is allowed. 14 | // Components that allow authors to embed arbitrary script code should set this to true. 15 | // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f 16 | "requiresCustomScript": false, 17 | 18 | "items": { 19 | "ONE_ITEM_SELECTED": { 20 | "title": { "default": "One Item Selected" }, 21 | "iconImageUrl": "icons/request.png", 22 | "type": "command" 23 | }, 24 | "TWO_ITEM_SELECTED": { 25 | "title": { "default": "Two Items Selected" }, 26 | "iconImageUrl": "icons/cancel.png", 27 | "type": "command" 28 | }, 29 | "ALWAYS_ON": { 30 | "title": { "default": "Always On" }, 31 | "iconImageUrl": "icons/cancel.png", 32 | "type": "command" 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/config/package-solution.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json", 3 | "solution": { 4 | "name": "sp-fx-field-customizer-client-side-solution", 5 | "id": "82bef6a4-bb7a-4bb2-b924-638cbdb3c3ca", 6 | "version": "1.0.0.0", 7 | "includeClientSideAssets": true, 8 | "skipFeatureDeployment": true, 9 | "isDomainIsolated": false, 10 | "developer": { 11 | "name": "", 12 | "websiteUrl": "", 13 | "privacyUrl": "", 14 | "termsOfUseUrl": "", 15 | "mpnId": "Undefined-1.20.0" 16 | }, 17 | "metadata": { 18 | "shortDescription": { 19 | "default": "SPFxFieldCustomizer description" 20 | }, 21 | "longDescription": { 22 | "default": "SPFxFieldCustomizer description" 23 | }, 24 | "screenshotPaths": [], 25 | "videoUrl": "", 26 | "categories": [] 27 | }, 28 | "features": [ 29 | { 30 | "title": "Application Extension - Deployment of custom action", 31 | "description": "Deploys a custom action with ClientSideComponentId association", 32 | "id": "02a98d68-4362-473b-add9-4e04129047e9", 33 | "version": "1.0.0.0", 34 | "assets": { 35 | "elementManifests": [ 36 | "elements.xml" 37 | ] 38 | } 39 | } 40 | ] 41 | }, 42 | "paths": { 43 | "zippedPackage": "solution/sp-fx-field-customizer.sppkg" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/config/package-solution.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json", 3 | "solution": { 4 | "name": "sp-fx-command-set-client-side-solution", 5 | "id": "ed92dbcf-b688-4b57-bd40-2b125f7de708", 6 | "version": "1.0.0.0", 7 | "includeClientSideAssets": true, 8 | "skipFeatureDeployment": true, 9 | "isDomainIsolated": false, 10 | "developer": { 11 | "name": "", 12 | "websiteUrl": "", 13 | "privacyUrl": "", 14 | "termsOfUseUrl": "", 15 | "mpnId": "Undefined-1.20.0" 16 | }, 17 | "metadata": { 18 | "shortDescription": { 19 | "default": "SPFxCommandSet description" 20 | }, 21 | "longDescription": { 22 | "default": "SPFxCommandSet description" 23 | }, 24 | "screenshotPaths": [], 25 | "videoUrl": "", 26 | "categories": [] 27 | }, 28 | "features": [ 29 | { 30 | "title": "Application Extension - Deployment of custom action", 31 | "description": "Deploys a custom action with ClientSideComponentId association", 32 | "id": "169157e3-e7f4-46e4-87e7-e49010b7094e", 33 | "version": "1.0.0.0", 34 | "assets": { 35 | "elementManifests": [ 36 | "elements.xml", 37 | "ClientSideInstance.xml" 38 | ] 39 | } 40 | } 41 | ] 42 | }, 43 | "paths": { 44 | "zippedPackage": "solution/sp-fx-command-set.sppkg" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/config/package-solution.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json", 3 | "solution": { 4 | "name": "sp-fx-app-customizer-client-side-solution", 5 | "id": "6f6559b3-4e6b-4d3e-b883-9ad65d1efa73", 6 | "version": "1.0.0.0", 7 | "includeClientSideAssets": true, 8 | "skipFeatureDeployment": true, 9 | "isDomainIsolated": false, 10 | "developer": { 11 | "name": "", 12 | "websiteUrl": "", 13 | "privacyUrl": "", 14 | "termsOfUseUrl": "", 15 | "mpnId": "Undefined-1.20.0" 16 | }, 17 | "metadata": { 18 | "shortDescription": { 19 | "default": "SPFxAppCustomizer description" 20 | }, 21 | "longDescription": { 22 | "default": "SPFxAppCustomizer description" 23 | }, 24 | "screenshotPaths": [], 25 | "videoUrl": "", 26 | "categories": [] 27 | }, 28 | "features": [ 29 | { 30 | "title": "Application Extension - Deployment of custom action", 31 | "description": "Deploys a custom action with ClientSideComponentId association", 32 | "id": "6c6496fa-b559-473a-aa02-01ce119ffe1b", 33 | "version": "1.0.0.0", 34 | "assets": { 35 | "elementManifests": [ 36 | "elements.xml", 37 | "ClientSideInstance.xml" 38 | ] 39 | } 40 | } 41 | ] 42 | }, 43 | "paths": { 44 | "zippedPackage": "solution/sp-fx-app-customizer.sppkg" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Security 4 | 5 | Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). 6 | 7 | If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. 8 | 9 | ## Reporting Security Issues 10 | 11 | **Please do not report security vulnerabilities through public GitHub issues.** 12 | 13 | Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). 14 | 15 | If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). 16 | 17 | You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 18 | 19 | Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: 20 | 21 | * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) 22 | * Full paths of source file(s) related to the manifestation of the issue 23 | * The location of the affected source code (tag/branch/commit or direct URL) 24 | * Any special configuration required to reproduce the issue 25 | * Step-by-step instructions to reproduce the issue 26 | * Proof-of-concept or exploit code (if possible) 27 | * Impact of the issue, including how an attacker might exploit the issue 28 | 29 | This information will help us triage your report more quickly. 30 | 31 | If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. 32 | 33 | ## Preferred Languages 34 | 35 | We prefer all communications to be in English. 36 | 37 | ## Policy 38 | 39 | Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). 40 | 41 | 42 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/README.md: -------------------------------------------------------------------------------- 1 | # sp-fx-app-customizer 2 | 3 | ## Summary 4 | 5 | Short summary on functionality and used technologies. 6 | 7 | [picture of the solution in action, if possible] 8 | 9 | ## Used SharePoint Framework Version 10 | 11 | ![version](https://img.shields.io/badge/version-1.20.0-green.svg) 12 | 13 | ## Applies to 14 | 15 | - [SharePoint Framework](https://aka.ms/spfx) 16 | - [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 17 | 18 | > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) 19 | 20 | ## Prerequisites 21 | 22 | > Any special pre-requisites? 23 | 24 | ## Solution 25 | 26 | | Solution | Author(s) | 27 | | ----------- | ------------------------------------------------------- | 28 | | folder name | Author details (name, company, twitter alias with link) | 29 | 30 | ## Version history 31 | 32 | | Version | Date | Comments | 33 | | ------- | ---------------- | --------------- | 34 | | 1.1 | March 10, 2021 | Update comment | 35 | | 1.0 | January 29, 2021 | Initial release | 36 | 37 | ## Disclaimer 38 | 39 | **THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** 40 | 41 | --- 42 | 43 | ## Minimal Path to Awesome 44 | 45 | - Clone this repository 46 | - Ensure that you are at the solution folder 47 | - in the command-line run: 48 | - **npm install** 49 | - **gulp serve** 50 | 51 | > Include any additional steps as needed. 52 | 53 | ## Features 54 | 55 | Description of the extension that expands upon high-level summary above. 56 | 57 | This extension illustrates the following concepts: 58 | 59 | - topic 1 60 | - topic 2 61 | - topic 3 62 | 63 | > Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. 64 | 65 | > Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp. 66 | 67 | ## References 68 | 69 | - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 70 | - [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) 71 | - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) 72 | - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) 73 | - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development 74 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/README.md: -------------------------------------------------------------------------------- 1 | # sp-fx-field-customizer 2 | 3 | ## Summary 4 | 5 | Short summary on functionality and used technologies. 6 | 7 | [picture of the solution in action, if possible] 8 | 9 | ## Used SharePoint Framework Version 10 | 11 | ![version](https://img.shields.io/badge/version-1.20.0-green.svg) 12 | 13 | ## Applies to 14 | 15 | - [SharePoint Framework](https://aka.ms/spfx) 16 | - [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 17 | 18 | > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) 19 | 20 | ## Prerequisites 21 | 22 | > Any special pre-requisites? 23 | 24 | ## Solution 25 | 26 | | Solution | Author(s) | 27 | | ----------- | ------------------------------------------------------- | 28 | | folder name | Author details (name, company, twitter alias with link) | 29 | 30 | ## Version history 31 | 32 | | Version | Date | Comments | 33 | | ------- | ---------------- | --------------- | 34 | | 1.1 | March 10, 2021 | Update comment | 35 | | 1.0 | January 29, 2021 | Initial release | 36 | 37 | ## Disclaimer 38 | 39 | **THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** 40 | 41 | --- 42 | 43 | ## Minimal Path to Awesome 44 | 45 | - Clone this repository 46 | - Ensure that you are at the solution folder 47 | - in the command-line run: 48 | - **npm install** 49 | - **gulp serve** 50 | 51 | > Include any additional steps as needed. 52 | 53 | ## Features 54 | 55 | Description of the extension that expands upon high-level summary above. 56 | 57 | This extension illustrates the following concepts: 58 | 59 | - topic 1 60 | - topic 2 61 | - topic 3 62 | 63 | > Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. 64 | 65 | > Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp. 66 | 67 | ## References 68 | 69 | - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 70 | - [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) 71 | - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) 72 | - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) 73 | - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development 74 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/README.md: -------------------------------------------------------------------------------- 1 | # sp-fx-command-set 2 | 3 | ## Summary 4 | 5 | Short summary on functionality and used technologies. 6 | 7 | [picture of the solution in action, if possible] 8 | 9 | ## Used SharePoint Framework Version 10 | 11 | ![version](https://img.shields.io/badge/version-1.20.0-green.svg) 12 | 13 | ## Applies to 14 | 15 | - [SharePoint Framework](https://aka.ms/spfx) 16 | - [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 17 | 18 | > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) 19 | 20 | ## Prerequisites 21 | 22 | > Any special pre-requisites? 23 | 24 | ## Solution 25 | 26 | | Solution | Author(s) | 27 | | ----------- | ------------------------------------------------------- | 28 | | folder name | Author details (name, company, twitter alias with link) | 29 | 30 | ## Version history 31 | 32 | | Version | Date | Comments | 33 | | ------- | ---------------- | --------------- | 34 | | 1.1 | March 10, 2021 | Update comment | 35 | | 1.0 | January 29, 2021 | Initial release | 36 | 37 | ## Disclaimer 38 | 39 | **THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** 40 | 41 | --- 42 | 43 | ## Minimal Path to Awesome 44 | 45 | - Clone this repository 46 | - Ensure that you are at the solution folder 47 | - in the command-line run: 48 | - **npm install** 49 | - **gulp serve** 50 | 51 | > Include any additional steps as needed. 52 | 53 | ## Features 54 | 55 | Description of the extension that expands upon high-level summary above. 56 | 57 | This extension illustrates the following concepts: 58 | 59 | - topic 1 60 | - topic 2 61 | - topic 3 62 | 63 | > Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. 64 | 65 | > Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp. 66 | 67 | ## References 68 | 69 | - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) 70 | - [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview) 71 | - [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis) 72 | - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) 73 | - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development 74 | -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/src/extensions/commandSetDemo/CommandSetDemoCommandSet.ts: -------------------------------------------------------------------------------- 1 | import { Log } from '@microsoft/sp-core-library'; 2 | import { 3 | BaseListViewCommandSet, 4 | type Command, 5 | type IListViewCommandSetExecuteEventParameters, 6 | type ListViewStateChangedEventArgs 7 | } from '@microsoft/sp-listview-extensibility'; 8 | import { Dialog } from '@microsoft/sp-dialog'; 9 | 10 | /** 11 | * If your command set uses the ClientSideComponentProperties JSON input, 12 | * it will be deserialized into the BaseExtension.properties object. 13 | * You can define an interface to describe it. 14 | */ 15 | export interface ICommandSetDemoCommandSetProperties { 16 | messagePrefix: string; 17 | } 18 | 19 | const LOG_SOURCE: string = 'CommandSetDemoCommandSet'; 20 | 21 | export default class CommandSetDemoCommandSet extends BaseListViewCommandSet { 22 | 23 | public onInit(): Promise { 24 | Log.info(LOG_SOURCE, 'Initialized CommandSetDemoCommandSet'); 25 | 26 | const one_item_selected: Command = this.tryGetCommand('ONE_ITEM_SELECTED'); 27 | one_item_selected.visible = false; 28 | 29 | const two_item_selected: Command = this.tryGetCommand('TWO_ITEM_SELECTED'); 30 | two_item_selected.visible = false; 31 | 32 | this.context.listView.listViewStateChangedEvent.add(this, this._onListViewStateChanged); 33 | 34 | return Promise.resolve(); 35 | } 36 | 37 | public onExecute(event: IListViewCommandSetExecuteEventParameters): void { 38 | /* eslint-disable @typescript-eslint/no-floating-promises */ 39 | switch (event.itemId) { 40 | case 'ONE_ITEM_SELECTED': 41 | Dialog.alert(`${this.properties.messagePrefix} ONE_ITEM_SELECTED command checked; Title = ${event.selectedRows[0].getValueByName('Title')}`); 42 | break; 43 | case 'TWO_ITEM_SELECTED': 44 | Dialog.alert(`${this.properties.messagePrefix} TWO_ITEM_SELECTED command checked; Title = ${event.selectedRows[event.selectedRows.length - 1].getValueByName('Title')}`); 45 | break; 46 | case 'ALWAYS_ON': 47 | Dialog.alert(`${this.properties.messagePrefix} ALWAYS_ON command checked. Total selected: ${event.selectedRows.length}`); 48 | break; 49 | default: 50 | throw new Error('Unknown command'); 51 | } 52 | /* eslint-enable @typescript-eslint/no-floating-promises */ 53 | } 54 | 55 | private _onListViewStateChanged = (args: ListViewStateChangedEventArgs): void => { 56 | Log.info(LOG_SOURCE, 'List view state changed'); 57 | 58 | const one_item_selected: Command = this.tryGetCommand('ONE_ITEM_SELECTED'); 59 | if (one_item_selected) { 60 | one_item_selected.visible = this.context.listView.selectedRows?.length === 1; 61 | } 62 | const two_item_selected: Command = this.tryGetCommand('TWO_ITEM_SELECTED'); 63 | if (two_item_selected) { 64 | two_item_selected.visible = this.context.listView.selectedRows?.length === 2; 65 | } 66 | 67 | // You should call this.raiseOnChange() to update the command bar 68 | this.raiseOnChange(); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/src/extensions/helloFieldCustomizer/HelloFieldCustomizerFieldCustomizer.ts: -------------------------------------------------------------------------------- 1 | import { Log } from '@microsoft/sp-core-library'; 2 | import { 3 | BaseFieldCustomizer, 4 | type IFieldCustomizerCellEventParameters 5 | } from '@microsoft/sp-listview-extensibility'; 6 | 7 | import * as strings from 'HelloFieldCustomizerFieldCustomizerStrings'; 8 | import styles from './HelloFieldCustomizerFieldCustomizer.module.scss'; 9 | 10 | /** 11 | * If your field customizer uses the ClientSideComponentProperties JSON input, 12 | * it will be deserialized into the BaseExtension.properties object. 13 | * You can define an interface to describe it. 14 | */ 15 | export interface IHelloFieldCustomizerFieldCustomizerProperties { 16 | // This is an example; replace with your own property 17 | greenMinLimit?: string; 18 | yellowMinLimit?: string; 19 | } 20 | 21 | const LOG_SOURCE: string = 'HelloFieldCustomizerFieldCustomizer'; 22 | 23 | export default class HelloFieldCustomizerFieldCustomizer 24 | extends BaseFieldCustomizer { 25 | 26 | public onInit(): Promise { 27 | // Add your custom initialization to this method. The framework will wait 28 | // for the returned promise to resolve before firing any BaseFieldCustomizer events. 29 | Log.info(LOG_SOURCE, 'Activated HelloFieldCustomizerFieldCustomizer with properties:'); 30 | Log.info(LOG_SOURCE, JSON.stringify(this.properties, undefined, 2)); 31 | Log.info(LOG_SOURCE, `The following string should be equal: "HelloFieldCustomizerFieldCustomizer" and "${strings.Title}"`); 32 | return Promise.resolve(); 33 | } 34 | 35 | public onRenderCell(event: IFieldCustomizerCellEventParameters): void { 36 | event.domElement.classList.add(styles.cell); 37 | 38 | // determine color and text to use 39 | const fieldValue = parseInt(event.fieldValue); 40 | let filledColor: string = ''; 41 | 42 | if (isNaN(fieldValue) || fieldValue === 0) { 43 | event.domElement.innerHTML = ` 44 |
45 |
46 |
47 |   no progress 48 |
49 |
50 |
51 | `; 52 | } else { 53 | if (fieldValue >= parseInt(this.properties.greenMinLimit as string)) { 54 | filledColor = '#00ff00'; 55 | } else if (fieldValue >= parseInt(this.properties.yellowMinLimit as string)) { 56 | filledColor = '#ffff00'; 57 | } else { 58 | filledColor = '#ff0000'; 59 | } 60 | 61 | event.domElement.innerHTML = ` 62 |
63 |
64 |
65 |   ${fieldValue}% completed 66 |
67 |
68 |
`; 69 | } 70 | } 71 | 72 | public onDisposeCell(event: IFieldCustomizerCellEventParameters): void { 73 | // This method should be used to free any resources that were allocated during rendering. 74 | // For example, if your onRenderCell() called ReactDOM.render(), then you should 75 | // call ReactDOM.unmountComponentAtNode() here. 76 | super.onDisposeCell(event); 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/src/extensions/helloAppCustomizer/HelloAppCustomizerApplicationCustomizer.ts: -------------------------------------------------------------------------------- 1 | import { Log } from '@microsoft/sp-core-library'; 2 | import { 3 | BaseApplicationCustomizer, 4 | PlaceholderContent, 5 | PlaceholderName 6 | } from '@microsoft/sp-application-base'; 7 | import { Dialog } from '@microsoft/sp-dialog'; 8 | 9 | import * as strings from 'HelloAppCustomizerApplicationCustomizerStrings'; 10 | 11 | import styles from './HelloAppCustomizerApplicationCustomizer.module.scss'; 12 | import { escape } from '@microsoft/sp-lodash-subset'; 13 | 14 | const LOG_SOURCE: string = 'HelloAppCustomizerApplicationCustomizer'; 15 | 16 | /** 17 | * If your command set uses the ClientSideComponentProperties JSON input, 18 | * it will be deserialized into the BaseExtension.properties object. 19 | * You can define an interface to describe it. 20 | */ 21 | export interface IHelloAppCustomizerApplicationCustomizerProperties { 22 | // This is an example; replace with your own property 23 | testMessage: string; 24 | header: string; 25 | footer: string; 26 | } 27 | 28 | /** A Custom Action which can be run during execution of a Client Side Application */ 29 | export default class HelloAppCustomizerApplicationCustomizer 30 | extends BaseApplicationCustomizer { 31 | 32 | private _topPlaceholder: PlaceholderContent | undefined; 33 | private _bottomPlaceholder: PlaceholderContent | undefined; 34 | 35 | public onInit(): Promise { 36 | Log.info(LOG_SOURCE, `Initialized ${strings.Title}`); 37 | 38 | this.context.placeholderProvider.changedEvent.add(this, this._renderPlaceHolders); 39 | 40 | return Promise.resolve(); 41 | } 42 | 43 | private _renderPlaceHolders(): void { 44 | console.log('Available application customizer placeholders: ', 45 | this.context.placeholderProvider.placeholderNames 46 | .map((name) => PlaceholderName[name]) 47 | .join(', ') 48 | ); 49 | 50 | if (!this._topPlaceholder) { 51 | this._topPlaceholder = this.context.placeholderProvider.tryCreateContent( 52 | PlaceholderName.Top, 53 | { onDispose: this._onDispose } 54 | ); 55 | 56 | if (!this._topPlaceholder) { 57 | console.error('The expected placeholder (Top) was not found.'); 58 | return; 59 | } 60 | 61 | if (this.properties) { 62 | let headerMessage: string = this.properties.header; 63 | if (!headerMessage) { 64 | headerMessage = '(header property was not defined.)'; 65 | } 66 | 67 | if (this._topPlaceholder.domElement) { 68 | this._topPlaceholder.domElement.innerHTML = ` 69 |
70 |
71 | ${escape(headerMessage)} 72 |
73 |
`; 74 | } 75 | } 76 | } 77 | 78 | if (!this._bottomPlaceholder) { 79 | this._bottomPlaceholder = this.context.placeholderProvider.tryCreateContent( 80 | PlaceholderName.Bottom, 81 | { onDispose: this._onDispose } 82 | ); 83 | 84 | if (!this._bottomPlaceholder) { 85 | console.error('The expected placeholder (Bottom) was not found.'); 86 | return; 87 | } 88 | 89 | if (this.properties) { 90 | let footerMessage: string = this.properties.footer; 91 | if (!footerMessage) { 92 | footerMessage = '(footer property was not defined.)'; 93 | } 94 | 95 | if (this._bottomPlaceholder.domElement) { 96 | this._bottomPlaceholder.domElement.innerHTML = ` 97 |
98 |
99 | ${escape(footerMessage)} 100 |
101 |
`; 102 | } 103 | } 104 | } 105 | 106 | } 107 | 108 | private _onDispose(): void { 109 | console.log('[HelloWorldApplicationCustomizer._onDispose] Disposed custom top and bottom placeholders.'); 110 | } 111 | 112 | } 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Microsoft SharePoint Framework Training Module - Extend the SharePoint user interface with SharePoint Framework extensions 2 | 3 | This module will introduce you to extending the SharePoint user interface with extensions. 4 | 5 | > This module is also published as a Microsoft Learn module: [Enable SharePoint Framework Web Part Configuration with Property Panes](https://learn.microsoft.com/training/modules/sharepoint-spfx-extensions) 6 | 7 | ## Lab - Extend the SharePoint user interface with SharePoint Framework extensions 8 | 9 | The lab for this module is available in multiple units within the associated Microsoft Learn module. Use the following links to jump to the specific unit. Each Microsoft Learn unit represents a different lab exercise & demo in the presentation. 10 | 11 | - [Exercise - Create an application customizer extension](https://learn.microsoft.com/training/modules/sharepoint-spfx-extensions/3-exercise-application-customizer) 12 | 13 | In this exercise, you'll create a SharePoint Framework (SPFx) application customizer extension. 14 | 15 | - [Exercise - Create a field customizer extension](https://learn.microsoft.com/training/modules/sharepoint-spfx-extensions/5-exercise-field-customizer) 16 | 17 | In this exercise, you'll create a SharePoint Framework (SPFx) field customizer extension that will display a colored bar in a column with a percentage of the bar filled depending on the value in the field. 18 | 19 | - [Exercise - Customize lists with command set extensions](https://learn.microsoft.com/training/modules/sharepoint-spfx-extensions/7-exercise-command-set-customizer) 20 | 21 | In this exercise, you'll create a SharePoint Framework (SPFx) command set extension that will display custom buttons in a SharePoint list. 22 | 23 | ## Demos 24 | 25 | - [Create an application customizer extension](./Demos/01-appcustomizer) 26 | - [Create a field customizer extension](./Demos/02-fieldcustomizer) 27 | - [Customize lists with command set extensions](./Demos/03-listviewcommandset) 28 | 29 | ## Watch the Module - Video 30 | 31 | This module has been recorded and is available in the SharePoint Development YouTube channel: [SharePoint Framework Training - Developing with the SharePoint Framework: Extend the SharePoint user interface with SharePoint Framework extensions](https://www.youtube.com/watch?v=85DlxhbIK9I&list=PLR9nK3mnD-OV-RPXQ3Lco845qoEy7VJoc) 32 | 33 | ## Contributors 34 | 35 | | Roles | Author(s) | 36 | | -------------------- | -------------------------------------------------------------------------------------------------------------- | 37 | | Lab Manuals / Slides | Andrew Connell (Microsoft MVP, [Voitanos](//github.com/voitanos)) [@andrewconnell](//github.com/andrewconnell) | 38 | | QA | Rob Windsor (Microsoft MVP) [@rob-windsor](//github.com/rob-windsor) | 39 | | Sponsor / Support | Vesa Juvonen (Microsoft) [@VesaJuvonen](//github.com/VesaJuvonen) | 40 | 41 | ## Version history 42 | 43 | | Version | Date | Comments | 44 | | ------- | ----------------- | -------------------------------------------------- | 45 | | 1.20 | December 13, 2024 | FY2025Q2 content refresh; update to SPFx v1.20.0 | 46 | | 1.19 | June 13, 2024 | FY2024Q4 content refresh; update to SPFx v1.19.0 | 47 | | 1.18 | May 5, 2023 | FY2023Q4 content refresh; update to SPFx v1.17.1 | 48 | | 1.17 | February 28, 2023 | FY2023Q3 content refresh; update to SPFx v1.16.1 | 49 | | 1.16 | December 5, 2022 | FY2023Q1 content refresh | 50 | | 1.15 | September 5, 2022 | FY2023Q1 content refresh; update for SPFx v1.15.2 | 51 | | 1.14 | May 2, 2022 | FY2022Q4 content refresh; update for SPFx v1.14 | 52 | | 1.13 | March 7, 2022 | FY2022Q3 content refresh; retire local workbench | 53 | | 1.12 | December 8, 2021 | FY2022Q2 content refresh; retire local workbench | 54 | | 1.11 | June 17, 2021 | FY2021Q4 content refresh | 55 | | 1.10 | March 6, 2021 | FY2021Q3 content refresh | 56 | | 1.9 | November 30, 2020 | FY2021Q2 content refresh | 57 | | 1.8 | August 31, 2020 | FY2021Q1 content refresh | 58 | | 1.7 | March 10, 2020 | FY2020Q3 content refresh & port module to MS Learn | 59 | | 1.6 | December 6, 2019 | FY2020Q2 content refresh | 60 | | 1.5 | September 2, 2019 | FY2020Q1 content refresh | 61 | | 1.4 | June 10, 2019 | FY2019Q4 content refresh | 62 | | 1.3 | March 6, 2019 | FY2019Q3 Content refresh | 63 | | 1.2 | January 17, 2019 | Slide updates, added screencast link to readme | 64 | | 1.1 | December 12, 2018 | Rewritten to use latest guidance | 65 | | 1.0 | ~February 2017 | Initial release | 66 | 67 | ## Disclaimer 68 | 69 | **THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** 70 | 71 | ## Contributing 72 | 73 | This project welcomes contributions and suggestions. Most contributions require you to agree to a 74 | Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us 75 | the rights to use your contribution. For details, visit https://cla.microsoft.com. 76 | 77 | When you submit a pull request, a CLA-bot will automatically determine whether you need to provide 78 | a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions 79 | provided by the bot. You will only need to do this once across all repos using our CLA. 80 | 81 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 82 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or 83 | contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. 84 | 85 | 86 | -------------------------------------------------------------------------------- /Demos/01-appcustomizer/.eslintrc.js: -------------------------------------------------------------------------------- 1 | require('@rushstack/eslint-config/patch/modern-module-resolution'); 2 | module.exports = { 3 | extends: ['@microsoft/eslint-config-spfx/lib/profiles/default'], 4 | parserOptions: { tsconfigRootDir: __dirname }, 5 | overrides: [ 6 | { 7 | files: ['*.ts', '*.tsx'], 8 | parser: '@typescript-eslint/parser', 9 | 'parserOptions': { 10 | 'project': './tsconfig.json', 11 | 'ecmaVersion': 2018, 12 | 'sourceType': 'module' 13 | }, 14 | rules: { 15 | // Prevent usage of the JavaScript null value, while allowing code to access existing APIs that may require null. https://www.npmjs.com/package/@rushstack/eslint-plugin 16 | '@rushstack/no-new-null': 1, 17 | // Require Jest module mocking APIs to be called before any other statements in their code block. https://www.npmjs.com/package/@rushstack/eslint-plugin 18 | '@rushstack/hoist-jest-mock': 1, 19 | // Require regular expressions to be constructed from string constants rather than dynamically building strings at runtime. https://www.npmjs.com/package/@rushstack/eslint-plugin-security 20 | '@rushstack/security/no-unsafe-regexp': 1, 21 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 22 | '@typescript-eslint/adjacent-overload-signatures': 1, 23 | // RATIONALE: Code is more readable when the type of every variable is immediately obvious. 24 | // Even if the compiler may be able to infer a type, this inference will be unavailable 25 | // to a person who is reviewing a GitHub diff. This rule makes writing code harder, 26 | // but writing code is a much less important activity than reading it. 27 | // 28 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 29 | '@typescript-eslint/explicit-function-return-type': [ 30 | 1, 31 | { 32 | 'allowExpressions': true, 33 | 'allowTypedFunctionExpressions': true, 34 | 'allowHigherOrderFunctions': false 35 | } 36 | ], 37 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 38 | // Rationale to disable: although this is a recommended rule, it is up to dev to select coding style. 39 | // Set to 1 (warning) or 2 (error) to enable. 40 | '@typescript-eslint/explicit-member-accessibility': 0, 41 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 42 | '@typescript-eslint/no-array-constructor': 1, 43 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 44 | // 45 | // RATIONALE: The "any" keyword disables static type checking, the main benefit of using TypeScript. 46 | // This rule should be suppressed only in very special cases such as JSON.stringify() 47 | // where the type really can be anything. Even if the type is flexible, another type 48 | // may be more appropriate such as "unknown", "{}", or "Record". 49 | '@typescript-eslint/no-explicit-any': 1, 50 | // RATIONALE: The #1 rule of promises is that every promise chain must be terminated by a catch() 51 | // handler. Thus wherever a Promise arises, the code must either append a catch handler, 52 | // or else return the object to a caller (who assumes this responsibility). Unterminated 53 | // promise chains are a serious issue. Besides causing errors to be silently ignored, 54 | // they can also cause a NodeJS process to terminate unexpectedly. 55 | '@typescript-eslint/no-floating-promises': 2, 56 | // RATIONALE: Catches a common coding mistake. 57 | '@typescript-eslint/no-for-in-array': 2, 58 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 59 | '@typescript-eslint/no-misused-new': 2, 60 | // RATIONALE: The "namespace" keyword is not recommended for organizing code because JavaScript lacks 61 | // a "using" statement to traverse namespaces. Nested namespaces prevent certain bundler 62 | // optimizations. If you are declaring loose functions/variables, it's better to make them 63 | // static members of a class, since classes support property getters and their private 64 | // members are accessible by unit tests. Also, the exercise of choosing a meaningful 65 | // class name tends to produce more discoverable APIs: for example, search+replacing 66 | // the function "reverse()" is likely to return many false matches, whereas if we always 67 | // write "Text.reverse()" is more unique. For large scale organization, it's recommended 68 | // to decompose your code into separate NPM packages, which ensures that component 69 | // dependencies are tracked more conscientiously. 70 | // 71 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 72 | '@typescript-eslint/no-namespace': [ 73 | 1, 74 | { 75 | 'allowDeclarations': false, 76 | 'allowDefinitionFiles': false 77 | } 78 | ], 79 | // RATIONALE: Parameter properties provide a shorthand such as "constructor(public title: string)" 80 | // that avoids the effort of declaring "title" as a field. This TypeScript feature makes 81 | // code easier to write, but arguably sacrifices readability: In the notes for 82 | // "@typescript-eslint/member-ordering" we pointed out that fields are central to 83 | // a class's design, so we wouldn't want to bury them in a constructor signature 84 | // just to save some typing. 85 | // 86 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 87 | // Set to 1 (warning) or 2 (error) to enable the rule 88 | '@typescript-eslint/parameter-properties': 0, 89 | // RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code 90 | // may impact performance. 91 | // 92 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 93 | '@typescript-eslint/no-unused-vars': [ 94 | 1, 95 | { 96 | 'vars': 'all', 97 | // Unused function arguments often indicate a mistake in JavaScript code. However in TypeScript code, 98 | // the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures 99 | // that are overriding a base class method or implementing an interface. 100 | 'args': 'none' 101 | } 102 | ], 103 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 104 | '@typescript-eslint/no-use-before-define': [ 105 | 2, 106 | { 107 | 'functions': false, 108 | 'classes': true, 109 | 'variables': true, 110 | 'enums': true, 111 | 'typedefs': true 112 | } 113 | ], 114 | // Disallows require statements except in import statements. 115 | // In other words, the use of forms such as var foo = require("foo") are banned. Instead use ES6 style imports or import foo = require("foo") imports. 116 | '@typescript-eslint/no-var-requires': 'error', 117 | // RATIONALE: The "module" keyword is deprecated except when describing legacy libraries. 118 | // 119 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 120 | '@typescript-eslint/prefer-namespace-keyword': 1, 121 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 122 | // Rationale to disable: it's up to developer to decide if he wants to add type annotations 123 | // Set to 1 (warning) or 2 (error) to enable the rule 124 | '@typescript-eslint/no-inferrable-types': 0, 125 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 126 | // Rationale to disable: declaration of empty interfaces may be helpful for generic types scenarios 127 | '@typescript-eslint/no-empty-interface': 0, 128 | // RATIONALE: This rule warns if setters are defined without getters, which is probably a mistake. 129 | 'accessor-pairs': 1, 130 | // RATIONALE: In TypeScript, if you write x["y"] instead of x.y, it disables type checking. 131 | 'dot-notation': [ 132 | 1, 133 | { 134 | 'allowPattern': '^_' 135 | } 136 | ], 137 | // RATIONALE: Catches code that is likely to be incorrect 138 | 'eqeqeq': 1, 139 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 140 | 'for-direction': 1, 141 | // RATIONALE: Catches a common coding mistake. 142 | 'guard-for-in': 2, 143 | // RATIONALE: If you have more than 2,000 lines in a single source file, it's probably time 144 | // to split up your code. 145 | 'max-lines': ['warn', { max: 2000 }], 146 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 147 | 'no-async-promise-executor': 2, 148 | // RATIONALE: Deprecated language feature. 149 | 'no-caller': 2, 150 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 151 | 'no-compare-neg-zero': 2, 152 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 153 | 'no-cond-assign': 2, 154 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 155 | 'no-constant-condition': 1, 156 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 157 | 'no-control-regex': 2, 158 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 159 | 'no-debugger': 1, 160 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 161 | 'no-delete-var': 2, 162 | // RATIONALE: Catches code that is likely to be incorrect 163 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 164 | 'no-duplicate-case': 2, 165 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 166 | 'no-empty': 1, 167 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 168 | 'no-empty-character-class': 2, 169 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 170 | 'no-empty-pattern': 1, 171 | // RATIONALE: Eval is a security concern and a performance concern. 172 | 'no-eval': 1, 173 | // RATIONALE: Catches code that is likely to be incorrect 174 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 175 | 'no-ex-assign': 2, 176 | // RATIONALE: System types are global and should not be tampered with in a scalable code base. 177 | // If two different libraries (or two versions of the same library) both try to modify 178 | // a type, only one of them can win. Polyfills are acceptable because they implement 179 | // a standardized interoperable contract, but polyfills are generally coded in plain 180 | // JavaScript. 181 | 'no-extend-native': 1, 182 | // Disallow unnecessary labels 183 | 'no-extra-label': 1, 184 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 185 | 'no-fallthrough': 2, 186 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 187 | 'no-func-assign': 1, 188 | // RATIONALE: Catches a common coding mistake. 189 | 'no-implied-eval': 2, 190 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 191 | 'no-invalid-regexp': 2, 192 | // RATIONALE: Catches a common coding mistake. 193 | 'no-label-var': 2, 194 | // RATIONALE: Eliminates redundant code. 195 | 'no-lone-blocks': 1, 196 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 197 | 'no-misleading-character-class': 2, 198 | // RATIONALE: Catches a common coding mistake. 199 | 'no-multi-str': 2, 200 | // RATIONALE: It's generally a bad practice to call "new Thing()" without assigning the result to 201 | // a variable. Either it's part of an awkward expression like "(new Thing()).doSomething()", 202 | // or else implies that the constructor is doing nontrivial computations, which is often 203 | // a poor class design. 204 | 'no-new': 1, 205 | // RATIONALE: Obsolete language feature that is deprecated. 206 | 'no-new-func': 2, 207 | // RATIONALE: Obsolete language feature that is deprecated. 208 | 'no-new-object': 2, 209 | // RATIONALE: Obsolete notation. 210 | 'no-new-wrappers': 1, 211 | // RATIONALE: Catches code that is likely to be incorrect 212 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 213 | 'no-octal': 2, 214 | // RATIONALE: Catches code that is likely to be incorrect 215 | 'no-octal-escape': 2, 216 | // RATIONALE: Catches code that is likely to be incorrect 217 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 218 | 'no-regex-spaces': 2, 219 | // RATIONALE: Catches a common coding mistake. 220 | 'no-return-assign': 2, 221 | // RATIONALE: Security risk. 222 | 'no-script-url': 1, 223 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 224 | 'no-self-assign': 2, 225 | // RATIONALE: Catches a common coding mistake. 226 | 'no-self-compare': 2, 227 | // RATIONALE: This avoids statements such as "while (a = next(), a && a.length);" that use 228 | // commas to create compound expressions. In general code is more readable if each 229 | // step is split onto a separate line. This also makes it easier to set breakpoints 230 | // in the debugger. 231 | 'no-sequences': 1, 232 | // RATIONALE: Catches code that is likely to be incorrect 233 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 234 | 'no-shadow-restricted-names': 2, 235 | // RATIONALE: Obsolete language feature that is deprecated. 236 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 237 | 'no-sparse-arrays': 2, 238 | // RATIONALE: Although in theory JavaScript allows any possible data type to be thrown as an exception, 239 | // such flexibility adds pointless complexity, by requiring every catch block to test 240 | // the type of the object that it receives. Whereas if catch blocks can always assume 241 | // that their object implements the "Error" contract, then the code is simpler, and 242 | // we generally get useful additional information like a call stack. 243 | 'no-throw-literal': 2, 244 | // RATIONALE: Catches a common coding mistake. 245 | 'no-unmodified-loop-condition': 1, 246 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 247 | 'no-unsafe-finally': 2, 248 | // RATIONALE: Catches a common coding mistake. 249 | 'no-unused-expressions': 1, 250 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 251 | 'no-unused-labels': 1, 252 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 253 | 'no-useless-catch': 1, 254 | // RATIONALE: Avoids a potential performance problem. 255 | 'no-useless-concat': 1, 256 | // RATIONALE: The "var" keyword is deprecated because of its confusing "hoisting" behavior. 257 | // Always use "let" or "const" instead. 258 | // 259 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 260 | 'no-var': 2, 261 | // RATIONALE: Generally not needed in modern code. 262 | 'no-void': 1, 263 | // RATIONALE: Obsolete language feature that is deprecated. 264 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 265 | 'no-with': 2, 266 | // RATIONALE: Makes logic easier to understand, since constants always have a known value 267 | // @typescript-eslint\eslint-plugin\dist\configs\eslint-recommended.js 268 | 'prefer-const': 1, 269 | // RATIONALE: Catches a common coding mistake where "resolve" and "reject" are confused. 270 | 'promise/param-names': 2, 271 | // RATIONALE: Catches code that is likely to be incorrect 272 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 273 | 'require-atomic-updates': 2, 274 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 275 | 'require-yield': 1, 276 | // "Use strict" is redundant when using the TypeScript compiler. 277 | 'strict': [ 278 | 2, 279 | 'never' 280 | ], 281 | // RATIONALE: Catches code that is likely to be incorrect 282 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 283 | 'use-isnan': 2, 284 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 285 | // Set to 1 (warning) or 2 (error) to enable. 286 | // Rationale to disable: !!{} 287 | 'no-extra-boolean-cast': 0, 288 | // ==================================================================== 289 | // @microsoft/eslint-plugin-spfx 290 | // ==================================================================== 291 | '@microsoft/spfx/import-requires-chunk-name': 1, 292 | '@microsoft/spfx/no-require-ensure': 2, 293 | '@microsoft/spfx/pair-react-dom-render-unmount': 1 294 | } 295 | }, 296 | { 297 | // For unit tests, we can be a little bit less strict. The settings below revise the 298 | // defaults specified in the extended configurations, as well as above. 299 | files: [ 300 | // Test files 301 | '*.test.ts', 302 | '*.test.tsx', 303 | '*.spec.ts', 304 | '*.spec.tsx', 305 | 306 | // Facebook convention 307 | '**/__mocks__/*.ts', 308 | '**/__mocks__/*.tsx', 309 | '**/__tests__/*.ts', 310 | '**/__tests__/*.tsx', 311 | 312 | // Microsoft convention 313 | '**/test/*.ts', 314 | '**/test/*.tsx' 315 | ], 316 | rules: {} 317 | } 318 | ] 319 | }; -------------------------------------------------------------------------------- /Demos/02-fieldcustomizer/.eslintrc.js: -------------------------------------------------------------------------------- 1 | require('@rushstack/eslint-config/patch/modern-module-resolution'); 2 | module.exports = { 3 | extends: ['@microsoft/eslint-config-spfx/lib/profiles/default'], 4 | parserOptions: { tsconfigRootDir: __dirname }, 5 | overrides: [ 6 | { 7 | files: ['*.ts', '*.tsx'], 8 | parser: '@typescript-eslint/parser', 9 | 'parserOptions': { 10 | 'project': './tsconfig.json', 11 | 'ecmaVersion': 2018, 12 | 'sourceType': 'module' 13 | }, 14 | rules: { 15 | // Prevent usage of the JavaScript null value, while allowing code to access existing APIs that may require null. https://www.npmjs.com/package/@rushstack/eslint-plugin 16 | '@rushstack/no-new-null': 1, 17 | // Require Jest module mocking APIs to be called before any other statements in their code block. https://www.npmjs.com/package/@rushstack/eslint-plugin 18 | '@rushstack/hoist-jest-mock': 1, 19 | // Require regular expressions to be constructed from string constants rather than dynamically building strings at runtime. https://www.npmjs.com/package/@rushstack/eslint-plugin-security 20 | '@rushstack/security/no-unsafe-regexp': 1, 21 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 22 | '@typescript-eslint/adjacent-overload-signatures': 1, 23 | // RATIONALE: Code is more readable when the type of every variable is immediately obvious. 24 | // Even if the compiler may be able to infer a type, this inference will be unavailable 25 | // to a person who is reviewing a GitHub diff. This rule makes writing code harder, 26 | // but writing code is a much less important activity than reading it. 27 | // 28 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 29 | '@typescript-eslint/explicit-function-return-type': [ 30 | 1, 31 | { 32 | 'allowExpressions': true, 33 | 'allowTypedFunctionExpressions': true, 34 | 'allowHigherOrderFunctions': false 35 | } 36 | ], 37 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 38 | // Rationale to disable: although this is a recommended rule, it is up to dev to select coding style. 39 | // Set to 1 (warning) or 2 (error) to enable. 40 | '@typescript-eslint/explicit-member-accessibility': 0, 41 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 42 | '@typescript-eslint/no-array-constructor': 1, 43 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 44 | // 45 | // RATIONALE: The "any" keyword disables static type checking, the main benefit of using TypeScript. 46 | // This rule should be suppressed only in very special cases such as JSON.stringify() 47 | // where the type really can be anything. Even if the type is flexible, another type 48 | // may be more appropriate such as "unknown", "{}", or "Record". 49 | '@typescript-eslint/no-explicit-any': 1, 50 | // RATIONALE: The #1 rule of promises is that every promise chain must be terminated by a catch() 51 | // handler. Thus wherever a Promise arises, the code must either append a catch handler, 52 | // or else return the object to a caller (who assumes this responsibility). Unterminated 53 | // promise chains are a serious issue. Besides causing errors to be silently ignored, 54 | // they can also cause a NodeJS process to terminate unexpectedly. 55 | '@typescript-eslint/no-floating-promises': 2, 56 | // RATIONALE: Catches a common coding mistake. 57 | '@typescript-eslint/no-for-in-array': 2, 58 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 59 | '@typescript-eslint/no-misused-new': 2, 60 | // RATIONALE: The "namespace" keyword is not recommended for organizing code because JavaScript lacks 61 | // a "using" statement to traverse namespaces. Nested namespaces prevent certain bundler 62 | // optimizations. If you are declaring loose functions/variables, it's better to make them 63 | // static members of a class, since classes support property getters and their private 64 | // members are accessible by unit tests. Also, the exercise of choosing a meaningful 65 | // class name tends to produce more discoverable APIs: for example, search+replacing 66 | // the function "reverse()" is likely to return many false matches, whereas if we always 67 | // write "Text.reverse()" is more unique. For large scale organization, it's recommended 68 | // to decompose your code into separate NPM packages, which ensures that component 69 | // dependencies are tracked more conscientiously. 70 | // 71 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 72 | '@typescript-eslint/no-namespace': [ 73 | 1, 74 | { 75 | 'allowDeclarations': false, 76 | 'allowDefinitionFiles': false 77 | } 78 | ], 79 | // RATIONALE: Parameter properties provide a shorthand such as "constructor(public title: string)" 80 | // that avoids the effort of declaring "title" as a field. This TypeScript feature makes 81 | // code easier to write, but arguably sacrifices readability: In the notes for 82 | // "@typescript-eslint/member-ordering" we pointed out that fields are central to 83 | // a class's design, so we wouldn't want to bury them in a constructor signature 84 | // just to save some typing. 85 | // 86 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 87 | // Set to 1 (warning) or 2 (error) to enable the rule 88 | '@typescript-eslint/parameter-properties': 0, 89 | // RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code 90 | // may impact performance. 91 | // 92 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 93 | '@typescript-eslint/no-unused-vars': [ 94 | 1, 95 | { 96 | 'vars': 'all', 97 | // Unused function arguments often indicate a mistake in JavaScript code. However in TypeScript code, 98 | // the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures 99 | // that are overriding a base class method or implementing an interface. 100 | 'args': 'none' 101 | } 102 | ], 103 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 104 | '@typescript-eslint/no-use-before-define': [ 105 | 2, 106 | { 107 | 'functions': false, 108 | 'classes': true, 109 | 'variables': true, 110 | 'enums': true, 111 | 'typedefs': true 112 | } 113 | ], 114 | // Disallows require statements except in import statements. 115 | // In other words, the use of forms such as var foo = require("foo") are banned. Instead use ES6 style imports or import foo = require("foo") imports. 116 | '@typescript-eslint/no-var-requires': 'error', 117 | // RATIONALE: The "module" keyword is deprecated except when describing legacy libraries. 118 | // 119 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 120 | '@typescript-eslint/prefer-namespace-keyword': 1, 121 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 122 | // Rationale to disable: it's up to developer to decide if he wants to add type annotations 123 | // Set to 1 (warning) or 2 (error) to enable the rule 124 | '@typescript-eslint/no-inferrable-types': 0, 125 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 126 | // Rationale to disable: declaration of empty interfaces may be helpful for generic types scenarios 127 | '@typescript-eslint/no-empty-interface': 0, 128 | // RATIONALE: This rule warns if setters are defined without getters, which is probably a mistake. 129 | 'accessor-pairs': 1, 130 | // RATIONALE: In TypeScript, if you write x["y"] instead of x.y, it disables type checking. 131 | 'dot-notation': [ 132 | 1, 133 | { 134 | 'allowPattern': '^_' 135 | } 136 | ], 137 | // RATIONALE: Catches code that is likely to be incorrect 138 | 'eqeqeq': 1, 139 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 140 | 'for-direction': 1, 141 | // RATIONALE: Catches a common coding mistake. 142 | 'guard-for-in': 2, 143 | // RATIONALE: If you have more than 2,000 lines in a single source file, it's probably time 144 | // to split up your code. 145 | 'max-lines': ['warn', { max: 2000 }], 146 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 147 | 'no-async-promise-executor': 2, 148 | // RATIONALE: Deprecated language feature. 149 | 'no-caller': 2, 150 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 151 | 'no-compare-neg-zero': 2, 152 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 153 | 'no-cond-assign': 2, 154 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 155 | 'no-constant-condition': 1, 156 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 157 | 'no-control-regex': 2, 158 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 159 | 'no-debugger': 1, 160 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 161 | 'no-delete-var': 2, 162 | // RATIONALE: Catches code that is likely to be incorrect 163 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 164 | 'no-duplicate-case': 2, 165 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 166 | 'no-empty': 1, 167 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 168 | 'no-empty-character-class': 2, 169 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 170 | 'no-empty-pattern': 1, 171 | // RATIONALE: Eval is a security concern and a performance concern. 172 | 'no-eval': 1, 173 | // RATIONALE: Catches code that is likely to be incorrect 174 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 175 | 'no-ex-assign': 2, 176 | // RATIONALE: System types are global and should not be tampered with in a scalable code base. 177 | // If two different libraries (or two versions of the same library) both try to modify 178 | // a type, only one of them can win. Polyfills are acceptable because they implement 179 | // a standardized interoperable contract, but polyfills are generally coded in plain 180 | // JavaScript. 181 | 'no-extend-native': 1, 182 | // Disallow unnecessary labels 183 | 'no-extra-label': 1, 184 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 185 | 'no-fallthrough': 2, 186 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 187 | 'no-func-assign': 1, 188 | // RATIONALE: Catches a common coding mistake. 189 | 'no-implied-eval': 2, 190 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 191 | 'no-invalid-regexp': 2, 192 | // RATIONALE: Catches a common coding mistake. 193 | 'no-label-var': 2, 194 | // RATIONALE: Eliminates redundant code. 195 | 'no-lone-blocks': 1, 196 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 197 | 'no-misleading-character-class': 2, 198 | // RATIONALE: Catches a common coding mistake. 199 | 'no-multi-str': 2, 200 | // RATIONALE: It's generally a bad practice to call "new Thing()" without assigning the result to 201 | // a variable. Either it's part of an awkward expression like "(new Thing()).doSomething()", 202 | // or else implies that the constructor is doing nontrivial computations, which is often 203 | // a poor class design. 204 | 'no-new': 1, 205 | // RATIONALE: Obsolete language feature that is deprecated. 206 | 'no-new-func': 2, 207 | // RATIONALE: Obsolete language feature that is deprecated. 208 | 'no-new-object': 2, 209 | // RATIONALE: Obsolete notation. 210 | 'no-new-wrappers': 1, 211 | // RATIONALE: Catches code that is likely to be incorrect 212 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 213 | 'no-octal': 2, 214 | // RATIONALE: Catches code that is likely to be incorrect 215 | 'no-octal-escape': 2, 216 | // RATIONALE: Catches code that is likely to be incorrect 217 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 218 | 'no-regex-spaces': 2, 219 | // RATIONALE: Catches a common coding mistake. 220 | 'no-return-assign': 2, 221 | // RATIONALE: Security risk. 222 | 'no-script-url': 1, 223 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 224 | 'no-self-assign': 2, 225 | // RATIONALE: Catches a common coding mistake. 226 | 'no-self-compare': 2, 227 | // RATIONALE: This avoids statements such as "while (a = next(), a && a.length);" that use 228 | // commas to create compound expressions. In general code is more readable if each 229 | // step is split onto a separate line. This also makes it easier to set breakpoints 230 | // in the debugger. 231 | 'no-sequences': 1, 232 | // RATIONALE: Catches code that is likely to be incorrect 233 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 234 | 'no-shadow-restricted-names': 2, 235 | // RATIONALE: Obsolete language feature that is deprecated. 236 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 237 | 'no-sparse-arrays': 2, 238 | // RATIONALE: Although in theory JavaScript allows any possible data type to be thrown as an exception, 239 | // such flexibility adds pointless complexity, by requiring every catch block to test 240 | // the type of the object that it receives. Whereas if catch blocks can always assume 241 | // that their object implements the "Error" contract, then the code is simpler, and 242 | // we generally get useful additional information like a call stack. 243 | 'no-throw-literal': 2, 244 | // RATIONALE: Catches a common coding mistake. 245 | 'no-unmodified-loop-condition': 1, 246 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 247 | 'no-unsafe-finally': 2, 248 | // RATIONALE: Catches a common coding mistake. 249 | 'no-unused-expressions': 1, 250 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 251 | 'no-unused-labels': 1, 252 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 253 | 'no-useless-catch': 1, 254 | // RATIONALE: Avoids a potential performance problem. 255 | 'no-useless-concat': 1, 256 | // RATIONALE: The "var" keyword is deprecated because of its confusing "hoisting" behavior. 257 | // Always use "let" or "const" instead. 258 | // 259 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 260 | 'no-var': 2, 261 | // RATIONALE: Generally not needed in modern code. 262 | 'no-void': 1, 263 | // RATIONALE: Obsolete language feature that is deprecated. 264 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 265 | 'no-with': 2, 266 | // RATIONALE: Makes logic easier to understand, since constants always have a known value 267 | // @typescript-eslint\eslint-plugin\dist\configs\eslint-recommended.js 268 | 'prefer-const': 1, 269 | // RATIONALE: Catches a common coding mistake where "resolve" and "reject" are confused. 270 | 'promise/param-names': 2, 271 | // RATIONALE: Catches code that is likely to be incorrect 272 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 273 | 'require-atomic-updates': 2, 274 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 275 | 'require-yield': 1, 276 | // "Use strict" is redundant when using the TypeScript compiler. 277 | 'strict': [ 278 | 2, 279 | 'never' 280 | ], 281 | // RATIONALE: Catches code that is likely to be incorrect 282 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 283 | 'use-isnan': 2, 284 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 285 | // Set to 1 (warning) or 2 (error) to enable. 286 | // Rationale to disable: !!{} 287 | 'no-extra-boolean-cast': 0, 288 | // ==================================================================== 289 | // @microsoft/eslint-plugin-spfx 290 | // ==================================================================== 291 | '@microsoft/spfx/import-requires-chunk-name': 1, 292 | '@microsoft/spfx/no-require-ensure': 2, 293 | '@microsoft/spfx/pair-react-dom-render-unmount': 1 294 | } 295 | }, 296 | { 297 | // For unit tests, we can be a little bit less strict. The settings below revise the 298 | // defaults specified in the extended configurations, as well as above. 299 | files: [ 300 | // Test files 301 | '*.test.ts', 302 | '*.test.tsx', 303 | '*.spec.ts', 304 | '*.spec.tsx', 305 | 306 | // Facebook convention 307 | '**/__mocks__/*.ts', 308 | '**/__mocks__/*.tsx', 309 | '**/__tests__/*.ts', 310 | '**/__tests__/*.tsx', 311 | 312 | // Microsoft convention 313 | '**/test/*.ts', 314 | '**/test/*.tsx' 315 | ], 316 | rules: {} 317 | } 318 | ] 319 | }; -------------------------------------------------------------------------------- /Demos/03-listviewcommandset/.eslintrc.js: -------------------------------------------------------------------------------- 1 | require('@rushstack/eslint-config/patch/modern-module-resolution'); 2 | module.exports = { 3 | extends: ['@microsoft/eslint-config-spfx/lib/profiles/default'], 4 | parserOptions: { tsconfigRootDir: __dirname }, 5 | overrides: [ 6 | { 7 | files: ['*.ts', '*.tsx'], 8 | parser: '@typescript-eslint/parser', 9 | 'parserOptions': { 10 | 'project': './tsconfig.json', 11 | 'ecmaVersion': 2018, 12 | 'sourceType': 'module' 13 | }, 14 | rules: { 15 | // Prevent usage of the JavaScript null value, while allowing code to access existing APIs that may require null. https://www.npmjs.com/package/@rushstack/eslint-plugin 16 | '@rushstack/no-new-null': 1, 17 | // Require Jest module mocking APIs to be called before any other statements in their code block. https://www.npmjs.com/package/@rushstack/eslint-plugin 18 | '@rushstack/hoist-jest-mock': 1, 19 | // Require regular expressions to be constructed from string constants rather than dynamically building strings at runtime. https://www.npmjs.com/package/@rushstack/eslint-plugin-security 20 | '@rushstack/security/no-unsafe-regexp': 1, 21 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 22 | '@typescript-eslint/adjacent-overload-signatures': 1, 23 | // RATIONALE: Code is more readable when the type of every variable is immediately obvious. 24 | // Even if the compiler may be able to infer a type, this inference will be unavailable 25 | // to a person who is reviewing a GitHub diff. This rule makes writing code harder, 26 | // but writing code is a much less important activity than reading it. 27 | // 28 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 29 | '@typescript-eslint/explicit-function-return-type': [ 30 | 1, 31 | { 32 | 'allowExpressions': true, 33 | 'allowTypedFunctionExpressions': true, 34 | 'allowHigherOrderFunctions': false 35 | } 36 | ], 37 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 38 | // Rationale to disable: although this is a recommended rule, it is up to dev to select coding style. 39 | // Set to 1 (warning) or 2 (error) to enable. 40 | '@typescript-eslint/explicit-member-accessibility': 0, 41 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 42 | '@typescript-eslint/no-array-constructor': 1, 43 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 44 | // 45 | // RATIONALE: The "any" keyword disables static type checking, the main benefit of using TypeScript. 46 | // This rule should be suppressed only in very special cases such as JSON.stringify() 47 | // where the type really can be anything. Even if the type is flexible, another type 48 | // may be more appropriate such as "unknown", "{}", or "Record". 49 | '@typescript-eslint/no-explicit-any': 1, 50 | // RATIONALE: The #1 rule of promises is that every promise chain must be terminated by a catch() 51 | // handler. Thus wherever a Promise arises, the code must either append a catch handler, 52 | // or else return the object to a caller (who assumes this responsibility). Unterminated 53 | // promise chains are a serious issue. Besides causing errors to be silently ignored, 54 | // they can also cause a NodeJS process to terminate unexpectedly. 55 | '@typescript-eslint/no-floating-promises': 2, 56 | // RATIONALE: Catches a common coding mistake. 57 | '@typescript-eslint/no-for-in-array': 2, 58 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 59 | '@typescript-eslint/no-misused-new': 2, 60 | // RATIONALE: The "namespace" keyword is not recommended for organizing code because JavaScript lacks 61 | // a "using" statement to traverse namespaces. Nested namespaces prevent certain bundler 62 | // optimizations. If you are declaring loose functions/variables, it's better to make them 63 | // static members of a class, since classes support property getters and their private 64 | // members are accessible by unit tests. Also, the exercise of choosing a meaningful 65 | // class name tends to produce more discoverable APIs: for example, search+replacing 66 | // the function "reverse()" is likely to return many false matches, whereas if we always 67 | // write "Text.reverse()" is more unique. For large scale organization, it's recommended 68 | // to decompose your code into separate NPM packages, which ensures that component 69 | // dependencies are tracked more conscientiously. 70 | // 71 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 72 | '@typescript-eslint/no-namespace': [ 73 | 1, 74 | { 75 | 'allowDeclarations': false, 76 | 'allowDefinitionFiles': false 77 | } 78 | ], 79 | // RATIONALE: Parameter properties provide a shorthand such as "constructor(public title: string)" 80 | // that avoids the effort of declaring "title" as a field. This TypeScript feature makes 81 | // code easier to write, but arguably sacrifices readability: In the notes for 82 | // "@typescript-eslint/member-ordering" we pointed out that fields are central to 83 | // a class's design, so we wouldn't want to bury them in a constructor signature 84 | // just to save some typing. 85 | // 86 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 87 | // Set to 1 (warning) or 2 (error) to enable the rule 88 | '@typescript-eslint/parameter-properties': 0, 89 | // RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code 90 | // may impact performance. 91 | // 92 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 93 | '@typescript-eslint/no-unused-vars': [ 94 | 1, 95 | { 96 | 'vars': 'all', 97 | // Unused function arguments often indicate a mistake in JavaScript code. However in TypeScript code, 98 | // the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures 99 | // that are overriding a base class method or implementing an interface. 100 | 'args': 'none' 101 | } 102 | ], 103 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 104 | '@typescript-eslint/no-use-before-define': [ 105 | 2, 106 | { 107 | 'functions': false, 108 | 'classes': true, 109 | 'variables': true, 110 | 'enums': true, 111 | 'typedefs': true 112 | } 113 | ], 114 | // Disallows require statements except in import statements. 115 | // In other words, the use of forms such as var foo = require("foo") are banned. Instead use ES6 style imports or import foo = require("foo") imports. 116 | '@typescript-eslint/no-var-requires': 'error', 117 | // RATIONALE: The "module" keyword is deprecated except when describing legacy libraries. 118 | // 119 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 120 | '@typescript-eslint/prefer-namespace-keyword': 1, 121 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 122 | // Rationale to disable: it's up to developer to decide if he wants to add type annotations 123 | // Set to 1 (warning) or 2 (error) to enable the rule 124 | '@typescript-eslint/no-inferrable-types': 0, 125 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 126 | // Rationale to disable: declaration of empty interfaces may be helpful for generic types scenarios 127 | '@typescript-eslint/no-empty-interface': 0, 128 | // RATIONALE: This rule warns if setters are defined without getters, which is probably a mistake. 129 | 'accessor-pairs': 1, 130 | // RATIONALE: In TypeScript, if you write x["y"] instead of x.y, it disables type checking. 131 | 'dot-notation': [ 132 | 1, 133 | { 134 | 'allowPattern': '^_' 135 | } 136 | ], 137 | // RATIONALE: Catches code that is likely to be incorrect 138 | 'eqeqeq': 1, 139 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 140 | 'for-direction': 1, 141 | // RATIONALE: Catches a common coding mistake. 142 | 'guard-for-in': 2, 143 | // RATIONALE: If you have more than 2,000 lines in a single source file, it's probably time 144 | // to split up your code. 145 | 'max-lines': ['warn', { max: 2000 }], 146 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 147 | 'no-async-promise-executor': 2, 148 | // RATIONALE: Deprecated language feature. 149 | 'no-caller': 2, 150 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 151 | 'no-compare-neg-zero': 2, 152 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 153 | 'no-cond-assign': 2, 154 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 155 | 'no-constant-condition': 1, 156 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 157 | 'no-control-regex': 2, 158 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 159 | 'no-debugger': 1, 160 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 161 | 'no-delete-var': 2, 162 | // RATIONALE: Catches code that is likely to be incorrect 163 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 164 | 'no-duplicate-case': 2, 165 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 166 | 'no-empty': 1, 167 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 168 | 'no-empty-character-class': 2, 169 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 170 | 'no-empty-pattern': 1, 171 | // RATIONALE: Eval is a security concern and a performance concern. 172 | 'no-eval': 1, 173 | // RATIONALE: Catches code that is likely to be incorrect 174 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 175 | 'no-ex-assign': 2, 176 | // RATIONALE: System types are global and should not be tampered with in a scalable code base. 177 | // If two different libraries (or two versions of the same library) both try to modify 178 | // a type, only one of them can win. Polyfills are acceptable because they implement 179 | // a standardized interoperable contract, but polyfills are generally coded in plain 180 | // JavaScript. 181 | 'no-extend-native': 1, 182 | // Disallow unnecessary labels 183 | 'no-extra-label': 1, 184 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 185 | 'no-fallthrough': 2, 186 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 187 | 'no-func-assign': 1, 188 | // RATIONALE: Catches a common coding mistake. 189 | 'no-implied-eval': 2, 190 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 191 | 'no-invalid-regexp': 2, 192 | // RATIONALE: Catches a common coding mistake. 193 | 'no-label-var': 2, 194 | // RATIONALE: Eliminates redundant code. 195 | 'no-lone-blocks': 1, 196 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 197 | 'no-misleading-character-class': 2, 198 | // RATIONALE: Catches a common coding mistake. 199 | 'no-multi-str': 2, 200 | // RATIONALE: It's generally a bad practice to call "new Thing()" without assigning the result to 201 | // a variable. Either it's part of an awkward expression like "(new Thing()).doSomething()", 202 | // or else implies that the constructor is doing nontrivial computations, which is often 203 | // a poor class design. 204 | 'no-new': 1, 205 | // RATIONALE: Obsolete language feature that is deprecated. 206 | 'no-new-func': 2, 207 | // RATIONALE: Obsolete language feature that is deprecated. 208 | 'no-new-object': 2, 209 | // RATIONALE: Obsolete notation. 210 | 'no-new-wrappers': 1, 211 | // RATIONALE: Catches code that is likely to be incorrect 212 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 213 | 'no-octal': 2, 214 | // RATIONALE: Catches code that is likely to be incorrect 215 | 'no-octal-escape': 2, 216 | // RATIONALE: Catches code that is likely to be incorrect 217 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 218 | 'no-regex-spaces': 2, 219 | // RATIONALE: Catches a common coding mistake. 220 | 'no-return-assign': 2, 221 | // RATIONALE: Security risk. 222 | 'no-script-url': 1, 223 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 224 | 'no-self-assign': 2, 225 | // RATIONALE: Catches a common coding mistake. 226 | 'no-self-compare': 2, 227 | // RATIONALE: This avoids statements such as "while (a = next(), a && a.length);" that use 228 | // commas to create compound expressions. In general code is more readable if each 229 | // step is split onto a separate line. This also makes it easier to set breakpoints 230 | // in the debugger. 231 | 'no-sequences': 1, 232 | // RATIONALE: Catches code that is likely to be incorrect 233 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 234 | 'no-shadow-restricted-names': 2, 235 | // RATIONALE: Obsolete language feature that is deprecated. 236 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 237 | 'no-sparse-arrays': 2, 238 | // RATIONALE: Although in theory JavaScript allows any possible data type to be thrown as an exception, 239 | // such flexibility adds pointless complexity, by requiring every catch block to test 240 | // the type of the object that it receives. Whereas if catch blocks can always assume 241 | // that their object implements the "Error" contract, then the code is simpler, and 242 | // we generally get useful additional information like a call stack. 243 | 'no-throw-literal': 2, 244 | // RATIONALE: Catches a common coding mistake. 245 | 'no-unmodified-loop-condition': 1, 246 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 247 | 'no-unsafe-finally': 2, 248 | // RATIONALE: Catches a common coding mistake. 249 | 'no-unused-expressions': 1, 250 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 251 | 'no-unused-labels': 1, 252 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 253 | 'no-useless-catch': 1, 254 | // RATIONALE: Avoids a potential performance problem. 255 | 'no-useless-concat': 1, 256 | // RATIONALE: The "var" keyword is deprecated because of its confusing "hoisting" behavior. 257 | // Always use "let" or "const" instead. 258 | // 259 | // STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json 260 | 'no-var': 2, 261 | // RATIONALE: Generally not needed in modern code. 262 | 'no-void': 1, 263 | // RATIONALE: Obsolete language feature that is deprecated. 264 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 265 | 'no-with': 2, 266 | // RATIONALE: Makes logic easier to understand, since constants always have a known value 267 | // @typescript-eslint\eslint-plugin\dist\configs\eslint-recommended.js 268 | 'prefer-const': 1, 269 | // RATIONALE: Catches a common coding mistake where "resolve" and "reject" are confused. 270 | 'promise/param-names': 2, 271 | // RATIONALE: Catches code that is likely to be incorrect 272 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 273 | 'require-atomic-updates': 2, 274 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 275 | 'require-yield': 1, 276 | // "Use strict" is redundant when using the TypeScript compiler. 277 | 'strict': [ 278 | 2, 279 | 'never' 280 | ], 281 | // RATIONALE: Catches code that is likely to be incorrect 282 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 283 | 'use-isnan': 2, 284 | // STANDARDIZED BY: eslint\conf\eslint-recommended.js 285 | // Set to 1 (warning) or 2 (error) to enable. 286 | // Rationale to disable: !!{} 287 | 'no-extra-boolean-cast': 0, 288 | // ==================================================================== 289 | // @microsoft/eslint-plugin-spfx 290 | // ==================================================================== 291 | '@microsoft/spfx/import-requires-chunk-name': 1, 292 | '@microsoft/spfx/no-require-ensure': 2, 293 | '@microsoft/spfx/pair-react-dom-render-unmount': 1 294 | } 295 | }, 296 | { 297 | // For unit tests, we can be a little bit less strict. The settings below revise the 298 | // defaults specified in the extended configurations, as well as above. 299 | files: [ 300 | // Test files 301 | '*.test.ts', 302 | '*.test.tsx', 303 | '*.spec.ts', 304 | '*.spec.tsx', 305 | 306 | // Facebook convention 307 | '**/__mocks__/*.ts', 308 | '**/__mocks__/*.tsx', 309 | '**/__tests__/*.ts', 310 | '**/__tests__/*.tsx', 311 | 312 | // Microsoft convention 313 | '**/test/*.ts', 314 | '**/test/*.tsx' 315 | ], 316 | rules: {} 317 | } 318 | ] 319 | }; --------------------------------------------------------------------------------