ProseKit

Appearance

prosekit/react ​

ProseKitProps ​

children

Type: ReactNode

editor

Type: Editor<any>

ReactNodeViewOptions ​

Options for defineReactNodeView.

as

The wrapping DOM element for the node view. Defaults to div for block nodes and span for inline nodes.

Type: string | HTMLElement | ((node: Node) => HTMLElement)

component

The React component to render the node.

Type: ReactNodeViewComponent

contentAs

The wrapping DOM element for the node view's content. Defaults to div for block nodes and span for inline nodes.

Type: string | HTMLElement | ((node: Node) => HTMLElement)

deselectNode

Type: () => void

destroy

Type: () => void

ignoreMutation

Type: (mutation: MutationRecord) => boolean

name

The name of the node type.

Type: string

onUpdate

Type: () => void

selectNode

Type: () => void

setSelection

Type: (anchor: number, head: number, root: Document | ShadowRoot) => void

stopEvent

Type: (event: Event) => boolean

update

Type: (node: Node, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean

ReactNodeViewProps ​

contentRef

Type: (node: null | HTMLElement) => void

decorations

Type: readonly Decoration[]

getPos

Type: () => undefined | number

innerDecorations

Type: DecorationSource

node

Type: Node

selected

Type: boolean

setAttrs

Type: (attrs: Attrs) => void

view

Type: EditorView

UseExtensionOptions ​

editor

The editor to add the extension to. If not provided, it will use the editor from the nearest ProseKit component.

Type: Editor<any>

priority

Optional priority to add the extension with.

Type: Priority

ReactNodeViewComponent ​

Type: ComponentType<ReactNodeViewProps>

ProseKit ​

The root component for a ProseKit editor.

Type: ComponentType<ProseKitProps>

defineReactNodeView ​

ts
function defineReactNodeView(options: ReactNodeViewOptions): Extension

Defines a node view using a React component.

useDocChange ​

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

Calls the given handler whenever the editor document changes.

useEditor ​

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

Retrieves the editor instance from the nearest ProseKit component.

useExtension ​

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

Add an extension to the editor.

useKeymap ​

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

useStateUpdate ​

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

Calls the given handler whenever the editor state changes.