Interface DocumentPluginOptions`Beta`

Hidden

interface DocumentPluginOptions {
    actions?: DocumentActionComponent[] | DocumentActionsResolver;
    badges?: DocumentBadgeComponent[] | DocumentBadgesResolver;
    drafts?: { enabled?: boolean };
    inspectors?: DocumentInspector[] | DocumentInspectorsResolver;
    newDocumentOptions?: NewDocumentOptionsResolver;
    productionUrl?: AsyncComposableOption<string, ResolveProductionUrlContext>;
    unstable_comments?: {
        enabled:
            | boolean
            | ((context: DocumentCommentsEnabledContext) => boolean);
    };
    unstable_languageFilter?: DocumentLanguageFilterResolver;
}

Index

Properties

actions? badges? drafts? inspectors? newDocumentOptions? productionUrl? unstable_comments? unstable_languageFilter?

Properties

`Optional` `Beta`actions

actions?: DocumentActionComponent[] | DocumentActionsResolver

`Optional` `Beta`badges

badges?: DocumentBadgeComponent[] | DocumentBadgesResolver

`Optional` `Beta`drafts

drafts?: { enabled?: boolean }

Type declaration

Optionalenabled?: boolean
Whether the workspace provides the draft model for interacting with documents.

When switched off, documents may only be edited:
- Inside a release.
- Outside a release if they support live-edit.

`Optional` `Beta`inspectors

inspectors?: DocumentInspector[] | DocumentInspectorsResolver

Hidden

`Optional` `Beta`newDocumentOptions

newDocumentOptions?: NewDocumentOptionsResolver

Hidden

`Optional` `Beta`productionUrl

productionUrl?: AsyncComposableOption<string, ResolveProductionUrlContext>

Hidden

`Optional` `Beta`unstable_comments

unstable_comments?: {
    enabled:
        | boolean
        | ((context: DocumentCommentsEnabledContext) => boolean);
}

Deprecated

Use comments instead

`Optional` `Beta`unstable_languageFilter

unstable_languageFilter?: DocumentLanguageFilterResolver

Hidden