RegisterInlineTokenRendererParams
Parameters for registerInlineTokenRenderer.
Import:
import type { RegisterInlineTokenRendererParams } from '@mnaoumov/obsidian-lib/inline-token-renderer';Signature:
export interface RegisterInlineTokenRendererParams extends CreateInlineTokenPostProcessorParams, CreateInlineTokenWidgetsExtensionParamsExtends: CreateInlineTokenPostProcessorParams, CreateInlineTokenWidgetsExtensionParams
Properties
| Property | Type | Description |
|---|---|---|
| editorExtensionRegistrar | EditorExtensionRegistrar | The registrar the editor extension is registered through. |
| markdownPostProcessorRegistrar | MarkdownPostProcessorRegistrar | The registrar the Reading-view post processor is registered through. |
| regExp | RegExp | The regular expression a token matches. The g flag is added when missing.(Inherited from CreateInlineTokenPostProcessorParams) |
| render | InlineTokenRenderFunction | Renders a token into its element. (Inherited from CreateInlineTokenPostProcessorParams) |
| shouldDecorate? | (params: InlineTokenShouldDecorateParams) => boolean | Decides whether a match becomes a widget, such as to skip a match inside code. Every match does by default. (Inherited from CreateInlineTokenWidgetsExtensionParams) |
| shouldRevealOnSelection? | boolean | Whether a token shows its source while a selection, the cursor included, touches it. (Inherited from CreateInlineTokenWidgetsExtensionParams) |
| skipSelector? | string | The selector of the elements whose text is never matched. (Inherited from CreateInlineTokenPostProcessorParams) |
| sortOrder? | number | The sort order of the post processor. |
Links to this page: