Edit

IComponentModuleConfiguration interface

  • Reference
Package:
@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.

Extends
IModuleConfigurationBase

Properties

failoverPath

A path to the framework-supplied component in case the framework fails to load the requested version.
id

The ID of the framework-supplied component to be loaded.
type
version

The version of the framework-supplied component to be loaded. For framework runtime component such as @microsoft/sp-client-base, it is recommended the version of the framework component the component was developed against be specified.

Property Details

failoverPath

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

A path to the framework-supplied component in case the framework fails to load the requested version.

failoverPath?: string | IIntegrityPath;

Property Value

string | IIntegrityPath

Remarks

This must be either a fully-qualified URL, or a path under the paths specified in the internalModuleBaseUrls field. If this field is not specified and the version is not available in the framework runtime, the closest matching version of the component will be provided instead.

Supported values: The path to the component either as a fully-qualified URL or as a path under the paths provided in the "internalModuleBaseUrls" field.

Example: "https://code.jquery.com/jquery-2.2.4.min.js"

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The ID of the framework-supplied component to be loaded.

id: string;

Property Value

string

Remarks

Supported values: string representing a component's ID.

Example: "0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

type: 'component';

Property Value

'component'

version

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The version of the framework-supplied component to be loaded. For framework runtime component such as @microsoft/sp-client-base, it is recommended the version of the framework component the component was developed against be specified.

version: string;

Property Value

string

Remarks

Supported values: string representing a semantic version, or "latest".

Example: "2.2.4"