Skip to main content
Version: v2

SchemaIncompatibleProps Interface

React Props for displaying when the opened document is incompatible with the required view schema.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/react/alpha.

For more information about our API support guarantees, see here.

Signature​

export interface SchemaIncompatibleProps

Properties​

PropertyAlertsModifiersTypeDescription
compatibilityAlphareadonlySchemaCompatibilityStatusInformation about the view schema's compatibility with the stored schema.
upgradeSchemaAlphareadonly() => voidCallback to request that the stored schema in the document be upgraded.

Property Details​

compatibility​

Information about the view schema's compatibility with the stored schema.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly compatibility: SchemaCompatibilityStatus;

Type: SchemaCompatibilityStatus

upgradeSchema​

Callback to request that the stored schema in the document be upgraded.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly upgradeSchema: () => void;

Type: () => void