Building solutions with the SharePoint Framework - deep-dive
Download as PPTX, PDF0 likes1,101 views
The document outlines best practices for configuring and validating web parts in SharePoint frameworks, including specifying external libraries and managing environment types for testing and deployment. It emphasizes the importance of user-friendly configurations and searchability in web parts, and it introduces the SharePoint Framework Analysis Tool (SPCAF) for code analysis and error resolution. Additionally, it provides contact information for further engagement with the authors.
Building solutions with the SharePoint Framework - deep-dive
- 2. Thanks to our sponsors Platinum Gold Silver SharePint
- 4. Don’t bundle frameworks. Load from URL instead config/config.json { externals: { "angular": { "path": "https://cdn.com/…/angular.min.js", "globalName": "angular" } } }
- 5. Different way to reference the framework based on its format • Module format (AMD, UMD, etc.) • URL only • Non-module format • URL + globalName • optional globalDependencies
- 7. Known where you’re running • Get from this.context.environment.type • Possible values: • EnvironmentType.Test – tests context • EnvironmentType.Local – SharePoint workbench • EnvironmentType.SharePoint – Modern SharePoint page • EnvironmentType.ClassicSharePoint – Classic SharePoint page
- 8. Validate web part properties values • Synchronous • Valid value: return empty string • Invalid value: return error message • Asynchronous (using Promises) • Valid value: resolve promise with empty string • Invalid value: resolve promise with the error message • Do not reject the promise!
- 9. Pre-configure web part for easy use • Configuration set provided through preconfiguredEntries • Different title, description and web part properties value
- 10. Consider search • Use the searchablePropertyNames property to expose web part configuration to SharePoint search
- 12. Web part configuration • Standard through web part property pane • Easy to implement • Familiar to users • Custom through the web part surface • More complex to implement • Gives developers more freedom
- 14. Analyze SharePoint Framework projects with SPCAF • Catch errors and fix easily using the provided guidance • For developers • Code analysis • Best practices • For administrators • Solution inventory • Security assessment • Available soon (visit spcaf.com for more information)