Trilium Frontend API
    Preparing search index...

    Interface CKEditorOpts

    interface CKEditorOpts {
        apiRef: MutableRef<CKEditorApi>;
        className: string;
        config: EditorConfig;
        currentValue?: string;
        disableNewlines?: boolean;
        disableSpellcheck?: boolean;
        editor: typeof AttributeEditor;
        onBlur?: () => void;
        onChange?: (newValue?: string) => void;
        onClick?: (e: MouseEvent, pos?: ModelPosition) => void;
        onInitialized?: (editorInstance: CKTextEditor) => void;
        onKeyDown?: (e: KeyboardEvent) => void;
        tabIndex?: number;
        uiLanguage?:
            | "id"
            | "cn"
            | "cs"
            | "de"
            | "en"
            | "en-GB"
            | "es"
            | "fr"
            | "ga"
            | "it"
            | "hi"
            | "ja"
            | "ko"
            | "pt_br"
            | "pt"
            | "pl"
            | "ro"
            | "ru"
            | "tr"
            | "tw"
            | "uk"
            | "en_rtl"
            | "ar";
    }
    Index
    apiRef className config currentValue? disableNewlines? disableSpellcheck? editor onBlur? onChange? onClick? onInitialized? onKeyDown? tabIndex? uiLanguage?
    apiRef: MutableRef<CKEditorApi>
    className: string
    config: EditorConfig
    currentValue?: string
    disableNewlines?: boolean
    disableSpellcheck?: boolean
    editor: typeof AttributeEditor
    onBlur?: () => void
    onChange?: (newValue?: string) => void
    onClick?: (e: MouseEvent, pos?: ModelPosition) => void
    onInitialized?: (editorInstance: CKTextEditor) => void
    onKeyDown?: (e: KeyboardEvent) => void
    tabIndex?: number
    uiLanguage?:
        | "id"
        | "cn"
        | "cs"
        | "de"
        | "en"
        | "en-GB"
        | "es"
        | "fr"
        | "ga"
        | "it"
        | "hi"
        | "ja"
        | "ko"
        | "pt_br"
        | "pt"
        | "pl"
        | "ro"
        | "ru"
        | "tr"
        | "tw"
        | "uk"
        | "en_rtl"
        | "ar"

    The language the editor's own strings — a toolbar's tooltips, the link balloon — are to be shown in, whose dictionary is fetched and laid within reach before the editor is raised (see registerCkTranslations). Settled here rather than in the configuration a caller hands over because the editor is already built from within an effect, where waiting costs a field nothing; a caller that waited would be holding back its own mounting instead.

    Left out, the editor speaks whatever its configuration says, which is the English it was written in.

    Settings
    Member Visibility

    On This Page
    Properties