@codemirror/view 6.5.1 → 6.7.0

package/dist/index.d.ts

@@ -1366,6 +1366,94 @@ to show when the editor is empty.
 */
 declare function placeholder(content: string | HTMLElement): Extension;
 
+/**
+Markers shown in a [layer](https://codemirror.net/6/docs/ref/#view.layer) must conform to this
+interface. They are created in a measuring phase, and have to
+contain all their positioning information, so that they can be
+drawn without further DOM layout reading.
+
+Markers are automatically absolutely positioned. Their parent
+element has the same top-left corner as the document, so they
+should be positioned relative to the document.
+*/
+interface LayerMarker {
+    /**
+    Compare this marker to a marker of the same type. Used to avoid
+    unnecessary redraws.
+    */
+    eq(other: LayerMarker): boolean;
+    /**
+    Draw the marker to the DOM.
+    */
+    draw(): HTMLElement;
+    /**
+    Update an existing marker of this type to this marker.
+    */
+    update?(dom: HTMLElement, oldMarker: LayerMarker): boolean;
+}
+/**
+Implementation of [`LayerMarker`](https://codemirror.net/6/docs/ref/#view.LayerMarker) that creates
+a rectangle at a given set of coordinates.
+*/
+declare class RectangleMarker implements LayerMarker {
+    private className;
+    private left;
+    private top;
+    private width;
+    private height;
+    /**
+    Create a marker with the given class and dimensions. If `width`
+    is null, the DOM element will get no width style.
+    */
+    constructor(className: string, left: number, top: number, width: number | null, height: number);
+    draw(): HTMLDivElement;
+    update(elt: HTMLElement, prev: RectangleMarker): boolean;
+    private adjust;
+    eq(p: RectangleMarker): boolean;
+    /**
+    Create a set of rectangles for the given selection range,
+    assigning them theclass`className`. Will create a single
+    rectangle for empty ranges, and a set of selection-style
+    rectangles covering the range's content (in a bidi-aware
+    way) for non-empty ones.
+    */
+    static forRange(view: EditorView, className: string, range: SelectionRange): readonly RectangleMarker[];
+}
+interface LayerConfig {
+    /**
+    Determines whether this layer is shown above or below the text.
+    */
+    above: boolean;
+    /**
+    When given, this class is added to the DOM element that will
+    wrap the markers.
+    */
+    class?: string;
+    /**
+    Called on every view update. Returning true triggers a marker
+    update (a call to `markers` and drawing of those markers).
+    */
+    update(update: ViewUpdate, layer: HTMLElement): boolean;
+    /**
+    Build a set of markers for this layer, and measure their
+    dimensions.
+    */
+    markers(view: EditorView): readonly LayerMarker[];
+    /**
+    If given, this is called when the layer is created.
+    */
+    mount?(layer: HTMLElement, view: EditorView): void;
+    /**
+    If given, called when the layer is removed from the editor or
+    the entire editor is destroyed.
+    */
+    destroy?(layer: HTMLElement, view: EditorView): void;
+}
+/**
+Define a layer.
+*/
+declare function layer(config: LayerConfig): Extension;
+
 /**
 Helper class used to make it easier to maintain decorations on
 visible code that matches a given regular expression. To be used
@@ -1584,6 +1672,12 @@ interface TooltipView {
     tooltip.
     */
     positioned?(space: Rect): void;
+    /**
+    By default, the library will restrict the size of tooltips so
+    that they don't stick out of the available space. Set this to
+    false to disable that.
+    */
+    resize?: boolean;
 }
 /**
 Facet to which an extension can add a value to show a tooltip.
@@ -1820,4 +1914,17 @@ line](https://codemirror.net/6/docs/ref/#view.highlightActiveLine).
 */
 declare function highlightActiveLineGutter(): Extension;
 
-export { BidiSpan, BlockInfo, BlockType, Command, DOMEventHandlers, DOMEventMap, Decoration, DecorationSet, Direction, EditorView, EditorViewConfig, GutterMarker, KeyBinding, MatchDecorator, MouseSelectionStyle, Panel, PanelConstructor, PluginSpec, PluginValue, Rect, Tooltip, TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getPanel, getTooltip, gutter, gutterLineClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, hoverTooltip, keymap, lineNumberMarkers, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showPanel, showTooltip, tooltips };
+/**
+Returns an extension that highlights whitespace, adding a
+`cm-highlightSpace` class to stretches of spaces, and a
+`cm-highlightTab` class to individual tab characters. By default,
+the former are shown as faint dots, and the latter as arrows.
+*/
+declare function highlightWhitespace(): Extension;
+/**
+Returns an extension that adds a `cm-trailingSpace` class to all
+trailing whitespace.
+*/
+declare function highlightTrailingWhitespace(): Extension;
+
+export { BidiSpan, BlockInfo, BlockType, Command, DOMEventHandlers, DOMEventMap, Decoration, DecorationSet, Direction, EditorView, EditorViewConfig, GutterMarker, KeyBinding, LayerMarker, MatchDecorator, MouseSelectionStyle, Panel, PanelConstructor, PluginSpec, PluginValue, Rect, RectangleMarker, Tooltip, TooltipView, ViewPlugin, ViewUpdate, WidgetType, closeHoverTooltips, crosshairCursor, drawSelection, dropCursor, getPanel, getTooltip, gutter, gutterLineClass, gutters, hasHoverTooltips, highlightActiveLine, highlightActiveLineGutter, highlightSpecialChars, highlightTrailingWhitespace, highlightWhitespace, hoverTooltip, keymap, layer, lineNumberMarkers, lineNumbers, logException, panels, placeholder, rectangularSelection, repositionTooltips, runScopeHandlers, scrollPastEnd, showPanel, showTooltip, tooltips };