sharepoint SPFx Development
Pick the reference(s) that match the user's intent. Load only what is needed and execute the steps exactly:
- Create a project → create.md
- Upgrade a project → upgrade.md
- Working on UI in a React SPFx project (components, styling, layout, accessibility) → react-design.md
- Reading or writing SharePoint / Microsoft Graph data → pnpjs.md
Global rules (apply to every SPFx task)
- Use PnPjs by default for all SharePoint and Microsoft Graph data operations. See pnpjs.md. Only fall back to raw
SPHttpClient/MSGraphClientV3when the user explicitly requires it or a dependency cannot be added. - When running
npm install, always run it synchronously with a timeout of at least 3 minutes. SPFx projects have heavy dependency trees.
Toolchain decision rule
SPFx switched build systems at v1.22.0. Determine the version from .yo-rc.json (@microsoft/generator-sharepoint.version) or package.json, then:
| Installed SPFx version | Toolchain |
|---|---|
| v1.22.0 and newer | Heft |
| v1.0 – v1.21.1 | gulp (legacy) |