prosekit/vue

ProseKitProps

editor?: MaybeRefOrGetter<Editor<any>>: The editor to add the extension to. If not provided, it will use the editor from the nearest ProseKit component.
priority?: Priority: Optional priority to add the extension with.

as?: NodeViewDOMSpec
component: VueNodeViewComponent
contentAs?: NodeViewDOMSpec
deselectNode?: () => void
destroy?: () => void
ignoreMutation?: (mutation: ViewMutationRecord) => boolean | void
name: string: The name of the node type.
onUpdate?: () => void
selectNode?: () => void
setSelection?: (anchor: number, head: number, root: Document | ShadowRoot) => void
stopEvent?: (event: Event) => boolean
update?: (node: ProseMirrorNode, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean | void

Type: DefineComponent<VueMarkViewProps, any, any>

Type: DefineComponent<VueNodeViewProps, any, any>

The root component for a ProseKit editor.

Type: DefineSetupFnComponent<ProseKitProps>

function defineVueMarkView(options: VueMarkViewOptions): Extension

Defines a mark view using a Vue component.

function defineVueNodeView(options: VueNodeViewOptions): Extension

Defines a node view using a Vue component.

function useDocChange(handler: (doc: ProseMirrorNode) => void, options?: UseExtensionOptions): void

Calls the given handler whenever the editor document changes.

function useEditor<E extends Extension<ExtensionTyping<any, any, any>>>(options?: { update?: boolean }): ShallowRef<Editor<E>>

Retrieves the editor instance from the nearest ProseKit component.

function useExtension(extension: MaybeRefOrGetter<null | Extension<ExtensionTyping<any, any, any>>>, options?: UseExtensionOptions): void

Add an extension to the editor.

function useKeymap(keymap: MaybeRefOrGetter<Keymap>, options?: UseExtensionOptions): void

function useStateUpdate(handler: (state: EditorState) => void, options?: UseExtensionOptions): void

Calls the given handler whenever the editor state changes.