@codemirror/view 6.38.8 → 6.39.0-beta.2

package/dist/index.d.cts

@@ -355,6 +355,39 @@ declare abstract class Decoration extends RangeValue {
     */
     static none: DecorationSet;
 }
+interface BlockWrapperSpec {
+    /**
+    Tag name of the wrapping element.
+    */
+    tagName: string;
+    /**
+    DOM attributes to add to the wrapping element.
+    */
+    attributes?: {
+        [key: string]: string;
+    };
+}
+/**
+A block wrapper defines a DOM node that wraps lines or other block
+wrappers at the top of the document. It affects any line or block
+widget that starts inside its range, including blocks starting
+directly at `from` but not including `to`.
+*/
+declare class BlockWrapper extends RangeValue {
+    readonly tagName: string;
+    readonly attributes: Attrs;
+    private constructor();
+    eq(other: RangeValue): boolean;
+    /**
+    Create a block wrapper object with the given tag name and
+    attributes.
+    */
+    static create(spec: BlockWrapperSpec): BlockWrapper;
+    /**
+    Create a range set from the given block wrapper ranges.
+    */
+    static set(of: Range<BlockWrapper> | readonly Range<BlockWrapper>[], sort?: boolean): RangeSet<BlockWrapper>;
+}
 
 /**
 Command functions are used in key bindings and other types of user
@@ -958,7 +991,7 @@ declare class EditorView {
     meaningful (it may just point before or after a placeholder
     element).
     */
-    domAtPos(pos: number): {
+    domAtPos(pos: number, side?: -1 | 1): {
         node: Node;
         offset: number;
     };
@@ -1261,6 +1294,14 @@ declare class EditorView {
     */
     static decorations: Facet<DecorationSet | ((view: EditorView) => DecorationSet), readonly (DecorationSet | ((view: EditorView) => DecorationSet))[]>;
     /**
+    [Block wrappers](https://codemirror.net/6/docs/ref/#view.BlockWrapper) provide a way to add DOM
+    structure around editor lines and block widgets. Sets of
+    wrappers are provided in a similar way to decorations, and are
+    nested in a similar way when they overlap. A wrapper affects all
+    lines and block widgets that start inside its range.
+    */
+    static blockWrappers: Facet<_codemirror_state.RangeSet<BlockWrapper> | ((view: EditorView) => _codemirror_state.RangeSet<BlockWrapper>), readonly (_codemirror_state.RangeSet<BlockWrapper> | ((view: EditorView) => _codemirror_state.RangeSet<BlockWrapper>))[]>;
+    /**
     Facet that works much like
     [`decorations`](https://codemirror.net/6/docs/ref/#view.EditorView^decorations), but puts its
     inputs at the very bottom of the precedence stack, meaning mark
@@ -2303,4 +2344,4 @@ trailing whitespace.
 */
 declare function highlightTrailingWhitespace(): Extension;
 
-export { BidiSpan, BlockInfo, BlockType, type Command, type DOMEventHandlers, type DOMEventMap, Decoration, type DecorationSet, Direction, EditorView, type EditorViewConfig, GutterMarker, type HoverTooltipSource, type KeyBinding, type LayerMarker, MatchDecorator, type MouseSelectionStyle, type Panel, type PanelConstructor, type PluginSpec, type PluginValue, type Rect, RectangleMarker, type Tooltip, type TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getDialog, getDrawSelectionConfig, getPanel, getTooltip, gutter, gutterLineClass, gutterWidgetClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, highlightTrailingWhitespace, highlightWhitespace, hoverTooltip, keymap, layer, lineNumberMarkers, lineNumberWidgetMarker, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showDialog, showPanel, showTooltip, tooltips };
+export { BidiSpan, BlockInfo, BlockType, BlockWrapper, type Command, type DOMEventHandlers, type DOMEventMap, Decoration, type DecorationSet, Direction, EditorView, type EditorViewConfig, GutterMarker, type HoverTooltipSource, type KeyBinding, type LayerMarker, MatchDecorator, type MouseSelectionStyle, type Panel, type PanelConstructor, type PluginSpec, type PluginValue, type Rect, RectangleMarker, type Tooltip, type TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getDialog, getDrawSelectionConfig, getPanel, getTooltip, gutter, gutterLineClass, gutterWidgetClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, highlightTrailingWhitespace, highlightWhitespace, hoverTooltip, keymap, layer, lineNumberMarkers, lineNumberWidgetMarker, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showDialog, showPanel, showTooltip, tooltips };

package/dist/index.d.ts

@@ -355,6 +355,39 @@ declare abstract class Decoration extends RangeValue {
     */
     static none: DecorationSet;
 }
+interface BlockWrapperSpec {
+    /**
+    Tag name of the wrapping element.
+    */
+    tagName: string;
+    /**
+    DOM attributes to add to the wrapping element.
+    */
+    attributes?: {
+        [key: string]: string;
+    };
+}
+/**
+A block wrapper defines a DOM node that wraps lines or other block
+wrappers at the top of the document. It affects any line or block
+widget that starts inside its range, including blocks starting
+directly at `from` but not including `to`.
+*/
+declare class BlockWrapper extends RangeValue {
+    readonly tagName: string;
+    readonly attributes: Attrs;
+    private constructor();
+    eq(other: RangeValue): boolean;
+    /**
+    Create a block wrapper object with the given tag name and
+    attributes.
+    */
+    static create(spec: BlockWrapperSpec): BlockWrapper;
+    /**
+    Create a range set from the given block wrapper ranges.
+    */
+    static set(of: Range<BlockWrapper> | readonly Range<BlockWrapper>[], sort?: boolean): RangeSet<BlockWrapper>;
+}
 
 /**
 Command functions are used in key bindings and other types of user
@@ -958,7 +991,7 @@ declare class EditorView {
     meaningful (it may just point before or after a placeholder
     element).
     */
-    domAtPos(pos: number): {
+    domAtPos(pos: number, side?: -1 | 1): {
         node: Node;
         offset: number;
     };
@@ -1261,6 +1294,14 @@ declare class EditorView {
     */
     static decorations: Facet<DecorationSet | ((view: EditorView) => DecorationSet), readonly (DecorationSet | ((view: EditorView) => DecorationSet))[]>;
     /**
+    [Block wrappers](https://codemirror.net/6/docs/ref/#view.BlockWrapper) provide a way to add DOM
+    structure around editor lines and block widgets. Sets of
+    wrappers are provided in a similar way to decorations, and are
+    nested in a similar way when they overlap. A wrapper affects all
+    lines and block widgets that start inside its range.
+    */
+    static blockWrappers: Facet<_codemirror_state.RangeSet<BlockWrapper> | ((view: EditorView) => _codemirror_state.RangeSet<BlockWrapper>), readonly (_codemirror_state.RangeSet<BlockWrapper> | ((view: EditorView) => _codemirror_state.RangeSet<BlockWrapper>))[]>;
+    /**
     Facet that works much like
     [`decorations`](https://codemirror.net/6/docs/ref/#view.EditorView^decorations), but puts its
     inputs at the very bottom of the precedence stack, meaning mark
@@ -2303,4 +2344,4 @@ trailing whitespace.
 */
 declare function highlightTrailingWhitespace(): Extension;
 
-export { BidiSpan, BlockInfo, BlockType, type Command, type DOMEventHandlers, type DOMEventMap, Decoration, type DecorationSet, Direction, EditorView, type EditorViewConfig, GutterMarker, type HoverTooltipSource, type KeyBinding, type LayerMarker, MatchDecorator, type MouseSelectionStyle, type Panel, type PanelConstructor, type PluginSpec, type PluginValue, type Rect, RectangleMarker, type Tooltip, type TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getDialog, getDrawSelectionConfig, getPanel, getTooltip, gutter, gutterLineClass, gutterWidgetClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, highlightTrailingWhitespace, highlightWhitespace, hoverTooltip, keymap, layer, lineNumberMarkers, lineNumberWidgetMarker, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showDialog, showPanel, showTooltip, tooltips };
+export { BidiSpan, BlockInfo, BlockType, BlockWrapper, type Command, type DOMEventHandlers, type DOMEventMap, Decoration, type DecorationSet, Direction, EditorView, type EditorViewConfig, GutterMarker, type HoverTooltipSource, type KeyBinding, type LayerMarker, MatchDecorator, type MouseSelectionStyle, type Panel, type PanelConstructor, type PluginSpec, type PluginValue, type Rect, RectangleMarker, type Tooltip, type TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getDialog, getDrawSelectionConfig, getPanel, getTooltip, gutter, gutterLineClass, gutterWidgetClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, highlightTrailingWhitespace, highlightWhitespace, hoverTooltip, keymap, layer, lineNumberMarkers, lineNumberWidgetMarker, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showDialog, showPanel, showTooltip, tooltips };