@codemirror/view 6.12.0 → 6.13.1

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as _codemirror_state from '@codemirror/state';
 import { RangeSet, RangeValue, Range, EditorState, Extension, Transaction, ChangeSet, EditorSelection, EditorStateConfig, TransactionSpec, SelectionRange, Line, StateEffect, Facet } from '@codemirror/state';
 import { StyleModule, StyleSpec } from 'style-mod';
 
-type Attrs = {
+declare type Attrs = {
     [name: string]: string;
 };
 
@@ -15,7 +15,7 @@ interface Rect {
     readonly top: number;
     readonly bottom: number;
 }
-type ScrollStrategy = "nearest" | "start" | "end" | "center";
+declare type ScrollStrategy = "nearest" | "start" | "end" | "center";
 
 interface MarkDecorationSpec {
     /**
@@ -70,7 +70,12 @@ interface WidgetDecorationSpec {
     cursor is on the same position. Otherwise, it'll be drawn before
     it. When multiple widgets sit at the same position, their `side`
     values will determine their ordering—those with a lower value
-    come first. Defaults to 0.
+    come first. Defaults to 0. May not be more than 10000 or less
+    than -10000.
+    
+    Block widgets are always drawn before inline widgets when side
+    is non-positive, and after them when side is positive,
+    regardless of the value of `side`.
     */
     side?: number;
     /**
@@ -174,6 +179,13 @@ declare abstract class WidgetType {
     */
     get estimatedHeight(): number;
     /**
+    For inline widgets that are displayed inline (as opposed to
+    `inline-block`) and introduce line breaks (through `<br>` tags
+    or textual newlines), this must indicate the amount of line
+    breaks they introduce. Defaults to 0.
+    */
+    get lineBreaks(): number;
+    /**
     Can be used to configure which kinds of events inside the widget
     should be ignored by the editor. The default is to ignore all
     events.
@@ -198,7 +210,7 @@ A decoration set represents a collection of decorated ranges,
 organized for efficient access and mapping. See
 [`RangeSet`](https://codemirror.net/6/docs/ref/#state.RangeSet) for its methods.
 */
-type DecorationSet = RangeSet<Decoration>;
+declare type DecorationSet = RangeSet<Decoration>;
 /**
 The different types of blocks that can occur in an editor view.
 */
@@ -297,7 +309,7 @@ apply to the editor, and if it can, perform it as a side effect
 (which usually means [dispatching](https://codemirror.net/6/docs/ref/#view.EditorView.dispatch) a
 transaction) and return `true`.
 */
-type Command = (target: EditorView) => boolean;
+declare type Command = (target: EditorView) => boolean;
 /**
 Log or report an unhandled exception in client code. Should
 probably only be used by extension code that allows client code to
@@ -399,7 +411,7 @@ interface MeasureRequest<T> {
     */
     key?: any;
 }
-type AttrSource = Attrs | ((view: EditorView) => Attrs | null);
+declare type AttrSource = Attrs | ((view: EditorView) => Attrs | null);
 /**
 View [plugins](https://codemirror.net/6/docs/ref/#view.ViewPlugin) are given instances of this
 class, which describe what happened, whenever the view is updated.
@@ -488,7 +500,7 @@ interface MouseSelectionStyle {
     */
     update: (update: ViewUpdate) => boolean | void;
 }
-type MakeSelectionStyle = (view: EditorView, event: MouseEvent) => MouseSelectionStyle | null;
+declare type MakeSelectionStyle = (view: EditorView, event: MouseEvent) => MouseSelectionStyle | null;
 
 /**
 Record used to represent information about a block-level element
@@ -518,11 +530,6 @@ declare class BlockInfo {
     */
     get type(): BlockType | readonly BlockInfo[];
     /**
-    If this is a widget block, this will return the widget
-    associated with it.
-    */
-    get widget(): WidgetType | null;
-    /**
     The end of the element as a document position.
     */
     get to(): number;
@@ -530,6 +537,16 @@ declare class BlockInfo {
     The bottom position of the element.
     */
     get bottom(): number;
+    /**
+    If this is a widget block, this will return the widget
+    associated with it.
+    */
+    get widget(): WidgetType | null;
+    /**
+    If this is a textblock, this holds the number of line breaks
+    that appear in widgets inside the block.
+    */
+    get widgetLineBreaks(): number;
 }
 
 /**
@@ -1183,7 +1200,7 @@ to hold the appropriate event object type. For unknown events, it
 is inferred to `any`, and should be explicitly set if you want type
 checking.
 */
-type DOMEventHandlers<This> = {
+declare type DOMEventHandlers<This> = {
     [event in keyof DOMEventMap]?: (this: This, event: DOMEventMap[event], view: EditorView) => boolean | void;
 };
 
@@ -1285,7 +1302,7 @@ handlers handled it.
 */
 declare function runScopeHandlers(view: EditorView, event: KeyboardEvent, scope: string): boolean;
 
-type SelectionConfig = {
+declare type SelectionConfig = {
     /**
     The length of a full cursor blink cycle, in milliseconds.
     Defaults to 1200. Can be set to 0 to disable blinking.
@@ -1751,7 +1768,7 @@ invalidate the existing tooltip positions.
 */
 declare function repositionTooltips(view: EditorView): void;
 
-type PanelConfig = {
+declare type PanelConfig = {
     /**
     By default, panels will be placed inside the editor's DOM
     structure. You can use this option to override where panels with
@@ -1805,7 +1822,7 @@ declare function getPanel(view: EditorView, panel: PanelConstructor): Panel | nu
 A function that initializes a panel. Used in
 [`showPanel`](https://codemirror.net/6/docs/ref/#view.showPanel).
 */
-type PanelConstructor = (view: EditorView) => Panel;
+declare type PanelConstructor = (view: EditorView) => Panel;
 /**
 Opening a panel is done by providing a constructor function for
 the panel through this facet. (The panel is closed again when its
@@ -1846,7 +1863,7 @@ Markers given to this facet should _only_ define an
 in all gutters for the line).
 */
 declare const gutterLineClass: Facet<RangeSet<GutterMarker>, readonly RangeSet<GutterMarker>[]>;
-type Handlers = {
+declare type Handlers = {
     [event: string]: (view: EditorView, line: BlockInfo, event: Event) => boolean;
 };
 interface GutterConfig {