Skip to content

Cm5LineWidgetOptions

Unofficial

Options for creating a line widget in CodeMirror 5.

Import:

import type { Cm5LineWidgetOptions } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface Cm5LineWidgetOptions

Properties

PropertyTypeDescription
above?booleanCauses the widget to be placed above instead of below the text of the line.
className?stringAdd an extra CSS class name to the wrapper element.
coverGutter?booleanWhether the widget should cover the gutter.
handleMouseEvents?booleanWhether the editor will capture mouse and drag events occurring in this widget.
insertAt?numberPosition at which to insert the widget (zero for top, N for after Nth widget).
noHScroll?booleanWhether the widget should stay fixed in the face of horizontal scrolling.
showIfHidden?booleanWhen true, will cause the widget to be rendered even if the line is hidden.