Merge pull request #3533 from Tanddant/main
This commit is contained in:
Hugo Bernier
GitHub
commit
0f27d3679b
|
|
@ -0,0 +1,378 @@
|
|||
require('@rushstack/eslint-config/patch/modern-module-resolution');
|
||||
module.exports = {
|
||||
extends: ['@microsoft/eslint-config-spfx/lib/profiles/react'],
|
||||
parserOptions: { tsconfigRootDir: __dirname },
|
||||
overrides: [
|
||||
{
|
||||
files: ['*.ts', '*.tsx'],
|
||||
parser: '@typescript-eslint/parser',
|
||||
'parserOptions': {
|
||||
'project': './tsconfig.json',
|
||||
'ecmaVersion': 2018,
|
||||
'sourceType': 'module'
|
||||
},
|
||||
rules: {
|
||||
// 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
|
||||
'@rushstack/no-new-null': 1,
|
||||
// Require Jest module mocking APIs to be called before any other statements in their code block. https://www.npmjs.com/package/@rushstack/eslint-plugin
|
||||
'@rushstack/hoist-jest-mock': 1,
|
||||
// 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
|
||||
'@rushstack/security/no-unsafe-regexp': 1,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/adjacent-overload-signatures': 1,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
//
|
||||
// CONFIGURATION: By default, these are banned: String, Boolean, Number, Object, Symbol
|
||||
'@typescript-eslint/ban-types': [
|
||||
1,
|
||||
{
|
||||
'extendDefaults': false,
|
||||
'types': {
|
||||
'String': {
|
||||
'message': 'Use \'string\' instead',
|
||||
'fixWith': 'string'
|
||||
},
|
||||
'Boolean': {
|
||||
'message': 'Use \'boolean\' instead',
|
||||
'fixWith': 'boolean'
|
||||
},
|
||||
'Number': {
|
||||
'message': 'Use \'number\' instead',
|
||||
'fixWith': 'number'
|
||||
},
|
||||
'Object': {
|
||||
'message': 'Use \'object\' instead, or else define a proper TypeScript type:'
|
||||
},
|
||||
'Symbol': {
|
||||
'message': 'Use \'symbol\' instead',
|
||||
'fixWith': 'symbol'
|
||||
},
|
||||
'Function': {
|
||||
'message': 'The \'Function\' type accepts any function-like value.\nIt provides no type safety when calling the function, which can be a common source of bugs.\nIt also accepts things like class declarations, which will throw at runtime as they will not be called with \'new\'.\nIf you are expecting the function to accept certain arguments, you should explicitly define the function shape.'
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
// RATIONALE: Code is more readable when the type of every variable is immediately obvious.
|
||||
// Even if the compiler may be able to infer a type, this inference will be unavailable
|
||||
// to a person who is reviewing a GitHub diff. This rule makes writing code harder,
|
||||
// but writing code is a much less important activity than reading it.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/explicit-function-return-type': [
|
||||
1,
|
||||
{
|
||||
'allowExpressions': true,
|
||||
'allowTypedFunctionExpressions': true,
|
||||
'allowHigherOrderFunctions': false
|
||||
}
|
||||
],
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
// Rationale to disable: although this is a recommended rule, it is up to dev to select coding style.
|
||||
// Set to 1 (warning) or 2 (error) to enable.
|
||||
'@typescript-eslint/explicit-member-accessibility': 0,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/no-array-constructor': 1,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
//
|
||||
// RATIONALE: The "any" keyword disables static type checking, the main benefit of using TypeScript.
|
||||
// This rule should be suppressed only in very special cases such as JSON.stringify()
|
||||
// where the type really can be anything. Even if the type is flexible, another type
|
||||
// may be more appropriate such as "unknown", "{}", or "Record<k,V>".
|
||||
'@typescript-eslint/no-explicit-any': 1,
|
||||
// RATIONALE: The #1 rule of promises is that every promise chain must be terminated by a catch()
|
||||
// handler. Thus wherever a Promise arises, the code must either append a catch handler,
|
||||
// or else return the object to a caller (who assumes this responsibility). Unterminated
|
||||
// promise chains are a serious issue. Besides causing errors to be silently ignored,
|
||||
// they can also cause a NodeJS process to terminate unexpectedly.
|
||||
'@typescript-eslint/no-floating-promises': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'@typescript-eslint/no-for-in-array': 2,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/no-misused-new': 2,
|
||||
// RATIONALE: The "namespace" keyword is not recommended for organizing code because JavaScript lacks
|
||||
// a "using" statement to traverse namespaces. Nested namespaces prevent certain bundler
|
||||
// optimizations. If you are declaring loose functions/variables, it's better to make them
|
||||
// static members of a class, since classes support property getters and their private
|
||||
// members are accessible by unit tests. Also, the exercise of choosing a meaningful
|
||||
// class name tends to produce more discoverable APIs: for example, search+replacing
|
||||
// the function "reverse()" is likely to return many false matches, whereas if we always
|
||||
// write "Text.reverse()" is more unique. For large scale organization, it's recommended
|
||||
// to decompose your code into separate NPM packages, which ensures that component
|
||||
// dependencies are tracked more conscientiously.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/no-namespace': [
|
||||
1,
|
||||
{
|
||||
'allowDeclarations': false,
|
||||
'allowDefinitionFiles': false
|
||||
}
|
||||
],
|
||||
// RATIONALE: Parameter properties provide a shorthand such as "constructor(public title: string)"
|
||||
// that avoids the effort of declaring "title" as a field. This TypeScript feature makes
|
||||
// code easier to write, but arguably sacrifices readability: In the notes for
|
||||
// "@typescript-eslint/member-ordering" we pointed out that fields are central to
|
||||
// a class's design, so we wouldn't want to bury them in a constructor signature
|
||||
// just to save some typing.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
// Set to 1 (warning) or 2 (error) to enable the rule
|
||||
'@typescript-eslint/no-parameter-properties': 0,
|
||||
// RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code
|
||||
// may impact performance.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/no-unused-vars': [
|
||||
1,
|
||||
{
|
||||
'vars': 'all',
|
||||
// Unused function arguments often indicate a mistake in JavaScript code. However in TypeScript code,
|
||||
// the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures
|
||||
// that are overriding a base class method or implementing an interface.
|
||||
'args': 'none'
|
||||
}
|
||||
],
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/no-use-before-define': [
|
||||
2,
|
||||
{
|
||||
'functions': false,
|
||||
'classes': true,
|
||||
'variables': true,
|
||||
'enums': true,
|
||||
'typedefs': true
|
||||
}
|
||||
],
|
||||
// Disallows require statements except in import statements.
|
||||
// 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.
|
||||
'@typescript-eslint/no-var-requires': 'error',
|
||||
// RATIONALE: The "module" keyword is deprecated except when describing legacy libraries.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'@typescript-eslint/prefer-namespace-keyword': 1,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
// Rationale to disable: it's up to developer to decide if he wants to add type annotations
|
||||
// Set to 1 (warning) or 2 (error) to enable the rule
|
||||
'@typescript-eslint/no-inferrable-types': 0,
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
// Rationale to disable: declaration of empty interfaces may be helpful for generic types scenarios
|
||||
'@typescript-eslint/no-empty-interface': 0,
|
||||
// RATIONALE: This rule warns if setters are defined without getters, which is probably a mistake.
|
||||
'accessor-pairs': 1,
|
||||
// RATIONALE: In TypeScript, if you write x["y"] instead of x.y, it disables type checking.
|
||||
'dot-notation': [
|
||||
1,
|
||||
{
|
||||
'allowPattern': '^_'
|
||||
}
|
||||
],
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
'eqeqeq': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'for-direction': 1,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'guard-for-in': 2,
|
||||
// RATIONALE: If you have more than 2,000 lines in a single source file, it's probably time
|
||||
// to split up your code.
|
||||
'max-lines': ['warn', { max: 2000 }],
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-async-promise-executor': 2,
|
||||
// RATIONALE: Deprecated language feature.
|
||||
'no-caller': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-compare-neg-zero': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-cond-assign': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-constant-condition': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-control-regex': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-debugger': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-delete-var': 2,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-duplicate-case': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-empty': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-empty-character-class': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-empty-pattern': 1,
|
||||
// RATIONALE: Eval is a security concern and a performance concern.
|
||||
'no-eval': 1,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-ex-assign': 2,
|
||||
// RATIONALE: System types are global and should not be tampered with in a scalable code base.
|
||||
// If two different libraries (or two versions of the same library) both try to modify
|
||||
// a type, only one of them can win. Polyfills are acceptable because they implement
|
||||
// a standardized interoperable contract, but polyfills are generally coded in plain
|
||||
// JavaScript.
|
||||
'no-extend-native': 1,
|
||||
// Disallow unnecessary labels
|
||||
'no-extra-label': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-fallthrough': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-func-assign': 1,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-implied-eval': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-invalid-regexp': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-label-var': 2,
|
||||
// RATIONALE: Eliminates redundant code.
|
||||
'no-lone-blocks': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-misleading-character-class': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-multi-str': 2,
|
||||
// RATIONALE: It's generally a bad practice to call "new Thing()" without assigning the result to
|
||||
// a variable. Either it's part of an awkward expression like "(new Thing()).doSomething()",
|
||||
// or else implies that the constructor is doing nontrivial computations, which is often
|
||||
// a poor class design.
|
||||
'no-new': 1,
|
||||
// RATIONALE: Obsolete language feature that is deprecated.
|
||||
'no-new-func': 2,
|
||||
// RATIONALE: Obsolete language feature that is deprecated.
|
||||
'no-new-object': 2,
|
||||
// RATIONALE: Obsolete notation.
|
||||
'no-new-wrappers': 1,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-octal': 2,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
'no-octal-escape': 2,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-regex-spaces': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-return-assign': 2,
|
||||
// RATIONALE: Security risk.
|
||||
'no-script-url': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-self-assign': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-self-compare': 2,
|
||||
// RATIONALE: This avoids statements such as "while (a = next(), a && a.length);" that use
|
||||
// commas to create compound expressions. In general code is more readable if each
|
||||
// step is split onto a separate line. This also makes it easier to set breakpoints
|
||||
// in the debugger.
|
||||
'no-sequences': 1,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-shadow-restricted-names': 2,
|
||||
// RATIONALE: Obsolete language feature that is deprecated.
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-sparse-arrays': 2,
|
||||
// RATIONALE: Although in theory JavaScript allows any possible data type to be thrown as an exception,
|
||||
// such flexibility adds pointless complexity, by requiring every catch block to test
|
||||
// the type of the object that it receives. Whereas if catch blocks can always assume
|
||||
// that their object implements the "Error" contract, then the code is simpler, and
|
||||
// we generally get useful additional information like a call stack.
|
||||
'no-throw-literal': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-unmodified-loop-condition': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-unsafe-finally': 2,
|
||||
// RATIONALE: Catches a common coding mistake.
|
||||
'no-unused-expressions': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-unused-labels': 1,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-useless-catch': 1,
|
||||
// RATIONALE: Avoids a potential performance problem.
|
||||
'no-useless-concat': 1,
|
||||
// RATIONALE: The "var" keyword is deprecated because of its confusing "hoisting" behavior.
|
||||
// Always use "let" or "const" instead.
|
||||
//
|
||||
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
|
||||
'no-var': 2,
|
||||
// RATIONALE: Generally not needed in modern code.
|
||||
'no-void': 1,
|
||||
// RATIONALE: Obsolete language feature that is deprecated.
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'no-with': 2,
|
||||
// RATIONALE: Makes logic easier to understand, since constants always have a known value
|
||||
// @typescript-eslint\eslint-plugin\dist\configs\eslint-recommended.js
|
||||
'prefer-const': 1,
|
||||
// RATIONALE: Catches a common coding mistake where "resolve" and "reject" are confused.
|
||||
'promise/param-names': 2,
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'require-atomic-updates': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'require-yield': 1,
|
||||
// "Use strict" is redundant when using the TypeScript compiler.
|
||||
'strict': [
|
||||
2,
|
||||
'never'
|
||||
],
|
||||
// RATIONALE: Catches code that is likely to be incorrect
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
'use-isnan': 2,
|
||||
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
|
||||
// Set to 1 (warning) or 2 (error) to enable.
|
||||
// Rationale to disable: !!{}
|
||||
'no-extra-boolean-cast': 0,
|
||||
// ====================================================================
|
||||
// @microsoft/eslint-plugin-spfx
|
||||
// ====================================================================
|
||||
'@microsoft/spfx/import-requires-chunk-name': 1,
|
||||
'@microsoft/spfx/no-require-ensure': 2,
|
||||
'@microsoft/spfx/pair-react-dom-render-unmount': 1
|
||||
}
|
||||
},
|
||||
{
|
||||
// For unit tests, we can be a little bit less strict. The settings below revise the
|
||||
// defaults specified in the extended configurations, as well as above.
|
||||
files: [
|
||||
// Test files
|
||||
'*.test.ts',
|
||||
'*.test.tsx',
|
||||
'*.spec.ts',
|
||||
'*.spec.tsx',
|
||||
|
||||
// Facebook convention
|
||||
'**/__mocks__/*.ts',
|
||||
'**/__mocks__/*.tsx',
|
||||
'**/__tests__/*.ts',
|
||||
'**/__tests__/*.tsx',
|
||||
|
||||
// Microsoft convention
|
||||
'**/test/*.ts',
|
||||
'**/test/*.tsx'
|
||||
],
|
||||
rules: {
|
||||
'no-new': 0,
|
||||
'class-name': 0,
|
||||
'export-name': 0,
|
||||
forin: 0,
|
||||
'label-position': 0,
|
||||
'member-access': 2,
|
||||
'no-arg': 0,
|
||||
'no-console': 0,
|
||||
'no-construct': 0,
|
||||
'no-duplicate-variable': 2,
|
||||
'no-eval': 0,
|
||||
'no-function-expression': 2,
|
||||
'no-internal-module': 2,
|
||||
'no-shadowed-variable': 2,
|
||||
'no-switch-case-fall-through': 2,
|
||||
'no-unnecessary-semicolons': 2,
|
||||
'no-unused-expression': 2,
|
||||
'no-with-statement': 2,
|
||||
semicolon: 2,
|
||||
'trailing-comma': 0,
|
||||
typedef: 0,
|
||||
'typedef-whitespace': 0,
|
||||
'use-named-parameter': 2,
|
||||
'variable-name': 0,
|
||||
whitespace: 0
|
||||
}
|
||||
}
|
||||
]
|
||||
};
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
|
||||
# Dependency directories
|
||||
node_modules
|
||||
|
||||
# Build generated files
|
||||
dist
|
||||
lib
|
||||
release
|
||||
solution
|
||||
temp
|
||||
*.sppkg
|
||||
.heft
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# OSX
|
||||
.DS_Store
|
||||
|
||||
# Visual Studio files
|
||||
.ntvs_analysis.dat
|
||||
.vs
|
||||
bin
|
||||
obj
|
||||
|
||||
# Resx Generated Code
|
||||
*.resx.ts
|
||||
|
||||
# Styles Generated Code
|
||||
*.scss.ts
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
!dist
|
||||
config
|
||||
|
||||
gulpfile.js
|
||||
|
||||
release
|
||||
src
|
||||
temp
|
||||
|
||||
tsconfig.json
|
||||
tslint.json
|
||||
|
||||
*.log
|
||||
|
||||
.yo-rc.json
|
||||
.vscode
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"@microsoft/generator-sharepoint": {
|
||||
"plusBeta": false,
|
||||
"isCreatingSolution": true,
|
||||
"version": "1.15.2",
|
||||
"libraryName": "quick-links",
|
||||
"libraryId": "0c275940-be10-4d18-a29a-0329c9ecd3ff",
|
||||
"environment": "spo",
|
||||
"packageManager": "npm",
|
||||
"solutionName": "Quick Links",
|
||||
"solutionShortDescription": "Quick Links description",
|
||||
"skipFeatureDeployment": true,
|
||||
"isDomainIsolated": false,
|
||||
"componentType": "webpart"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
# Quick Links
|
||||
|
||||
## Summary
|
||||
|
||||
A demonstration of building a web part with a dynamic property pane, drag n' drop edit capabilities - I've built the Tiles feature of the default Quick Links web part, but made room for the option to implement the other 5 layouts.
|
||||
|
||||
|
||||
|
||||
## Compatibility
|
||||
|
||||
| :warning: Important |
|
||||
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node. |
|
||||
| Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
||||
|
||||
This sample is optimally compatible with the following environment configuration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
|
||||
|
||||
For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix
|
||||
|
||||
## Applies to
|
||||
|
||||
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
||||
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram)
|
||||
|
||||
## Contributors
|
||||
|
||||
* Dan Toft ([@Tanddant](https://dan-toft.dk/)) |
|
||||
|
||||
## Version history
|
||||
|
||||
| Version | Date | Comments |
|
||||
| ------- | -------------- | --------------- |
|
||||
| 1.0 | March 05, 2023 | Initial release |
|
||||
|
||||
|
||||
|
||||
## Minimal path to awesome
|
||||
|
||||
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-quick-links) then unzip it)
|
||||
* From your command line, change your current directory to the directory containing this sample (`react-quick-links`, located under `samples`)
|
||||
* in the command line run:
|
||||
* `npm install`
|
||||
* `gulp serve`
|
||||
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
|
||||
|
||||
## Features
|
||||
|
||||
This web part demonstrates a couple of nice skillsets for an SPFx developer, the idea was spawned after I heard someone suggest that the default quick links would be open sources - as it doesn't look like that's going to happen I decided to build part of it myself.
|
||||
|
||||
This demonstrates:
|
||||
|
||||
* Dynamic propertypane that changes based on user input in the web part
|
||||
* Fluent Drag 'n drop using 'react-sortable-hoc'
|
||||
* Using PnP Reusable Controls (Icon picker and WebPartTitle)
|
||||
* Styling Fluent UI components (please don't look at the actual CSS, but the principals of how to do it)
|
||||
* Grouping of property pane properties
|
||||
|
||||
|
||||
There are still loads of ideas that I would love to see implemented, but right now I don't have the time, so feel free to add contribute with the features as needed
|
||||
|
||||
| Feature | Done |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------- | ---- |
|
||||
| Drag 'n drop | ✅ |
|
||||
| Dynamic property pane | ✅ |
|
||||
| Demonstrate PnP reusable consols | ✅ |
|
||||
| Styling Fluent UI | ✅ |
|
||||
| Audience targeting | ❌ |
|
||||
| Several layouts | ❌ |
|
||||
| SPFx 1.16/1.17 [Top Action](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/release-1.16#web-part-top-actions) to choose layout | ❌ |
|
||||
|
||||
|
||||
## Help
|
||||
|
||||
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
||||
|
||||
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
||||
|
||||
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-quick-links%22) to see if anybody else is having the same issues.
|
||||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-quick-links) and see what the community is saying.
|
||||
|
||||
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-quick-links&template=bug-report.yml&sample=react-quick-links&authors=@Tanddant&title=react-quick-links%20-%20).
|
||||
|
||||
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-quick-links&template=question.yml&sample=react-quick-links&authors=@Tanddant&title=react-quick-links%20-%20).
|
||||
|
||||
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-quick-links&template=suggestion.yml&sample=react-quick-links&authors=@Tanddant&title=react-quick-links%20-%20).
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**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.**
|
||||
|
||||
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-quick-links" />
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 2.6 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
|
|
@ -0,0 +1,50 @@
|
|||
[
|
||||
{
|
||||
"name": "pnp-sp-dev-spfx-web-parts-react-quick-links",
|
||||
"source": "pnp",
|
||||
"title": "Quick Links",
|
||||
"shortDescription": "A demonstration of how one could build SharePoints Quick Links web part",
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-quick-links",
|
||||
"downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-quick-links",
|
||||
"longDescription": [
|
||||
"A demonstration of building a web part with a dynamic property pane, drag n' drop edit capabilities - I've built the Tiles feature of the default Quick Links web part, but made room for the option to implement the other 5 layouts."
|
||||
],
|
||||
"creationDateTime": "2023-03-05",
|
||||
"updateDateTime": "2023-03-05",
|
||||
"products": [
|
||||
"SharePoint"
|
||||
],
|
||||
"metadata": [
|
||||
{
|
||||
"key": "CLIENT-SIDE-DEV",
|
||||
"value": "React"
|
||||
},
|
||||
{
|
||||
"key": "SPFX-VERSION",
|
||||
"value": "1.15.2"
|
||||
}
|
||||
],
|
||||
"thumbnails": [
|
||||
{
|
||||
"type": "image",
|
||||
"order": 100,
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-quick-links/assets/Demo.gif",
|
||||
"alt": "Web Part Preview"
|
||||
}
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"gitHubAccount": "Tanddant",
|
||||
"pictureUrl": "https://github.com/Tanddant.png",
|
||||
"name": "Dan Toft"
|
||||
}
|
||||
],
|
||||
"references": [
|
||||
{
|
||||
"name": "Build your first SharePoint client-side web part",
|
||||
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
|
||||
"url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
|
||||
"version": "2.0",
|
||||
"bundles": {
|
||||
"pn-p-quick-links-web-part": {
|
||||
"components": [
|
||||
{
|
||||
"entrypoint": "./lib/webparts/pnPQuickLinks/PnPQuickLinksWebPart.js",
|
||||
"manifest": "./src/webparts/pnPQuickLinks/PnPQuickLinksWebPart.manifest.json"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"externals": {},
|
||||
"localizedResources": {
|
||||
"PnPQuickLinksWebPartStrings": "lib/webparts/pnPQuickLinks/loc/{locale}.js",
|
||||
"ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js",
|
||||
"PropertyControlStrings": "node_modules/@pnp/spfx-property-controls/lib/loc/{locale}.js"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
|
||||
"workingDir": "./release/assets/",
|
||||
"account": "<!-- STORAGE ACCOUNT NAME -->",
|
||||
"container": "quick-links",
|
||||
"accessKey": "<!-- ACCESS KEY -->"
|
||||
}
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
|
||||
"solution": {
|
||||
"name": "quick-links-client-side-solution",
|
||||
"id": "0c275940-be10-4d18-a29a-0329c9ecd3ff",
|
||||
"version": "1.0.0.0",
|
||||
"includeClientSideAssets": true,
|
||||
"skipFeatureDeployment": true,
|
||||
"isDomainIsolated": false,
|
||||
"developer": {
|
||||
"name": "",
|
||||
"websiteUrl": "",
|
||||
"privacyUrl": "",
|
||||
"termsOfUseUrl": "",
|
||||
"mpnId": "Undefined-1.15.2"
|
||||
},
|
||||
"metadata": {
|
||||
"shortDescription": {
|
||||
"default": "Quick Links description"
|
||||
},
|
||||
"longDescription": {
|
||||
"default": "Quick Links description"
|
||||
},
|
||||
"screenshotPaths": [],
|
||||
"videoUrl": "",
|
||||
"categories": []
|
||||
},
|
||||
"features": [
|
||||
{
|
||||
"title": "quick-links Feature",
|
||||
"description": "The feature that activates elements of the quick-links solution.",
|
||||
"id": "9a4bcaa4-9268-4916-8ecf-d84be3d424cf",
|
||||
"version": "1.0.0.0"
|
||||
}
|
||||
]
|
||||
},
|
||||
"paths": {
|
||||
"zippedPackage": "solution/quick-links.sppkg"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
|
||||
"port": 4321,
|
||||
"https": true,
|
||||
"initialPage": "https://enter-your-SharePoint-site/_layouts/workbench.aspx"
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
|
||||
"cdnBasePath": "<!-- PATH TO CDN -->"
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
'use strict';
|
||||
|
||||
const build = require('@microsoft/sp-build-web');
|
||||
|
||||
build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
|
||||
|
||||
var getTasks = build.rig.getTasks;
|
||||
build.rig.getTasks = function () {
|
||||
var result = getTasks.call(build.rig);
|
||||
|
||||
result.set('serve', result.get('serve-deprecated'));
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
build.initialize(require('gulp'));
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,40 @@
|
|||
{
|
||||
"name": "quick-links",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"main": "lib/index.js",
|
||||
"scripts": {
|
||||
"build": "gulp bundle",
|
||||
"clean": "gulp clean",
|
||||
"test": "gulp test"
|
||||
},
|
||||
"dependencies": {
|
||||
"@microsoft/sp-core-library": "1.15.2",
|
||||
"@microsoft/sp-lodash-subset": "1.15.2",
|
||||
"@microsoft/sp-office-ui-fabric-core": "1.15.2",
|
||||
"@microsoft/sp-property-pane": "1.15.2",
|
||||
"@microsoft/sp-webpart-base": "1.15.2",
|
||||
"@pnp/spfx-controls-react": "3.13.0",
|
||||
"@pnp/spfx-property-controls": "3.12.0",
|
||||
"office-ui-fabric-react": "7.185.7",
|
||||
"react": "16.13.1",
|
||||
"react-dom": "16.13.1",
|
||||
"react-sortable-hoc": "^2.0.0",
|
||||
"tslib": "2.3.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@microsoft/eslint-config-spfx": "1.15.2",
|
||||
"@microsoft/eslint-plugin-spfx": "1.15.2",
|
||||
"@microsoft/rush-stack-compiler-4.5": "0.2.2",
|
||||
"@microsoft/sp-build-web": "1.15.2",
|
||||
"@microsoft/sp-module-interfaces": "1.15.2",
|
||||
"@rushstack/eslint-config": "2.5.1",
|
||||
"@types/react": "16.9.51",
|
||||
"@types/react-dom": "16.9.8",
|
||||
"@types/webpack-env": "~1.15.2",
|
||||
"ajv": "^6.12.5",
|
||||
"eslint-plugin-react-hooks": "4.3.0",
|
||||
"gulp": "4.0.2",
|
||||
"typescript": "4.5.5"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1 @@
|
|||
// A file is required to be in the root of the /src directory by the TypeScript compiler
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
|
||||
"id": "aefb92b5-e547-49ea-97e7-a769ba7eacb4",
|
||||
"alias": "PnPQuickLinksWebPart",
|
||||
"componentType": "WebPart",
|
||||
"version": "*",
|
||||
"manifestVersion": 2,
|
||||
"requiresCustomScript": false,
|
||||
"supportedHosts": [
|
||||
"SharePointWebPart",
|
||||
"TeamsPersonalApp",
|
||||
"TeamsTab",
|
||||
"SharePointFullPage"
|
||||
],
|
||||
"supportsThemeVariants": true,
|
||||
"preconfiguredEntries": [
|
||||
{
|
||||
"groupId": "5c03119e-3074-46fd-976b-c60198311f70",
|
||||
"group": {
|
||||
"default": "Advanced"
|
||||
},
|
||||
"title": {
|
||||
"default": "PnP Quick links"
|
||||
},
|
||||
"description": {
|
||||
"default": "PnP Quick links description"
|
||||
},
|
||||
"officeFabricIconFontName": "MiniLink",
|
||||
"properties": {
|
||||
"type": "Tiles",
|
||||
"webpartTitle": "Awesome links",
|
||||
"links": [
|
||||
{
|
||||
"Id": "leon69eyg85v7bsmek",
|
||||
"Title": "Dans blog",
|
||||
"IconName": "blog",
|
||||
"Link": "https://blog.dan-toft.dk",
|
||||
"SortWeight": 0.25,
|
||||
"Target": "_blank"
|
||||
},
|
||||
{
|
||||
"Id": "leoonn0xyr1cels2k6j",
|
||||
"Title": "PnP",
|
||||
"IconName": "SharedDatabase",
|
||||
"Link": "https://pnp.github.io/",
|
||||
"SortWeight": 0.5,
|
||||
"Target": "_blank"
|
||||
},
|
||||
{
|
||||
"Id": "leooo0weyww1ld0kzkf",
|
||||
"Title": "Bing GPT",
|
||||
"IconName": "BingLogo",
|
||||
"Link": "https://bing.com/new",
|
||||
"SortWeight": 0.75,
|
||||
"Target": "_blank"
|
||||
}
|
||||
],
|
||||
"tile": {
|
||||
"size": 30,
|
||||
"hideText": false
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
import * as React from 'react';
|
||||
import * as ReactDom from 'react-dom';
|
||||
import { Version } from '@microsoft/sp-core-library';
|
||||
import {
|
||||
IPropertyPaneConditionalGroup,
|
||||
IPropertyPaneConfiguration,
|
||||
IPropertyPaneGroup,
|
||||
PropertyPaneButton,
|
||||
PropertyPaneCheckbox,
|
||||
PropertyPaneChoiceGroup,
|
||||
PropertyPaneLabel,
|
||||
PropertyPaneTextField,
|
||||
PropertyPaneToggle
|
||||
} from '@microsoft/sp-property-pane';
|
||||
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
|
||||
import { ITilesQuickLinksProps, TilesQuickLinks } from './components/TilesQuickLinks';
|
||||
import { ILink } from './models/ILink';
|
||||
import { PropertyFieldIconPicker } from '@pnp/spfx-property-controls/lib/PropertyFieldIconPicker';
|
||||
import { IPnPQuickLinksProps } from './components/IPnPQuickLinksProps';
|
||||
import { LayoutType, TileSize } from './models/enums';
|
||||
import { PropertyPaneDescription } from 'PnPQuickLinksWebPartStrings';
|
||||
|
||||
|
||||
|
||||
export interface IPnPQuickLinksWebPartProps {
|
||||
webpartTitle: string;
|
||||
links: ILink[];
|
||||
type: LayoutType,
|
||||
tile: {
|
||||
size: TileSize,
|
||||
hideText: boolean
|
||||
}
|
||||
}
|
||||
|
||||
export default class PnPQuickLinksWebPart extends BaseClientSideWebPart<IPnPQuickLinksWebPartProps> {
|
||||
private SelectedItemId: string = null;
|
||||
|
||||
public render(): void {
|
||||
const SharedProps: IPnPQuickLinksProps = {
|
||||
webPartTitle: this.properties.webpartTitle,
|
||||
setWebpartTitle: (val: string) => { this.properties.webpartTitle = val },
|
||||
links: this.properties.links,
|
||||
setLinks: (val: ILink[]) => {
|
||||
this.properties.links = val;
|
||||
this.onPropertyPaneFieldChanged("links", null, val);
|
||||
this.render();
|
||||
},
|
||||
|
||||
SelectedItemId: this.SelectedItemId,
|
||||
setSelectedItemId: (id: string) => {
|
||||
this.SelectedItemId = id;
|
||||
if (this.context.propertyPane.isPropertyPaneOpen()) {
|
||||
this.context.propertyPane.refresh();
|
||||
} else {
|
||||
this.context.propertyPane.open();
|
||||
}
|
||||
this.render();
|
||||
},
|
||||
|
||||
displayMode: this.displayMode
|
||||
} as IPnPQuickLinksProps
|
||||
|
||||
|
||||
let element: React.ReactElement<IPnPQuickLinksProps> = null;
|
||||
switch (this.properties.type) {
|
||||
case LayoutType.Tiles:
|
||||
element = React.createElement(TilesQuickLinks, { ...SharedProps, hideText: this.properties.tile.hideText, size: this.properties.tile.size } as ITilesQuickLinksProps);
|
||||
break;
|
||||
|
||||
//Feel free to contribute here and add the other layouts so we can eventually have every layout supported!
|
||||
};
|
||||
|
||||
ReactDom.render(element, this.domElement);
|
||||
}
|
||||
|
||||
protected onInit(): Promise<void> {
|
||||
return super.onInit();
|
||||
}
|
||||
|
||||
protected onDispose(): void {
|
||||
ReactDom.unmountComponentAtNode(this.domElement);
|
||||
}
|
||||
|
||||
protected get dataVersion(): Version {
|
||||
return Version.parse('1.0');
|
||||
}
|
||||
|
||||
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
|
||||
if (this.SelectedItemId) {
|
||||
const index = this.properties.links.map(x => x.Id).indexOf(this.SelectedItemId);
|
||||
return {
|
||||
pages: [
|
||||
{
|
||||
header: {
|
||||
description: "Edit link"
|
||||
},
|
||||
groups: [
|
||||
{
|
||||
groupFields: [
|
||||
PropertyPaneTextField(`links[${index}].Title`, {
|
||||
label: "Title"
|
||||
}),
|
||||
PropertyPaneTextField(`links[${index}].Link`, {
|
||||
label: "Url"
|
||||
}),
|
||||
PropertyFieldIconPicker(`links[${index}].IconName`,
|
||||
{
|
||||
key: `links[${index}].IconName`,
|
||||
onSave: name => this.properties.links[index].IconName = name,
|
||||
onPropertyChange: this.onPropertyPaneFieldChanged,
|
||||
properties: this.properties,
|
||||
label: "Icon",
|
||||
buttonLabel: "Choose",
|
||||
currentIcon: this.properties.links[index].IconName
|
||||
}),
|
||||
PropertyPaneChoiceGroup(`links[${index}].Target`, {
|
||||
label: "Open",
|
||||
options: [
|
||||
{ key: "_self", text: "In this tab" },
|
||||
{ key: "_blank", text: "In new tab" }
|
||||
]
|
||||
}),
|
||||
PropertyPaneButton('', {
|
||||
text: "Delete",
|
||||
icon: "Delete",
|
||||
onClick: () => {
|
||||
this.properties.links = this.properties.links.filter(x => x.Id != this.SelectedItemId);
|
||||
this.onPropertyPaneFieldChanged("links", null, this.properties.links);
|
||||
this.SelectedItemId = null;
|
||||
this.context.propertyPane.refresh();
|
||||
this.render();
|
||||
}
|
||||
}),
|
||||
PropertyPaneButton('', {
|
||||
text: "Close",
|
||||
onClick: () => {
|
||||
this.SelectedItemId = null;
|
||||
this.context.propertyPane.refresh();
|
||||
this.render();
|
||||
}
|
||||
})
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return {
|
||||
pages: [
|
||||
{
|
||||
displayGroupsAsAccordion: true,
|
||||
groups: [
|
||||
{
|
||||
groupName: "Layout options",
|
||||
groupFields: [
|
||||
PropertyPaneChoiceGroup("type", {
|
||||
options: [
|
||||
{ key: LayoutType.Compact, text: "Compact", iconProps: { officeFabricIconFontName: "BacklogList" }, disabled: true },
|
||||
{ key: LayoutType.FilmStrip, text: "FilmStrip", iconProps: { officeFabricIconFontName: "AspectRatio" }, disabled: true },
|
||||
{ key: LayoutType.Grid, text: "Grid", iconProps: { officeFabricIconFontName: "GridViewSmall" }, disabled: true },
|
||||
{ key: LayoutType.Button, text: "Button", iconProps: { officeFabricIconFontName: "Calculator" }, disabled: true },
|
||||
{ key: LayoutType.List, text: "List", iconProps: { officeFabricIconFontName: "List" }, disabled: true },
|
||||
{ key: LayoutType.Tiles, text: "Tiles", iconProps: { officeFabricIconFontName: "PictureTile" } }
|
||||
]
|
||||
}),
|
||||
]
|
||||
},
|
||||
...(this.properties.type == LayoutType.Tiles ? this.TileLayoutFields() : []),
|
||||
{
|
||||
groupName: "Filter",
|
||||
groupFields: [
|
||||
PropertyPaneToggle("_", {
|
||||
label: "Enable audience targeting",
|
||||
disabled: true,
|
||||
}),
|
||||
PropertyPaneLabel('', {
|
||||
text: "Audience targeting is not yet implemented, feel free to do so"
|
||||
})
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
private TileLayoutFields(): (IPropertyPaneGroup | IPropertyPaneConditionalGroup)[] {
|
||||
return [{
|
||||
groupFields: [
|
||||
PropertyPaneChoiceGroup('tile.size', {
|
||||
label: "Icon size",
|
||||
options: [
|
||||
{ key: TileSize.Small, text: "Small" },
|
||||
{ key: TileSize.Medium, text: "Medium" },
|
||||
{ key: TileSize.Large, text: "Large" },
|
||||
{ key: TileSize.XLarge, text: "Extra large" },
|
||||
{ key: TileSize.FillSpace, text: "Fill space" },
|
||||
]
|
||||
}),
|
||||
PropertyPaneToggle("tile.hideText", {
|
||||
label: "Show only icon",
|
||||
disabled: this.properties.tile.size > TileSize.Large,
|
||||
})
|
||||
]
|
||||
}]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
import { ILink } from "../models/ILink";
|
||||
|
||||
export class Util {
|
||||
public static GenerateId(): string {
|
||||
const uniqueId = Date.now().toString(36) + Math.random().toString(36).substring(2);
|
||||
return uniqueId;
|
||||
}
|
||||
|
||||
public static CalculateNewSortWeight(arr: ILink[], newIndex: number, oldIndex?: number) {
|
||||
const links = [...arr].sort((a, b) => a.SortWeight - b.SortWeight);
|
||||
|
||||
if (newIndex == 0)
|
||||
return this.GetAverage(null, links[0]?.SortWeight);
|
||||
if (newIndex == links.length)
|
||||
return this.GetAverage(links[links.length - 1].SortWeight, null);
|
||||
|
||||
if (newIndex < oldIndex)
|
||||
return this.GetAverage(links[newIndex - 1]?.SortWeight, links[newIndex]?.SortWeight)
|
||||
return this.GetAverage(links[newIndex]?.SortWeight, links[newIndex + 1]?.SortWeight)
|
||||
}
|
||||
|
||||
private static GetAverage(prev: number, next: number) {
|
||||
if (prev == null) prev = 0;
|
||||
if (next == null) next = 1;
|
||||
|
||||
return (prev + next) / 2
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
import { DisplayMode } from "@microsoft/sp-core-library";
|
||||
import { ILink } from "../models/ILink";
|
||||
|
||||
export interface IPnPQuickLinksProps {
|
||||
webPartTitle: string;
|
||||
setWebpartTitle: (val: string) => void;
|
||||
links: ILink[];
|
||||
setLinks: (val: ILink[]) => void
|
||||
|
||||
SelectedItemId: string,
|
||||
setSelectedItemId: (id: string) => void;
|
||||
|
||||
displayMode: DisplayMode;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
import * as React from 'react';
|
||||
import { DisplayMode } from '@microsoft/sp-core-library';
|
||||
import { WebPartTitle } from '@pnp/spfx-controls-react';
|
||||
import { ActionButton, CompoundButton, getTheme, Icon, Stack } from 'office-ui-fabric-react';
|
||||
import { ILink } from '../models/ILink';
|
||||
import { Util } from '../Util/Util';
|
||||
import { SortableContainer, SortableElement } from 'react-sortable-hoc';
|
||||
import { IPnPQuickLinksProps } from './IPnPQuickLinksProps';
|
||||
import { TileSize } from '../models/enums';
|
||||
|
||||
export interface ITilesQuickLinksProps extends IPnPQuickLinksProps {
|
||||
size: TileSize,
|
||||
hideText: boolean;
|
||||
}
|
||||
|
||||
|
||||
export const TilesQuickLinks: React.FunctionComponent<ITilesQuickLinksProps> = (props: React.PropsWithChildren<ITilesQuickLinksProps>) => {
|
||||
const { displayMode, webPartTitle, setWebpartTitle, links, setLinks, SelectedItemId, setSelectedItemId, hideText, size } = props;
|
||||
const theme = getTheme();
|
||||
|
||||
const AddLink = () => {
|
||||
setLinks([...links, {
|
||||
Id: Util.GenerateId(),
|
||||
SortWeight: Util.CalculateNewSortWeight(links, links.length),
|
||||
Title: "New link",
|
||||
IconName: "Globe",
|
||||
Link: "https://pnp.github.io/",
|
||||
Target: "_blank"
|
||||
}]);
|
||||
}
|
||||
|
||||
|
||||
|
||||
const SortableItem = SortableElement(({ link }: { link: ILink }) => (
|
||||
<CompoundButton
|
||||
primary
|
||||
text={link.Title}
|
||||
styles={{
|
||||
root: {
|
||||
border: SelectedItemId == link.Id ? `3px solid ${theme.palette.themeSecondary}` : undefined,
|
||||
width: size < TileSize.Large ? 85 + size : 130,
|
||||
minHeight: size < TileSize.Large ? 80 + size : 124,
|
||||
borderRadius: 3
|
||||
},
|
||||
textContainer: {
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
height: "100%",
|
||||
justifyContent: "center",
|
||||
textAlign: "center"
|
||||
},
|
||||
}}
|
||||
href={displayMode == DisplayMode.Read && link.Link}
|
||||
target={displayMode == DisplayMode.Read && link.Target}
|
||||
|
||||
onClick={displayMode == DisplayMode.Edit && (() => setSelectedItemId(link.Id))}
|
||||
onRenderText={(props) => {
|
||||
return (
|
||||
<Stack styles={{ root: { gap: 10 } }}>
|
||||
<Icon iconName={link.IconName} styles={{ root: { fontSize: size } }} />
|
||||
{(!hideText && size <= TileSize.Large) && props.text}
|
||||
</Stack>
|
||||
)
|
||||
}} />
|
||||
));
|
||||
|
||||
const SortableList = SortableContainer(({ items }: { items: ILink[] }) => (
|
||||
<div style={{ gap: 10, display: 'flex', flexWrap: "wrap" }}>
|
||||
{items.map((item, index) => (
|
||||
<SortableItem
|
||||
key={`${item.Id}`}
|
||||
index={index}
|
||||
link={item}
|
||||
disabled={displayMode == DisplayMode.Read}
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
));
|
||||
|
||||
const UpdateSortIndex = (indexToMove: number, newIndex: number) => {
|
||||
const arr = [...links].sort((a, b) => a.SortWeight - b.SortWeight);
|
||||
const res = Util.CalculateNewSortWeight(links, newIndex, indexToMove);
|
||||
arr[indexToMove].SortWeight = res;
|
||||
setLinks(arr);
|
||||
}
|
||||
|
||||
|
||||
return (
|
||||
|
||||
<>
|
||||
<WebPartTitle
|
||||
displayMode={displayMode}
|
||||
title={webPartTitle}
|
||||
updateProperty={setWebpartTitle}
|
||||
/>
|
||||
|
||||
{displayMode == DisplayMode.Edit && <ActionButton iconProps={{ iconName: "Add" }} onClick={() => AddLink()} >Add link</ActionButton>}
|
||||
|
||||
<SortableList
|
||||
items={[...links].sort((a, b) => a.SortWeight - b.SortWeight)}
|
||||
axis="xy"
|
||||
distance={25}
|
||||
onSortEnd={sort => UpdateSortIndex(sort.oldIndex, sort.newIndex)}
|
||||
/>
|
||||
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
define([], function() {
|
||||
return {
|
||||
"PropertyPaneDescription": "Description",
|
||||
"BasicGroupName": "Group Name",
|
||||
"DescriptionFieldLabel": "Description Field",
|
||||
"AppLocalEnvironmentSharePoint": "The app is running on your local environment as SharePoint web part",
|
||||
"AppLocalEnvironmentTeams": "The app is running on your local environment as Microsoft Teams app",
|
||||
"AppSharePointEnvironment": "The app is running on SharePoint page",
|
||||
"AppTeamsTabEnvironment": "The app is running in Microsoft Teams"
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
declare interface IPnPQuickLinksWebPartStrings {
|
||||
PropertyPaneDescription: string;
|
||||
BasicGroupName: string;
|
||||
DescriptionFieldLabel: string;
|
||||
AppLocalEnvironmentSharePoint: string;
|
||||
AppLocalEnvironmentTeams: string;
|
||||
AppSharePointEnvironment: string;
|
||||
AppTeamsTabEnvironment: string;
|
||||
}
|
||||
|
||||
declare module 'PnPQuickLinksWebPartStrings' {
|
||||
const strings: IPnPQuickLinksWebPartStrings;
|
||||
export = strings;
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
export interface ILink {
|
||||
Id: string;
|
||||
Title: string;
|
||||
IconName: string;
|
||||
Link: string;
|
||||
SortWeight: number;
|
||||
Target: string
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
export enum LayoutType {
|
||||
Compact = "Compact",
|
||||
FilmStrip = "Filmstrip",
|
||||
Grid = "Grid",
|
||||
Button = "Button",
|
||||
List = "List",
|
||||
Tiles = "Tiles"
|
||||
}
|
||||
|
||||
export enum TileSize {
|
||||
Small = 22,
|
||||
Medium = 30,
|
||||
Large = 36,
|
||||
XLarge = 60,
|
||||
FillSpace = 60.1,
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 542 B |
|
|
@ -0,0 +1,37 @@
|
|||
{
|
||||
"extends": "./node_modules/@microsoft/rush-stack-compiler-4.5/includes/tsconfig-web.json",
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "node",
|
||||
"jsx": "react",
|
||||
"declaration": true,
|
||||
"sourceMap": true,
|
||||
"experimentalDecorators": true,
|
||||
"skipLibCheck": true,
|
||||
"outDir": "lib",
|
||||
"inlineSources": false,
|
||||
"strictNullChecks": false,
|
||||
"noUnusedLocals": false,
|
||||
"noImplicitAny": true,
|
||||
|
||||
"typeRoots": [
|
||||
"./node_modules/@types",
|
||||
"./node_modules/@microsoft"
|
||||
],
|
||||
"types": [
|
||||
"webpack-env"
|
||||
],
|
||||
"lib": [
|
||||
"es5",
|
||||
"dom",
|
||||
"es2015.collection",
|
||||
"es2015.promise"
|
||||
]
|
||||
},
|
||||
"include": [
|
||||
"src/**/*.ts",
|
||||
"src/**/*.tsx"
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue