Skip to content

prosekit/core/test

Interfaces

TestEditor<E>

Accessors

get mounted(): boolean: Whether the editor is mounted.

Inherited from

Editor.mounted

get view(): EditorView: The editor view.

Inherited from

Editor.view

get schema(): Schema<ExtractNodeNames<E>, ExtractMarkNames<E>>: The editor schema.

Inherited from

Editor.schema

get state(): EditorState: The editor's current state.

Inherited from

Editor.state

get focused(): boolean: Whether the editor is focused.

Inherited from

Editor.focused

get commands(): ExtractCommandActions<E>: All CommandActions defined by the editor.

Inherited from

Editor.commands

get nodes(): ExtractNodeActions<E>: All NodeActions defined by the editor.

Inherited from

Editor.nodes

get marks(): ExtractMarkActions<E>: All MarkActions defined by the editor.

Inherited from

Editor.marks

Methods

mount(place: undefined | null | HTMLElement): void

Mount the editor to the given HTML element. Pass null or undefined to unmount the editor.

Inherited from

Editor.mount

unmount(): void

Unmount the editor. This is equivalent to mount(null).

Inherited from

Editor.unmount

focus(): void

Focus the editor.

Inherited from

Editor.focus

blur(): void

Blur the editor.

Inherited from

Editor.blur

use(extension: Extension): VoidFunction

Register an extension to the editor. Return a function to unregister the extension.

Inherited from

updateState(state: EditorState): void

Update the editor's state.

Remarks

This is an advanced method. Use it only if you have a specific reason to directly manipulate the editor's state.

Inherited from

Editor.updateState

setContent(content: string | ProseMirrorNode | NodeJSON | HTMLElement, selection?: Selection | "start" | SelectionJSON | "end"): void

Update the editor's document and selection.

Inherited from

Editor.setContent

getDocJSON(): NodeJSON

Return a JSON object representing the editor's current document.

Inherited from

Editor.getDocJSON

getDocHTML(options?: getDocHTMLOptions): string

Return a HTML string representing the editor's current document.

Inherited from

Editor.getDocHTML

exec(command: Command): boolean

Execute the given command. Return true if the command was successfully executed, otherwise false.

Inherited from

Editor.exec

canExec(command: Command): boolean

Check if the given command can be executed. Return true if the command can be executed, otherwise false.

Inherited from

Editor.canExec

set(doc: ProseMirrorNode): void

Set the editor state to the given document. You can use special tokens <a> and <b> to set the anchor and head positions of the selection.

Example

const editor = createTestEditor({ extension })
const n = editor.nodes
const doc = n.doc(n.paragraph('<a>Hello<b> world!'))
editor.set(doc) // "Hello" is selected.

dispatchEvent(event: Event): void

Functions

createTestEditor()

function createTestEditor<E>(options: EditorOptions<E>): TestEditor<E>