How pnp/sp-dev-fx-controls-react works
This repository is the PnP SharePoint Framework React Controls library: it provides reusable React controls for SPFx solutions. The principal workflow is an SPFx app consuming the package’s public exports and using controls to present or interact with SharePoint data. Major branches include file selection, lists and fields, people and taxonomy, and general UI/data visualization controls. The tree and excerpts establish the breadth of the library, but do not show most control internals; edges therefore show only documented package use and exports visible in the public index.
Main entry points: index.ts Public Exports · FilesSearchService.ts File Search · GeneralHelper.ts General Helpers · SPService.ts SP Service
Components 24
Package API
- Public Exports
src/index.ts
SharePoint Data
- SP Entities
src/common/SPEntities.ts - SP Service
src/services/SPService.ts - Term Store Service
src/services/SPTermStorePickerService.ts - General Helpers
src/common/utilities/GeneralHelper.ts - SP Helpers
src/common/utilities/SPHelper.ts - String Extensions
src/common/extensions/String.extensions.ts
Pickers and Search
- File Picker
src/controls/filePicker - SP File Picker
src/controls/SPFilePicker/hooks/useSPFilePicker.ts - File Search
src/services/FilesSearchService.ts - People Search
src/services/PeopleSearchService.ts - Teams Hook
src/hooks/useTeams.ts - Groups Hook
src/hooks/useGroups.ts
UI and Visualization
- List Controls
src/controls/DetailsList - Field Controls
src/controls/fields - Taxonomy Picker
src/controls/TermSetNavigation - Calendar
src/controls/calendar - Charts
src/controls/chartControl - Dashboard
src/controls/dashboard - Adaptive Cards
src/controls/adaptiveCardHost - Other UI Controls
src/controls
Other components
- SPFx Application
- Microsoft Graph
- SharePoint APIs
Connections 21
- SPFx Application → Public Exports: consumes
README.md - Public Exports → File Picker: exports
src/index.ts - Public Exports → SP File Picker: exports
src/index.ts - Public Exports → List Controls: exports
src/index.ts - Public Exports → Field Controls: exports
src/index.ts - Public Exports → Taxonomy Picker: exports
src/index.ts - Public Exports → Calendar: exports
src/index.ts - Public Exports → Charts: exports
src/index.ts - Public Exports → Other UI Controls: exports
src/index.ts - SP Service → SP Entities: uses types
src/services/SPService.ts - SP Service → General Helpers: uses helpers
src/services/SPService.ts - SP File Picker → SharePoint APIs: uses picker APIs
- File Search → SharePoint APIs: queries search
src/services/FilesSearchService.ts - File Search → General Helpers: uses helpers
src/services/FilesSearchService.ts - File Search → SharePoint APIs: resolves site info
src/services/FilesSearchService.ts - People Search → Microsoft Graph: searches users
src/services/PeopleSearchService.ts - Teams Hook → Microsoft Graph: queries teams
src/hooks/useTeams.ts - Groups Hook → Microsoft Graph: queries groups
src/hooks/useGroups.ts - Term Store Service → SharePoint APIs: retrieves terms
src/services/SPTermStorePickerService.ts - SP Helpers → SharePoint APIs: supports SP controls
- General Helpers → String Extensions: loads extensions
src/common/utilities/GeneralHelper.ts