@codemirror/view 0.19.22 → 0.19.26

package/dist/index.d.ts

@@ -171,6 +171,11 @@ declare abstract class WidgetType {
     events.
     */
     ignoreEvent(_event: Event): boolean;
+    /**
+    This is called when the an instance of the widget is removed
+    from the editor view.
+    */
+    destroy(_dom: HTMLElement): void;
 }
 /**
 A decoration set represents a collection of decorated ranges,
@@ -431,6 +436,7 @@ interface MeasureRequest<T> {
     */
     key?: any;
 }
+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.
@@ -694,6 +700,7 @@ declare class EditorView {
     readonly contentDOM: HTMLElement;
     private announceDOM;
     private plugins;
+    private pluginMap;
     private editorAttrs;
     private contentAttrs;
     private styleModules;
@@ -769,10 +776,18 @@ declare class EditorView {
     plugin<T>(plugin: ViewPlugin<T>): T | null;
     /**
     The top position of the document, in screen coordinates. This
-    may be negative when the editor is scrolled down.
+    may be negative when the editor is scrolled down. Points
+    directly to the top of the first line, not above the padding.
     */
     get documentTop(): number;
     /**
+    Reports the padding above and below the document.
+    */
+    get documentPadding(): {
+        top: number;
+        bottom: number;
+    };
+    /**
     Find the line or block widget at the given vertical position.
     
     By default, this position is interpreted as a screen position,
@@ -1000,7 +1015,7 @@ declare class EditorView {
     mounted in its [document
     root](https://codemirror.net/6/docs/ref/#view.EditorView.constructor^config.root).
     */
-    static styleModule: _codemirror_state.Facet<StyleModule, readonly StyleModule[]>;
+    static styleModule: Facet<StyleModule, readonly StyleModule[]>;
     /**
     Facet that can be used to add DOM event handlers. The value
     should be an object mapping event names to handler functions. The
@@ -1021,7 +1036,7 @@ declare class EditorView {
     content. When one returns true, no further input handlers are
     called and the default behavior is prevented.
     */
-    static inputHandler: _codemirror_state.Facet<(view: EditorView, from: number, to: number, text: string) => boolean, readonly ((view: EditorView, from: number, to: number, text: string) => boolean)[]>;
+    static inputHandler: Facet<(view: EditorView, from: number, to: number, text: string) => boolean, readonly ((view: EditorView, from: number, to: number, text: string) => boolean)[]>;
     /**
     Allows you to provide a function that should be called when the
     library catches an exception from an extension (mostly from view
@@ -1029,12 +1044,12 @@ declare class EditorView {
     from user-code-provided callbacks). This is mostly useful for
     debugging and logging. See [`logException`](https://codemirror.net/6/docs/ref/#view.logException).
     */
-    static exceptionSink: _codemirror_state.Facet<(exception: any) => void, readonly ((exception: any) => void)[]>;
+    static exceptionSink: Facet<(exception: any) => void, readonly ((exception: any) => void)[]>;
     /**
     A facet that can be used to register a function to be called
     every time the view updates.
     */
-    static updateListener: _codemirror_state.Facet<(update: ViewUpdate) => void, readonly ((update: ViewUpdate) => void)[]>;
+    static updateListener: Facet<(update: ViewUpdate) => void, readonly ((update: ViewUpdate) => void)[]>;
     /**
     Facet that controls whether the editor content DOM is editable.
     When its highest-precedence value is `false`, the element will
@@ -1043,33 +1058,33 @@ declare class EditorView {
     even when those are bound to keys or buttons. See the
     [`readOnly`](https://codemirror.net/6/docs/ref/#state.EditorState.readOnly) facet for that.)
     */
-    static editable: _codemirror_state.Facet<boolean, boolean>;
+    static editable: Facet<boolean, boolean>;
     /**
     Allows you to influence the way mouse selection happens. The
     functions in this facet will be called for a `mousedown` event
     on the editor, and can return an object that overrides the way a
     selection is computed from that mouse click or drag.
     */
-    static mouseSelectionStyle: _codemirror_state.Facet<MakeSelectionStyle, readonly MakeSelectionStyle[]>;
+    static mouseSelectionStyle: Facet<MakeSelectionStyle, readonly MakeSelectionStyle[]>;
     /**
     Facet used to configure whether a given selection drag event
     should move or copy the selection. The given predicate will be
     called with the `mousedown` event, and can return `true` when
     the drag should move the content.
     */
-    static dragMovesSelection: _codemirror_state.Facet<(event: MouseEvent) => boolean, readonly ((event: MouseEvent) => boolean)[]>;
+    static dragMovesSelection: Facet<(event: MouseEvent) => boolean, readonly ((event: MouseEvent) => boolean)[]>;
     /**
     Facet used to configure whether a given selecting click adds
     a new range to the existing selection or replaces it entirely.
     */
-    static clickAddsSelectionRange: _codemirror_state.Facet<(event: MouseEvent) => boolean, readonly ((event: MouseEvent) => boolean)[]>;
+    static clickAddsSelectionRange: Facet<(event: MouseEvent) => boolean, readonly ((event: MouseEvent) => boolean)[]>;
     /**
     A facet that determines which [decorations](https://codemirror.net/6/docs/ref/#view.Decoration)
     are shown in the view. See also [view
     plugins](https://codemirror.net/6/docs/ref/#view.EditorView^decorations), which have a separate
     mechanism for providing decorations.
     */
-    static decorations: _codemirror_state.Facet<DecorationSet, readonly DecorationSet[]>;
+    static decorations: Facet<DecorationSet, readonly DecorationSet[]>;
     /**
     Create a theme extension. The first argument can be a
     [`style-mod`](https://github.com/marijnh/style-mod#documentation)
@@ -1107,12 +1122,12 @@ declare class EditorView {
     Facet that provides additional DOM attributes for the editor's
     editable DOM element.
     */
-    static contentAttributes: _codemirror_state.Facet<Attrs, Attrs>;
+    static contentAttributes: Facet<AttrSource, readonly AttrSource[]>;
     /**
     Facet that provides DOM attributes for the editor's outer
     element.
     */
-    static editorAttributes: _codemirror_state.Facet<Attrs, Attrs>;
+    static editorAttributes: Facet<AttrSource, readonly AttrSource[]>;
     /**
     An extension that enables line wrapping in the editor (by
     setting CSS `white-space` to `pre-wrap` in the content).
@@ -1310,10 +1325,10 @@ Configuration options.
 config?: SpecialCharConfig): Extension;
 
 /**
-Returns a plugin that makes sure the content has a bottom margin
-equivalent to the height of the editor, minus one line height, so
-that every line in the document can be scrolled to the top of the
-editor.
+Returns an extension that makes sure the content has a bottom
+margin equivalent to the height of the editor, minus one line
+height, so that every line in the document can be scrolled to the
+top of the editor.
 
 This is only meaningful when the editor is scrollable, and should
 not be enabled in editors that take the size of their content.