Interface IOptions

The instantiation options for a setting editor.

interface IOptions {
    commands: {
        registry: CommandRegistry;
        revert: string;
        save: string;
    };
    editorFactory: Factory;
    key: string;
    registry: ISettingRegistry;
    rendermime?: IRenderMimeRegistry;
    state: IStateDB<ReadonlyPartialJSONValue>;
    translator?: ITranslator;
    when?: Promise<any> | Promise<any>[];
}

Properties

commands editorFactory key registry rendermime? state translator? when?

Properties

commands

commands: {
    registry: CommandRegistry;
    revert: string;
    save: string;
}

The toolbar commands and registry for the setting editor toolbar.

Type declaration

  • registry: CommandRegistry

    The command registry.

  • revert: string

    The revert command ID.

  • save: string

    The save command ID.

editorFactory

editorFactory: Factory

The editor factory used by the setting editor.

key

key: string

The state database key for the editor's state management.

registry

registry: ISettingRegistry

The setting registry the editor modifies.

Optional rendermime

rendermime?: IRenderMimeRegistry

The optional MIME renderer to use for rendering debug messages.

state

state: IStateDB<ReadonlyPartialJSONValue>

The state database used to store layout.

Optional translator

translator?: ITranslator

The application language translator.

Optional when

when?: Promise<any> | Promise<any>[]

The point after which the editor should restore its state.

Settings

Member Visibility

Theme

On This Page

commandseditorFactorykeyregistryrendermimestatetranslatorwhen