prosekit/preact

ProseKitProps

children?: ComponentChildren

editor: Editor

UseExtensionOptions

editor?: 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.

ProseKit

The root component for a ProseKit editor.

Type: ComponentType<ProseKitProps>

useDocChange

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

Calls the given handler whenever the editor document changes.

useEditor

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

Retrieves the editor instance from the nearest ProseKit component.

useExtension

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

Add an extension to the editor.

useKeymap

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

useStateUpdate

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

Calls the given handler whenever the editor state changes.