Skip to content

RegisterInlineTokenRendererParams

Parameters for registerInlineTokenRenderer.

Import:

import type { RegisterInlineTokenRendererParams } from '@mnaoumov/obsidian-lib/inline-token-renderer';

Signature:

export interface RegisterInlineTokenRendererParams extends CreateInlineTokenPostProcessorParams, CreateInlineTokenWidgetsExtensionParams

Extends: CreateInlineTokenPostProcessorParams, CreateInlineTokenWidgetsExtensionParams

Properties

PropertyTypeDescription
editorExtensionRegistrarEditorExtensionRegistrarThe registrar the editor extension is registered through.
markdownPostProcessorRegistrarMarkdownPostProcessorRegistrarThe registrar the Reading-view post processor is registered through.
regExpRegExpThe regular expression a token matches. The g flag is added when missing.
(Inherited from CreateInlineTokenPostProcessorParams)
renderInlineTokenRenderFunctionRenders a token into its element.
(Inherited from CreateInlineTokenPostProcessorParams)
shouldDecorate?(params: InlineTokenShouldDecorateParams) => booleanDecides whether a match becomes a widget, such as to skip a match inside code. Every match does by default.
(Inherited from CreateInlineTokenWidgetsExtensionParams)
shouldRevealOnSelection?booleanWhether a token shows its source while a selection, the cursor included, touches it.
(Inherited from CreateInlineTokenWidgetsExtensionParams)
skipSelector?stringThe selector of the elements whose text is never matched.
(Inherited from CreateInlineTokenPostProcessorParams)
sortOrder?numberThe sort order of the post processor.

Links to this page: