`@stesura/format-lint-react`

The format cleanup UI for the @stesura/format-lint plugin: an Export-tab button, a status-bar count and the right panel. Setup is in the Format cleanup guide.

UI extension

`formatLintUIExtension`

The format cleanup UI (Export-tab button, status-bar count, right panel), to pass via uiExtensions next to formatLintPlugin() in the mount’s plugins. Module level: the editor expects a stable uiExtensions array.

Name	Type	Default
`leftPanels`	`LeftPanelElement[]`
`rightPanels`	`RightPanelElement[]`
`bottomPanels`	`BottomPanelElement[]`
`contextMenuExtensions`	`ContextMenuExtension[]`
`textMenuExtensions`	`TextMenuExtension<string>[]`
`toolbarDefaultTabs`	`Partial<Record<ToolbarDefaultTabs, false>>`
`toolbarDefaultExtensions`	`ToolbarDefaultExtension[]`
`toolbarGroupExtensions`	`ToolbarGroupExtension[]`
`toolbarTabs`	`ToolbarExtensionTab[]` Whole tabs after the built-in ones, usually contextual.
`floatingMenuExtensions`	`FloatingMenuExtension[]`
`slashMenuExtensions`	`MenuElement[]`
`StatusBarElements`	`StatusBarElement[]`
`nodeViews`	`NodeViews`
`nodeViewWrappers`	`Record<string, ComponentType<NodeViewWrapperComponentProps>>` DOM-less wrappers composed around whichever view wins for a node type. A wrapper must render `{children}` (the wrapped view) and add no DOM; it contributes via context, typically `NodeViewSlotsProvider`. Unlike a `nodeViews` entry, it survives the consumer’s `nodeViews` overrides.
`nodeViewFallback`	`(type: NodeType) => NodeView \| undefined` The view for a block type core doesn’t define and nothing registered a view for by name (a host schema’s own node), or undefined to pass. The last extension answering wins; otherwise editor-react renders the type’s `toDOM` with its derived values and slots (`DerivedSpecView`).
`nodeViewWrapperFallback`	`(type: NodeType) => ComponentType<NodeViewWrapperComponentProps> \| undefined` A `nodeViewWrappers` entry for a block type core doesn’t define, when this extension names no wrapper for it. Composed around whichever view wins, the host’s own included, so a host node gets the extension’s behaviour (pagination’s page-break lead) without being listed.
`pdfPreview`	`PdfPreviewCapability` Renders PDF file nodes as page previews (`@stesura/pdf-viewer-react`). Declared on the extension rather than set from an effect so the file view, pagination and export know it before the first layout; an effect arrives a commit late and forced a second pagination pass.
`calloutFrame`	`ComponentType<CalloutFrameProps>` Replaces the callout title bar’s content (icon + title). Rendered inside the non-editable bar above the body; pagination measures it as chrome, so give it padding, never margins.
`documentOverlaySlot`	`React.ReactNode`
`ResizableLayoutBottomSlot`	`React.ReactNode`
`TopLeftSlot`	`React.ReactNode`
`CommentsSlot`	`React.ReactNode`

Components

`FormatLintPanel`

Right-hand panel listing the document’s format suggestions in document order: what “Fix all” applies first, then hints, which are one click each. Rows go to their paragraphs; ignored ones move to their own tab. While track changes is on, applying needs an explicit override.

Parameters:

Name	Type	Default
`props`	`{}`

Returns:

ReactNode

`FormatLintStatusBar`

Status-bar count of what “Fix all” would clean up; opens the panel.

Parameters:

Name	Type	Default
`props`	`{}`

Returns:

ReactNode

`FormatLintToolbarGroup`

Export-tab group with the button that toggles the format cleanup panel.

Parameters:

Name	Type	Default
`props`	`{}`

Returns:

ReactNode

`FORMAT_LINT_PANEL_ACTION`

Right-panel action id of the format cleanup panel.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

Hooks

`useFormatLint`

The root editor’s suggestions, from the debounced state. Undefined without the plugin.

Parameters:

This function does not accept any parameters.

Returns:

{ installed: boolean; enabled: boolean; stale: boolean; suggestions: FormatSuggestion[]; ignoredSuggestions: FormatSuggestion[]; applicable: FormatSuggestion[]; ignored: number; blocked: string | null; }

`useFormatLintActions`

Actions against the root editor, stable across renders.

Parameters:

This function does not accept any parameters.

Returns:

{ apply: (selection: string[] | "all", force: boolean, only?: FormatRuleId[] | undefined) => FormatApplyResult | null | undefined; refresh: () => boolean | undefined; ... 5 more ...; setEnabled: (on: boolean) => void; }