@mendix/extensions-api - v0.3.0
    Preparing search index...

    Type Alias CustomEditorOptions

    CustomEditorOptions: {
        documentType: string;
        editorEntryPoint: string;
        iconDark: string;
        iconLight: string;
        newDocumentNameHint?: string;
    } & (
        | { editorKind: "tab" }
        | { dialogSize?: { height: number; width: number }; editorKind: "dialog" }
    )

    Options for specifying the properties of a custom editor for a custom blob document.

    Type declaration

    • documentType: string

      Document type for which editor is registered

    • editorEntryPoint: string

      Entry point of the component which shows the editor UI

    • iconDark: string

      The icon which will be shown in the UI when the dark theme is active, encoded in base64 URL encoding

    • iconLight: string

      The icon which will be shown in the UI when the light theme is active, encoded in base64 URL encoding

    • OptionalnewDocumentNameHint?: string

      The name that will be used to suggest a name when creating a new document of this type

    • { editorKind: "tab" }
    • { dialogSize?: { height: number; width: number }; editorKind: "dialog" }