sp-dev-fx-webparts/samples/js-dynamic-bundling-libraries
Hugo Bernier 810a68ebee Updated contributors for readmes 2023-03-15 00:11:27 -04:00
..
.devcontainer Added 1.7.x containers 2022-02-16 01:12:30 -05:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
src Added 1.7.x containers 2022-02-16 01:12:30 -05:00
teams Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
.editorconfig Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
.gitignore Added 1.7.x containers 2022-02-16 01:12:30 -05:00
.yo-rc.json Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
README.md Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
package-lock.json Bump minimist and mkdirp in /samples/js-dynamic-bundling-libraries 2023-03-09 00:10:44 +00:00
package.json Bump socket.io-parser, @microsoft/sp-build-web and @microsoft/sp-webpart-workbench 2022-11-03 16:47:56 +00:00
tsconfig.json Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00
tslint.json Upgrade js-dynamic-bundling-libraries to SPFx 1.7.0 (#709) 2018-12-08 18:57:35 +02:00

README.md

Dynamics Bundling & Loading of SPFx Packages

Summary

This sample illustrates how SPFx functionality and packages can be bundled in multiple '.js' files then be dynamically & asynchronously loaded into the page at execution time, such as with a button click.

Pre Button Click: preview

Post Button Click that imports jQuery and additional functionality: preview

Compatibility

⚠️ 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.

SPFx 1.7.0 Node.js v8 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Contributors

Version history

Version Date Comments
1.0 September 21, 2018 Initial release
1.1 December 3, 2018 Updated for SPFx 1.7.0

Minimal Path to Awesome

  • Clone this repository
  • From your command line, change your current directory to the directory containing this sample (js-dynamic-bundling-libraries, located under samples)
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • How to separate SPFx functionality into multiple bundled files
  • How to asynchronously load the seperate bundled files at execution time
  • Including a library in the separate bundled file.

Additional Information:

Video

Dynamic SPFx Package Bundling

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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.