@microsoft/sp-module-interfaces package
Interfaces
IAdaptiveCardExtensionManifest | |
IAdaptiveCardExtensionManifestEntry |
This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. |
ICapabilityCollection |
The capability collection for the web part. It defines which capabilities are required for the web part. If the host does not support one of the required capabilities, the web part will not be visible in the toolbox. |
IClientSideApplicationManifest |
This is the manifest for a client-side application. |
IClientSideAssemblyManifest |
A library is defined by this manifest. Libraries currently do not have any additional properties. |
IClientSideComponentLoaderConfiguration |
This interface describes how a client-side component is to be loaded and initialized by a SharePoint client framework. It contains all data for loading an entrypoint script and its dependency scripts. |
IClientSideComponentManifest |
All client-side components built on the SharePoint framework need a valid component manifest. This interface represents properties that are required by all types of client-side components like Applications and Web Parts. Component specific manifests will extend this interface to add properties required by that component type. |
IClientSideExtensionManifest |
This is the manifest for a client-side extension. |
IClientSideLibraryManifest |
A library is defined by this manifest. Libraries currently do not have any additional properties. |
IClientSideManifestBase |
This interface defines members that are common between all deployable manifests. |
IClientSideMultiVersionManifest |
Multi-version manifests are defined by this interface. |
IClientSideWebPartManifest |
The client-side SharePoint framework identifies a Web Part by its manifest. All Web Parts are expected to have a manifest. |
IClientSideWebPartManifestEntry |
This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis. |
IClientSideWebPartManifestInstance |
Manifest that is relevant to a Web Part instance. |
ICommandDefinition |
Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc. |
ICommandSetExtensionManifest |
This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc. |
IComponentModuleConfiguration |
This is the interface for a script module with the "component" type. Modules of this type will be provided via manifests. In order for the dependency to be loaded, the manifest must be available on the site. |
IFlexibleLayoutSizing |
Flexible layout sizing data |
IIntegrityPath |
A path with the subresource integrity hash of the resource. |
ILocalizedPathModuleConfiguration |
This is the interface for a script module with the "localizedPath" type. |
ILocalizedString |
A set of localized strings. |
IModuleConfigurationBase |
This is the base interface for a script module's definition. |
IPathModuleConfiguration |
This is the interface for a script module with the "path" type. Modules of this type must be provided by the component developer. |
IPrefabAppManifest |
This is the manifest for a PREFAB application. |
IPrefabAppOnDemandSiteScript |
Site Script that will be applied by a PREFAB developer. |
IPrefabAppOnInstallSiteScript |
Site Script that will be applied when the app is installed. |
IPrefabAppSiteScriptBase |
Base definition for Site Script. |
IPrefabAppSiteSettingsLink |
Represents an item that should be rendered in the suite nav site settings menu. |
IPrefabAppToolboxEntry |
This interface specifies the set of that can be provided by a PREFAB developer if the application should be available in the modern SharePoint toolbox. |
IPreloadOptions | |
ISiteScriptActionBase |
Base definition for Site Script action. |
Type Aliases
ComponentType |
Type of client-side component. |
ExtensionType |
The type of client-side extension. Used by IClientSideExtensionManifest.extensionType. |
IModuleConfiguration | |
PrefabAppSiteScript |
Site Script that will be applied when the app is installed or on demand by a PREFAB app developer. |
SiteScriptType |
Available types of Site Scripts. - onInstall - Site Script that will be applied when the app is installed. - onDemand - Site Script that will be applied on demand by a PREFAB developer. |
Enums
ManifestType |
The type of the manifest. |
PredefinedGroup |
Predefined web part group. |