`@stesura/core/plugins`

ProseMirror plugins that make up the editor runtime, and the plugin keys for reading their state.

stesuraPlugins(schema, editorId, configuration?, options?) returns the full set: basePlugins (infrastructure) followed by customPlugins (features). Set an entry to false in options to leave that plugin out, e.g. { history: false } when a collab provider supplies its own undo/redo. configPlugin and viewModeInteractionsPlugin are always included; stesuraKeymapPlugin is not part of the set.

Functions & values

`basePlugins`

Parameters:

Name	Type	Default
`schema`	`Schema<any, any>`
`editorId`	`string`
`configuration`	`ConfigPluginProps`
`props`	`BasePluginsProps`

Returns:

Plugin<any>[]

`closeMathEditor`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`codeHighlightPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<CodeHighlightPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => CodeHighlightPluginState \| undefined` Get the plugin’s state from an editor state.

`configPlugin`

Parameters:

Name	Type	Default
`__0`	`ConfigPluginProps & { editorId: string; }`

Returns:

Plugin<ConfigPluginState>

`configPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<ConfigPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => ConfigPluginState \| undefined` Get the plugin’s state from an editor state.

`customPlugins`

Parameters:

Name	Type	Default
`props`	`CustomPluginsProps`

Returns:

Plugin<any>[]

`docStylingPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`formatPainterPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<FormatPainterPluginState>

`formatPainterPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<FormatPainterPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => FormatPainterPluginState \| undefined` Get the plugin’s state from an editor state.

`gapCursorClassPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`getImageUploadPolicy`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

ImageUploadPolicy | undefined

`getMathEditorState`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

MathEditorState

`headerFooterGuardPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`headerFooterRegion`

Parameters:

Name	Type	Default
`sectionIndex`	`number`
`kind`	`"header" \| "footer"`
`variant`	`string`

Returns:

string

`headerFooterSyncPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<any> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => any` Get the plugin’s state from an editor state.

`headingInputRulesPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<HeadingInputRuleState | null>

`highlightCounterNodesPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<HighlightCounterNodesState>

`highlightPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<{ persistedColor: null; }>

`highlightPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<HighlightPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => HighlightPluginState \| undefined` Get the plugin’s state from an editor state.

`imagePlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<DecorationSet>

`imagePluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<DecorationSet> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => DecorationSet \| undefined` Get the plugin’s state from an editor state.

`imageUploadPolicy`

Parameters:

Name	Type	Default
`policy`	`ImageUploadPolicy`

Returns:

Plugin<ImageUploadPolicy>

`imageUploadPolicyKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<ImageUploadPolicy> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => ImageUploadPolicy \| undefined` Get the plugin’s state from an editor state.

`inlineNodeSelectionHandlerPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<InlineNodeSelectionHandlerState>

`invisibleCharacters`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<InvisibleCharactersState>

`invisibleCharactersPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<InvisibleCharactersState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => InvisibleCharactersState \| undefined` Get the plugin’s state from an editor state.

`languagePlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<LanguagePluginState>

`languagePluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<LanguagePluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => LanguagePluginState \| undefined` Get the plugin’s state from an editor state.

`lowlightPlugin`

Name	Type	Default
`spec`	`PluginSpec<CodeHighlightPluginState>` The plugin’s spec object .
`props`	`EditorProps<Plugin<CodeHighlightPluginState>>` The props exported by this plugin.
`getState`	`(state: EditorState) => CodeHighlightPluginState \| undefined` Extract the plugin’s state field from an editor state.

`mathEditorEnterCmd`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`mathEditorPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<MathEditorState>

`mathEditorPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<MathEditorState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => MathEditorState \| undefined` Get the plugin’s state from an editor state.

`mathPlugins`

Parameters:

Name	Type	Default
`schema`	`Schema<any, any>`

Returns:

Plugin<any>[]

`numberingInputRulesPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<NumberingInputRuleState | null>

`numberingPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`numberingPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<any> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => any` Get the plugin’s state from an editor state.

`numberingPropsPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`numberingPropsPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<any> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => any` Get the plugin’s state from an editor state.

`openMathEditor`

Parameters:

Name	Type	Default
`state`	`EditorState`
`dispatch`	`(tr: Transaction) => void`
`view`	`EditorView`

Returns:

boolean

`openMathEditorAt`

Parameters:

Name	Type	Default
`pos`	`number`

Returns:

Command

`openMathEditorTarget`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

{ node: Node; pos: number; } | null

`paginationPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<PaginationPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => PaginationPluginState \| undefined` Get the plugin’s state from an editor state.

`pendingLinkPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<PendingLinkPluginState>

`pendingLinkPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<PendingLinkPluginState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => PendingLinkPluginState \| undefined` Get the plugin’s state from an editor state.

`searchPlugin`

Parameters:

Name	Type	Default
`options`	`{ initialQuery?: SearchQuery; initialRange?: { from: number; to: number; }; }`

Returns:

Plugin<any>

`searchPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<SearchState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => SearchState \| undefined` Get the plugin’s state from an editor state.

`SearchQuery`

Name	Type	Default
`search`	`string`
`caseSensitive`	`boolean`
`literal`	`boolean`
`regexp`	`boolean`
`replace`	`string`
`valid`	`boolean`
`wholeWord`	`boolean`
`skipDeletions`	`boolean`
`filter`	`((state: EditorState, result: SearchResult) => boolean) \| null`
`impl`	`QueryImpl`
`eq`	`(other: SearchQuery) => boolean`
`findNext`	`(state: EditorState, from?: number, to?: number) => SearchResult \| null`
`findPrev`	`(state: EditorState, from?: number, to?: number) => SearchResult \| null`
`checkResult`	`(state: EditorState, result: SearchResult) => boolean`
`unquote`	`(string: string) => string`
`getReplacements`	`(state: EditorState, result: SearchResult) => { from: number; to: number; insert: Slice; }[]`

`sectionUnwrapPastePlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`selectAfterMath`

Parameters:

Name	Type	Default
`pos`	`number`

Returns:

Command

`selectionHighlightPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`setMathSource`

Parameters:

Name	Type	Default
`pos`	`number`
`source`	`string`

Returns:

Command

`setPilcrowWidgetFactory`

Parameters:

Name	Type	Default
`factory`	`PilcrowWidgetFactory`

Returns:

void

`spacingPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`stesuraKeymapPlugin`

Parameters:

Name	Type	Default
`schema`	`Schema<any, any>`

Returns:

Plugin<any>

`stesuraPlugins`

Parameters:

Name	Type	Default
`schema`	`Schema<any, any>`
`editorId`	`string`
`configuration`	`ConfigPluginProps`
`options`	`StesuraPluginsOptions`

Returns:

Plugin<any>[]

`stripTrackChangesMarksFromSlice`

Parameters:

Name	Type	Default
`slice`	`Slice`
`deletion`	`MarkType`
`insertion`	`MarkType`
`modification`	`MarkType`

Returns:

Slice

`styleNumberingInstanceId`

Parameters:

Name	Type	Default
`listRef`	`string`
`region`	`string`

Returns:

string

`styleSheetPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`styleSheetPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<StyleSheetState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => StyleSheetState \| undefined` Get the plugin’s state from an editor state.

`tableCellSelectionPreserver`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`tableDragHandlePlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<TableDragState>

`tableDragHandlePluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<TableDragState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => TableDragState \| undefined` Get the plugin’s state from an editor state.

`tableEmptyRowGuardPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`tableHeaderCellsPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`tableResizingPlugin`

Parameters:

Name	Type	Default
`options`	`TableResizingOptions`

Returns:

Plugin<ResizeState>

`tableSizingPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<boolean>

`tabStopsPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<DecorationSet>

`tabStopsPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<DecorationSet> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => DecorationSet \| undefined` Get the plugin’s state from an editor state.

`TOCplugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`tocPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<any> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => any` Get the plugin’s state from an editor state.

`trackChangesKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<TrackChangesState> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => TrackChangesState \| undefined` Get the plugin’s state from an editor state.

`trackChangesStripPastePlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`typographyPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<TypographyState | null>

`uniqueIdPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`viewModeInteractionsPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`wordPasteHandlerPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

`wordPasteHandlerPluginKey`

Name	Type	Default
`get`	`(state: EditorState) => Plugin<any> \| undefined` Get the active plugin with this key, if any, from an editor state.
`getState`	`(state: EditorState) => any` Get the plugin’s state from an editor state.

`wrapSelectionWithPlugin`

Parameters:

This function does not accept any parameters.

Returns:

Plugin<any>

Types

`CodeHighlightPluginState`

Name	Type	Default
`cache`	`DecorationCache`
`decorations`	`DecorationSet \| undefined`
`promises`	`Promise<void>[]`

`ConfigPluginProps`

Name	Type	Default
`config`	`ConfigPluginConfig`
`toastText`	`(message: ToastMessage) => string` Resolves a toast key to display text. `editor-react` installs one from the mount’s locale — hosts only need this when they mount core on their own, and without it `onToast` receives the bare key as its `description`.
`defaults`	`Partial<EditorStoreDefaults>`
`extensionStores`	`Record<string, PreinitializedWritableAtom<unknown>>`
`parentEditorId`	`string` Marks a sub-editor: store access delegates to this parent, and no stores are created.

`PilcrowWidgetFactory`

Parameters:

Name	Type	Default
`pos`	`number`

Returns:

Decoration

`SearchState`

Name	Type	Default
`enabled`	`boolean`
`query`	`SearchQuery`
`range`	`{ from: number; to: number; } \| null`
`deco`	`DecorationSet`

`StesuraPluginsOptions`

Name	Type	Default
`history`	`false \| { [key: string]: boolean; }`
`tableEditing`	`false \| { [key: string]: boolean; }`
`gapCursor`	`false \| { [key: string]: boolean; }`
`dropCursor`	`false \| { [key: string]: boolean; }`
`docStyling`	`false \| { [key: string]: boolean; }`
`mathPlugins`	`false \| { [key: string]: boolean; }`
`uniqueIdPlugin`	`false \| { [key: string]: boolean; }`
`numberingPlugin`	`false \| { [key: string]: boolean; }`
`highlightCounterNodesPlugin`	`false \| { [key: string]: boolean; }`
`TOCplugin`	`false \| { [key: string]: boolean; }`
`imagePlugin`	`false \| { [key: string]: boolean; }`
`selectionHighlightPlugin`	`false \| { [key: string]: boolean; }`
`formatPainterPlugin`	`false \| { [key: string]: boolean; }`
`searchPlugin`	`false \| { [key: string]: boolean; }`
`spacingPlugin`	`false \| { [key: string]: boolean; }`
`styleSheetPlugin`	`false \| { styles: StyleSheet; }`
`highlightPlugin`	`false \| { [key: string]: boolean; }`
`tableResizingPlugin`	`false \| { [key: string]: boolean; }`
`tableSizingPlugin`	`false \| { [key: string]: boolean; }`
`tableEmptyRowGuardPlugin`	`false \| { [key: string]: boolean; }`
`tableHeaderCellsPlugin`	`false \| { [key: string]: boolean; }`
`pendingLinkPlugin`	`false \| { [key: string]: boolean; }`
`wrapSelectionWithPlugin`	`false \| { [key: string]: boolean; }`
`typographyPlugin`	`false \| { [key: string]: boolean; }`
`linkifyPlugin`	`false` Autolink typed/pasted URLs (Word’s autoformat).
`headingInputRulesPlugin`	`false \| { [key: string]: boolean; }`
`tableDragHandlePlugin`	`false \| { [key: string]: boolean; }`
`tableCellSelectionPreserver`	`false \| { [key: string]: boolean; }`
`invisibleCharacters`	`false \| { [key: string]: boolean; }`
`tabStopsPlugin`	`false` Lays tab characters out against paragraph tab stops.
`languagePlugin`	`false \| { [key: string]: boolean; }`
`sectionUnwrapPastePlugin`	`false \| { [key: string]: boolean; }`
`trackChangesStripPastePlugin`	`false \| { [key: string]: boolean; }`
`wordPasteHandlerPlugin`	`false \| { [key: string]: boolean; }`
`inlineNodeSelectionHandlerPlugin`	`false \| { [key: string]: boolean; }`
`lowlightPlugin`	`false \| { [key: string]: boolean; }`
`headerFooterGuardPlugin`	`false \| { [key: string]: boolean; }`

Other exports

Export	Type	Description
`GAP_CURSOR_ACTIVE_CLASS`	`"pm-gapcursor-active"`	Root class set while the selection is a gap cursor.
`NUMBERING_REGION_BODY`	`"body"`	Counter-stream regions — Word’s “stories”. Numbering DEFINITIONS are document-global; the counters that run off them are per story: the body, all footnotes together, all endnotes together, and each header/footer part.
`NUMBERING_REGION_ENDNOTES`	`"endnotes"`
`NUMBERING_REGION_FOOTNOTES`	`"footnotes"`
`OVERSIZED_CLAMPS_POKE`	`"oversizedClampsPoke"`	Payload-less meta key meant to signal that the oversized-node clamp set changed. Currently neither dispatched nor read anywhere.
`PAGINATION_CLEAR_ALL_META`	`"clearAllPaginationCaches"`	Meta key (`true`) that invalidates every section’s pagination cache, e.g. after a DOCX import. Lives in core so callers need not import pagination.
`PAGINATION_DIRTY_NODES_META`	`"paginationDirtyNodes"`	Meta key carrying node ids (`string[]`) whose rendered size changed without a doc change, e.g. a nodeview whose async data grew its DOM. Pagination re-measures only those nodes, never wiping the cache.
`PILCROW_CLASS`	`"pm-pilcrow"`	Class the CSS hangs the marker’s styling off.