@witchcraft/editor
    Preparing search index...

    Function useEmbeddedEditor

    • Sets up nearly everything for the embedded editor nodeview.

      Parameters

      • embedIdRef: ComputedRef<MaybeEmbedId> | Ref<MaybeEmbedId, MaybeEmbedId>
      • editor: ShallowRef<Editor | undefined>
      • rootEditor: Editor
      • getPos: () => number | undefined

        For forwarding commands the embedded editor can't handle. See Embedded.

      • __namedParameters: {
            alwaysLoad?: boolean;
            injectIsDeepEmbedded?: boolean;
            injectIsEmbedded?: boolean;
            onUndoOk?: (ref: Ref<boolean>) => void;
            onUndoWarning?: (ref: Ref<boolean>) => void;
            selfSymbol?: symbol;
            undoTimeouts?: [number, number];
        } = {}
        • OptionalalwaysLoad?: boolean

          By default, documents will not be loaded if they are embedded too deeply or recursively embedded. Passing true will ignore all checks and load them anyways. This also usually requires disabling the injections with the injectIsEmbedded and injectIsDeepEmbedded options.

        • OptionalinjectIsDeepEmbedded?: boolean

          By default, the composable injects isDeepEmbeddedInjectionKey with true if it is false. Passing false will not inject it.

        • OptionalinjectIsEmbedded?: boolean

          By default, the composable injects the isEmbedded*InjectionKeys. Passing false will not inject them.

        • OptionalonUndoOk?: (ref: Ref<boolean>) => void
        • OptionalonUndoWarning?: (ref: Ref<boolean>) => void
        • OptionalselfSymbol?: symbol
        • OptionalundoTimeouts?: [number, number]

      Returns {
          api: DocumentApiInterface;
          content: Ref<Content>;
          editorOptions: Partial<Omit<EditorOptions, "autofocus">>;
          isEmbeddedBlock?: Ref<boolean, boolean>;
          isEmbeddedTooDeep: boolean;
          isLoading: Ref<boolean>;
          isRecursivelyEmbedded: ComputedRef<boolean>;
          name: ComputedRef<string | undefined>;
          selfSymbol: symbol;
          showUndoWarning: Ref<boolean>;
      }

      • api: DocumentApiInterface
      • content: Ref<Content>
      • editorOptions: Partial<Omit<EditorOptions, "autofocus">>

        The root editor needs to provide it's options so we can pass them to the embedded editor. If we don't, extra extensions (e.g. BaseShortcuts) and options won't be registered on the embedded editor. See the embeddedEditorOptionsInjectionKey for why autofocus is ommitted.

      • OptionalisEmbeddedBlock?: Ref<boolean, boolean>
      • isEmbeddedTooDeep: boolean
      • isLoading: Ref<boolean>
      • isRecursivelyEmbedded: ComputedRef<boolean>
      • name: ComputedRef<string | undefined>

        If name is undefined, the embed is a new embed without a document id.

      • selfSymbol: symbol
      • showUndoWarning: Ref<boolean>

    Settings

    Member Visibility