Cm5LineWidgetOptions

Unofficial

Both Official Unofficial

Both Own Inherited

Options for creating a line widget in CodeMirror 5.

Import:

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

Signature:

export interface Cm5LineWidgetOptions

Properties

	Property	Type	Description
	above?	boolean	Causes the widget to be placed above instead of below the text of the line.
	className?	string	Add an extra CSS class name to the wrapper element.
	coverGutter?	boolean	Whether the widget should cover the gutter.
	handleMouseEvents?	boolean	Whether the editor will capture mouse and drag events occurring in this widget.
	insertAt?	number	Position at which to insert the widget (zero for top, N for after Nth widget).
	noHScroll?	boolean	Whether the widget should stay fixed in the face of horizontal scrolling.
	showIfHidden?	boolean	When true, will cause the widget to be rendered even if the line is hidden.