sp component base

Home > @microsoft/sp-component-base

sp-component-base package

SharePoint Framework support for building client-side components

Remarks

This package supports development of client-side components (e.g. web parts, client-side extensions, and applications) built using the SharePoint Framework. It defines the base classes and interfaces for functionality that is common across all client-side component types.

Classes

Class	Description
BaseComponent	The base class for client-side components such as BaseClientSideWebPart or BaseExtension.
BaseComponentContext	The base class for context objects for client-side components.
DynamicDataProvider	The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those.
DynamicDataSourceManager	The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated.
DynamicProperty	Serializable object that simplifies usage of a DynamicProperty.
ThemeChangedEventArgs	The object passed when the IThemeProvider.themeChangedEvent is raised.
ThemeProvider	The ThemeProvider class provides the capability to get different themes from the Framework. Themes can be provided in different contexts, e.g. Canvas sections may provide a variant of the global theme in some contexts.

Interfaces

Interface	Description
IComponentPropertyMetadata	This is the structure used for map values for component properties metadata.
IReadonlyFontStyles
IReadonlyTheme	Immutable ITheme.
ISerializedServerProcessedData	Contains collections of data that can be processed by server side services like search index and link fixup
ITheme	Collection of theme values, which can be used to programatically style components.

Type Aliases

Type Alias	Description
IReadonlyRawStyle