prosemirror-view 1.23.13 → 1.24.0-beta.3

package/dist/index.d.ts

@@ -0,0 +1,799 @@
+import { EditorState, Transaction, Selection, Plugin } from 'prosemirror-state';
+import { Mark, Node, ParseRule, Slice, ResolvedPos, DOMParser, DOMSerializer } from 'prosemirror-model';
+import { Mapping } from 'prosemirror-transform';
+
+declare type DOMNode = InstanceType<typeof window.Node>;
+
+declare type WidgetConstructor = ((view: EditorView, getPos: () => number | undefined) => DOMNode) | DOMNode;
+/**
+Decoration objects can be provided to the view through the
+[`decorations` prop](https://prosemirror.net/docs/ref/#view.EditorProps.decorations). They come in
+several variants—see the static members of this class for details.
+*/
+declare class Decoration {
+    /**
+    The start position of the decoration.
+    */
+    readonly from: number;
+    /**
+    The end position. Will be the same as `from` for [widget
+    decorations](https://prosemirror.net/docs/ref/#view.Decoration^widget).
+    */
+    readonly to: number;
+    /**
+    Creates a widget decoration, which is a DOM node that's shown in
+    the document at the given position. It is recommended that you
+    delay rendering the widget by passing a function that will be
+    called when the widget is actually drawn in a view, but you can
+    also directly pass a DOM node. `getPos` can be used to find the
+    widget's current document position.
+    */
+    static widget(pos: number, toDOM: WidgetConstructor, spec?: {
+        /**
+        Controls which side of the document position this widget is
+        associated with. When negative, it is drawn before a cursor
+        at its position, and content inserted at that position ends
+        up after the widget. When zero (the default) or positive, the
+        widget is drawn after the cursor and content inserted there
+        ends up before the widget.
+        
+        When there are multiple widgets at a given position, their
+        `side` values determine the order in which they appear. Those
+        with lower values appear first. The ordering of widgets with
+        the same `side` value is unspecified.
+        
+        When `marks` is null, `side` also determines the marks that
+        the widget is wrapped in—those of the node before when
+        negative, those of the node after when positive.
+        */
+        side?: number;
+        /**
+        The precise set of marks to draw around the widget.
+        */
+        marks?: readonly Mark[];
+        /**
+        Can be used to control which DOM events, when they bubble out
+        of this widget, the editor view should ignore.
+        */
+        stopEvent?: (event: Event) => boolean;
+        /**
+        When set (defaults to false), selection changes inside the
+        widget are ignored, and don't cause ProseMirror to try and
+        re-sync the selection with its selection state.
+        */
+        ignoreSelection?: boolean;
+        /**
+        When comparing decorations of this type (in order to decide
+        whether it needs to be redrawn), ProseMirror will by default
+        compare the widget DOM node by identity. If you pass a key,
+        that key will be compared instead, which can be useful when
+        you generate decorations on the fly and don't want to store
+        and reuse DOM nodes. Make sure that any widgets with the same
+        key are interchangeable—if widgets differ in, for example,
+        the behavior of some event handler, they should get
+        different keys.
+        */
+        key?: string;
+        /**
+        Called when the widget decoration is removed as a result of
+        mapping
+        */
+        destroy?: (node: DOMNode) => void;
+    }): Decoration;
+    /**
+    Creates an inline decoration, which adds the given attributes to
+    each inline node between `from` and `to`.
+    */
+    static inline(from: number, to: number, attrs: DecorationAttrs, spec?: {
+        /**
+        Determines how the left side of the decoration is
+        [mapped](https://prosemirror.net/docs/ref/#transform.Position_Mapping) when content is
+        inserted directly at that position. By default, the decoration
+        won't include the new content, but you can set this to `true`
+        to make it inclusive.
+        */
+        inclusiveStart?: boolean;
+        /**
+        Determines how the right side of the decoration is mapped.
+        See
+        [`inclusiveStart`](https://prosemirror.net/docs/ref/#view.Decoration^inline^spec.inclusiveStart).
+        */
+        inclusiveEnd?: boolean;
+    }): Decoration;
+    /**
+    Creates a node decoration. `from` and `to` should point precisely
+    before and after a node in the document. That node, and only that
+    node, will receive the given attributes.
+    */
+    static node(from: number, to: number, attrs: DecorationAttrs, spec?: any): Decoration;
+    /**
+    The spec provided when creating this decoration. Can be useful
+    if you've stored extra information in that object.
+    */
+    get spec(): any;
+}
+/**
+A set of attributes to add to a decorated node. Most properties
+simply directly correspond to DOM attributes of the same name,
+which will be set to the property's value. These are exceptions:
+*/
+declare type DecorationAttrs = {
+    /**
+    When non-null, the target node is wrapped in a DOM element of
+    this type (and the other attributes are applied to this element).
+    */
+    nodeName?: string;
+    /**
+    A CSS class name or a space-separated set of class names to be
+    _added_ to the classes that the node already had.
+    */
+    class?: string;
+    /**
+    A string of CSS to be _added_ to the node's existing `style` property.
+    */
+    style?: string;
+    /**
+    Any other properties are treated as regular DOM attributes.
+    */
+    [attribute: string]: string | undefined;
+};
+/**
+An object that can [provide](https://prosemirror.net/docs/ref/#view.EditorProps.decorations)
+decorations. Implemented by [`DecorationSet`](https://prosemirror.net/docs/ref/#view.DecorationSet),
+and passed to [node views](https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews).
+*/
+interface DecorationSource {
+    /**
+    Map the set of decorations in response to a change in the
+    document.
+    */
+    map: (mapping: Mapping, node: Node) => DecorationSource;
+}
+/**
+A collection of [decorations](https://prosemirror.net/docs/ref/#view.Decoration), organized in such
+a way that the drawing algorithm can efficiently use and compare
+them. This is a persistent data structure—it is not modified,
+updates create a new value.
+*/
+declare class DecorationSet implements DecorationSource {
+    /**
+    Create a set of decorations, using the structure of the given
+    document.
+    */
+    static create(doc: Node, decorations: Decoration[]): DecorationSet;
+    /**
+    Find all decorations in this set which touch the given range
+    (including decorations that start or end directly at the
+    boundaries) and match the given predicate on their spec. When
+    `start` and `end` are omitted, all decorations in the set are
+    considered. When `predicate` isn't given, all decorations are
+    assumed to match.
+    */
+    find(start?: number, end?: number, predicate?: (spec: any) => boolean): Decoration[];
+    private findInner;
+    /**
+    Map the set of decorations in response to a change in the
+    document.
+    */
+    map(mapping: Mapping, doc: Node, options?: {
+        /**
+        When given, this function will be called for each decoration
+        that gets dropped as a result of the mapping, passing the
+        spec of that decoration.
+        */
+        onRemove?: (decorationSpec: any) => void;
+    }): DecorationSet;
+    /**
+    Add the given array of decorations to the ones in the set,
+    producing a new set. Needs access to the current document to
+    create the appropriate tree structure.
+    */
+    add(doc: Node, decorations: Decoration[]): DecorationSet;
+    private addInner;
+    /**
+    Create a new set that contains the decorations in this set, minus
+    the ones in the given array.
+    */
+    remove(decorations: Decoration[]): DecorationSet;
+    private removeInner;
+    /**
+    The empty set of decorations.
+    */
+    static empty: DecorationSet;
+}
+
+declare global {
+    interface Node {
+        pmViewDesc?: ViewDesc;
+    }
+}
+/**
+By default, document nodes are rendered using the result of the
+[`toDOM`](https://prosemirror.net/docs/ref/#model.NodeSpec.toDOM) method of their spec, and managed
+entirely by the editor. For some use cases, such as embedded
+node-specific editing interfaces, you want more control over
+the behavior of a node's in-editor representation, and need to
+[define](https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews) a custom node view.
+
+Mark views only support `dom` and `contentDOM`, and don't support
+any of the node view methods.
+
+Objects returned as node views must conform to this interface.
+*/
+interface NodeView {
+    /**
+    The outer DOM node that represents the document node.
+    */
+    dom: DOMNode;
+    /**
+    The DOM node that should hold the node's content. Only meaningful
+    if the node view also defines a `dom` property and if its node
+    type is not a leaf node type. When this is present, ProseMirror
+    will take care of rendering the node's children into it. When it
+    is not present, the node view itself is responsible for rendering
+    (or deciding not to render) its child nodes.
+    */
+    contentDOM?: HTMLElement | null;
+    /**
+    When given, this will be called when the view is updating itself.
+    It will be given a node (possibly of a different type), an array
+    of active decorations around the node (which are automatically
+    drawn, and the node view may ignore if it isn't interested in
+    them), and a [decoration source](https://prosemirror.net/docs/ref/#view.DecorationSource) that
+    represents any decorations that apply to the content of the node
+    (which again may be ignored). It should return true if it was
+    able to update to that node, and false otherwise. If the node
+    view has a `contentDOM` property (or no `dom` property), updating
+    its child nodes will be handled by ProseMirror.
+    */
+    update?: (node: Node, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean;
+    /**
+    Can be used to override the way the node's selected status (as a
+    node selection) is displayed.
+    */
+    selectNode?: () => void;
+    /**
+    When defining a `selectNode` method, you should also provide a
+    `deselectNode` method to remove the effect again.
+    */
+    deselectNode?: () => void;
+    /**
+    This will be called to handle setting the selection inside the
+    node. The `anchor` and `head` positions are relative to the start
+    of the node. By default, a DOM selection will be created between
+    the DOM positions corresponding to those positions, but if you
+    override it you can do something else.
+    */
+    setSelection?: (anchor: number, head: number, root: Document | ShadowRoot) => void;
+    /**
+    Can be used to prevent the editor view from trying to handle some
+    or all DOM events that bubble up from the node view. Events for
+    which this returns true are not handled by the editor.
+    */
+    stopEvent?: (event: Event) => boolean;
+    /**
+    Called when a DOM
+    [mutation](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)
+    or a selection change happens within the view. When the change is
+    a selection change, the record will have a `type` property of
+    `"selection"` (which doesn't occur for native mutation records).
+    Return false if the editor should re-read the selection or
+    re-parse the range around the mutation, true if it can safely be
+    ignored.
+    */
+    ignoreMutation?: (mutation: MutationRecord) => boolean;
+    /**
+    Called when the node view is removed from the editor or the whole
+    editor is destroyed. (Not available for marks.)
+    */
+    destroy?: () => void;
+}
+declare class ViewDesc {
+    parent: ViewDesc | undefined;
+    children: ViewDesc[];
+    dom: DOMNode;
+    contentDOM: HTMLElement | null;
+    dirty: number;
+    node: Node | null;
+    constructor(parent: ViewDesc | undefined, children: ViewDesc[], dom: DOMNode, contentDOM: HTMLElement | null);
+    matchesWidget(widget: Decoration): boolean;
+    matchesMark(mark: Mark): boolean;
+    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
+    matchesHack(nodeName: string): boolean;
+    parseRule(): ParseRule | null;
+    stopEvent(event: Event): boolean;
+    get size(): number;
+    get border(): number;
+    destroy(): void;
+    posBeforeChild(child: ViewDesc): number;
+    get posBefore(): number;
+    get posAtStart(): number;
+    get posAfter(): number;
+    get posAtEnd(): number;
+    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
+    nearestDesc(dom: DOMNode, onlyNodes?: boolean): ViewDesc | undefined;
+    getDesc(dom: DOMNode): ViewDesc | undefined;
+    posFromDOM(dom: DOMNode, offset: number, bias: number): number;
+    descAt(pos: number): ViewDesc | undefined;
+    domFromPos(pos: number, side: number): {
+        node: DOMNode;
+        offset: number;
+    };
+    parseRange(from: number, to: number, base?: number): {
+        node: DOMNode;
+        from: number;
+        to: number;
+        fromOffset: number;
+        toOffset: number;
+    };
+    emptyChildAt(side: number): boolean;
+    domAfterPos(pos: number): DOMNode;
+    setSelection(anchor: number, head: number, root: Document | ShadowRoot, force?: boolean): void;
+    ignoreMutation(mutation: MutationRecord): boolean;
+    get contentLost(): boolean | null;
+    markDirty(from: number, to: number): void;
+    markParentsDirty(): void;
+    get domAtom(): boolean;
+    get ignoreForCoords(): boolean;
+}
+
+/**
+An editor view manages the DOM structure that represents an
+editable document. Its state and behavior are determined by its
+[props](https://prosemirror.net/docs/ref/#view.DirectEditorProps).
+*/
+declare class EditorView {
+    private _props;
+    private directPlugins;
+    private _root;
+    private mounted;
+    private prevDirectPlugins;
+    private pluginViews;
+    /**
+    The view's current [state](https://prosemirror.net/docs/ref/#state.EditorState).
+    */
+    state: EditorState;
+    /**
+    Create a view. `place` may be a DOM node that the editor should
+    be appended to, a function that will place it into the document,
+    or an object whose `mount` property holds the node to use as the
+    document container. If it is `null`, the editor will not be
+    added to the document.
+    */
+    constructor(place: null | DOMNode | ((editor: HTMLElement) => void) | {
+        mount: HTMLElement;
+    }, props: DirectEditorProps);
+    /**
+    An editable DOM node containing the document. (You probably
+    should not directly interfere with its content.)
+    */
+    readonly dom: HTMLElement;
+    /**
+    Indicates whether the editor is currently [editable](https://prosemirror.net/docs/ref/#view.EditorProps.editable).
+    */
+    editable: boolean;
+    /**
+    When editor content is being dragged, this object contains
+    information about the dragged slice and whether it is being
+    copied or moved. At any other time, it is null.
+    */
+    dragging: null | {
+        slice: Slice;
+        move: boolean;
+    };
+    /**
+    Holds `true` when a
+    [composition](https://w3c.github.io/uievents/#events-compositionevents)
+    is active.
+    */
+    get composing(): boolean;
+    /**
+    The view's current [props](https://prosemirror.net/docs/ref/#view.EditorProps).
+    */
+    get props(): DirectEditorProps;
+    /**
+    Update the view's props. Will immediately cause an update to
+    the DOM.
+    */
+    update(props: DirectEditorProps): void;
+    /**
+    Update the view by updating existing props object with the object
+    given as argument. Equivalent to `view.update(Object.assign({},
+    view.props, props))`.
+    */
+    setProps(props: Partial<DirectEditorProps>): void;
+    /**
+    Update the editor's `state` prop, without touching any of the
+    other props.
+    */
+    updateState(state: EditorState): void;
+    private updateStateInner;
+    private destroyPluginViews;
+    private updatePluginViews;
+    /**
+    Goes over the values of a prop, first those provided directly,
+    then those from plugins given to the view, then from plugins in
+    the state (in order), and calls `f` every time a non-undefined
+    value is found. When `f` returns a truthy value, that is
+    immediately returned. When `f` isn't provided, it is treated as
+    the identity function (the prop value is returned directly).
+    */
+    someProp<PropName extends keyof EditorProps, Result>(propName: PropName, f: (value: NonNullable<EditorProps[PropName]>) => Result): Result | undefined;
+    someProp<PropName extends keyof EditorProps>(propName: PropName): NonNullable<EditorProps[PropName]> | undefined;
+    /**
+    Query whether the view has focus.
+    */
+    hasFocus(): boolean;
+    /**
+    Focus the editor.
+    */
+    focus(): void;
+    /**
+    Get the document root in which the editor exists. This will
+    usually be the top-level `document`, but might be a [shadow
+    DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Shadow_DOM)
+    root if the editor is inside one.
+    */
+    get root(): Document | ShadowRoot;
+    /**
+    Given a pair of viewport coordinates, return the document
+    position that corresponds to them. May return null if the given
+    coordinates aren't inside of the editor. When an object is
+    returned, its `pos` property is the position nearest to the
+    coordinates, and its `inside` property holds the position of the
+    inner node that the position falls inside of, or -1 if it is at
+    the top level, not in any node.
+    */
+    posAtCoords(coords: {
+        left: number;
+        top: number;
+    }): {
+        pos: number;
+        inside: number;
+    } | null;
+    /**
+    Returns the viewport rectangle at a given document position.
+    `left` and `right` will be the same number, as this returns a
+    flat cursor-ish rectangle. If the position is between two things
+    that aren't directly adjacent, `side` determines which element
+    is used. When < 0, the element before the position is used,
+    otherwise the element after.
+    */
+    coordsAtPos(pos: number, side?: number): {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+    /**
+    Find the DOM position that corresponds to the given document
+    position. When `side` is negative, find the position as close as
+    possible to the content before the position. When positive,
+    prefer positions close to the content after the position. When
+    zero, prefer as shallow a position as possible.
+    
+    Note that you should **not** mutate the editor's internal DOM,
+    only inspect it (and even that is usually not necessary).
+    */
+    domAtPos(pos: number, side?: number): {
+        node: DOMNode;
+        offset: number;
+    };
+    /**
+    Find the DOM node that represents the document node after the
+    given position. May return `null` when the position doesn't point
+    in front of a node or if the node is inside an opaque node view.
+    
+    This is intended to be able to call things like
+    `getBoundingClientRect` on that DOM node. Do **not** mutate the
+    editor DOM directly, or add styling this way, since that will be
+    immediately overriden by the editor as it redraws the node.
+    */
+    nodeDOM(pos: number): DOMNode | null;
+    /**
+    Find the document position that corresponds to a given DOM
+    position. (Whenever possible, it is preferable to inspect the
+    document structure directly, rather than poking around in the
+    DOM, but sometimes—for example when interpreting an event
+    target—you don't have a choice.)
+    
+    The `bias` parameter can be used to influence which side of a DOM
+    node to use when the position is inside a leaf node.
+    */
+    posAtDOM(node: DOMNode, offset: number, bias?: number): number;
+    /**
+    Find out whether the selection is at the end of a textblock when
+    moving in a given direction. When, for example, given `"left"`,
+    it will return true if moving left from the current cursor
+    position would leave that position's parent textblock. Will apply
+    to the view's current state by default, but it is possible to
+    pass a different state.
+    */
+    endOfTextblock(dir: "up" | "down" | "left" | "right" | "forward" | "backward", state?: EditorState): boolean;
+    /**
+    Removes the editor from the DOM and destroys all [node
+    views](https://prosemirror.net/docs/ref/#view.NodeView).
+    */
+    destroy(): void;
+    /**
+    This is true when the view has been
+    [destroyed](https://prosemirror.net/docs/ref/#view.EditorView.destroy) (and thus should not be
+    used anymore).
+    */
+    get isDestroyed(): boolean;
+    /**
+    Used for testing.
+    */
+    dispatchEvent(event: Event): void;
+    /**
+    Dispatch a transaction. Will call
+    [`dispatchTransaction`](https://prosemirror.net/docs/ref/#view.DirectEditorProps.dispatchTransaction)
+    when given, and otherwise defaults to applying the transaction to
+    the current state and calling
+    [`updateState`](https://prosemirror.net/docs/ref/#view.EditorView.updateState) with the result.
+    This method is bound to the view instance, so that it can be
+    easily passed around.
+    */
+    dispatch(tr: Transaction): void;
+}
+declare type NodeViewConstructor = (node: Node, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
+/**
+Helper type that maps event names to event object types, but
+includes events that TypeScript's HTMLElementEventMap doesn't know
+about.
+*/
+interface DOMEventMap extends HTMLElementEventMap {
+    [event: string]: Event;
+}
+/**
+Props are configuration values that can be passed to an editor view
+or included in a plugin. This interface lists the supported props.
+
+The various event-handling functions may all return `true` to
+indicate that they handled the given event. The view will then take
+care to call `preventDefault` on the event, except with
+`handleDOMEvents`, where the handler itself is responsible for that.
+
+How a prop is resolved depends on the prop. Handler functions are
+called one at a time, starting with the base props and then
+searching through the plugins (in order of appearance) until one of
+them returns true. For some props, the first plugin that yields a
+value gets precedence.
+*/
+interface EditorProps {
+    /**
+    Can be an object mapping DOM event type names to functions that
+    handle them. Such functions will be called before any handling
+    ProseMirror does of events fired on the editable DOM element.
+    Contrary to the other event handling props, when returning true
+    from such a function, you are responsible for calling
+    `preventDefault` yourself (or not, if you want to allow the
+    default behavior).
+    */
+    handleDOMEvents?: {
+        [event in string]: (view: EditorView, event: DOMEventMap[event]) => boolean | void;
+    };
+    /**
+    Called when the editor receives a `keydown` event.
+    */
+    handleKeyDown?: (view: EditorView, event: KeyboardEvent) => boolean | void;
+    /**
+    Handler for `keypress` events.
+    */
+    handleKeyPress?: (view: EditorView, event: KeyboardEvent) => boolean | void;
+    /**
+    Whenever the user directly input text, this handler is called
+    before the input is applied. If it returns `true`, the default
+    behavior of actually inserting the text is suppressed.
+    */
+    handleTextInput?: (view: EditorView, from: number, to: number, text: string) => boolean | void;
+    /**
+    Called for each node around a click, from the inside out. The
+    `direct` flag will be true for the inner node.
+    */
+    handleClickOn?: (view: EditorView, pos: number, node: Node, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+    /**
+    Called when the editor is clicked, after `handleClickOn` handlers
+    have been called.
+    */
+    handleClick?: (view: EditorView, pos: number, event: MouseEvent) => boolean | void;
+    /**
+    Called for each node around a double click.
+    */
+    handleDoubleClickOn?: (view: EditorView, pos: number, node: Node, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+    /**
+    Called when the editor is double-clicked, after `handleDoubleClickOn`.
+    */
+    handleDoubleClick?: (view: EditorView, pos: number, event: MouseEvent) => boolean | void;
+    /**
+    Called for each node around a triple click.
+    */
+    handleTripleClickOn?: (view: EditorView, pos: number, node: Node, nodePos: number, event: MouseEvent, direct: boolean) => boolean | void;
+    /**
+    Called when the editor is triple-clicked, after `handleTripleClickOn`.
+    */
+    handleTripleClick?: (view: EditorView, pos: number, event: MouseEvent) => boolean | void;
+    /**
+    Can be used to override the behavior of pasting. `slice` is the
+    pasted content parsed by the editor, but you can directly access
+    the event to get at the raw content.
+    */
+    handlePaste?: (view: EditorView, event: ClipboardEvent, slice: Slice) => boolean | void;
+    /**
+    Called when something is dropped on the editor. `moved` will be
+    true if this drop moves from the current selection (which should
+    thus be deleted).
+    */
+    handleDrop?: (view: EditorView, event: MouseEvent, slice: Slice, moved: boolean) => boolean | void;
+    /**
+    Called when the view, after updating its state, tries to scroll
+    the selection into view. A handler function may return false to
+    indicate that it did not handle the scrolling and further
+    handlers or the default behavior should be tried.
+    */
+    handleScrollToSelection?: (view: EditorView) => boolean;
+    /**
+    Can be used to override the way a selection is created when
+    reading a DOM selection between the given anchor and head.
+    */
+    createSelectionBetween?: (view: EditorView, anchor: ResolvedPos, head: ResolvedPos) => Selection | null;
+    /**
+    The [parser](https://prosemirror.net/docs/ref/#model.DOMParser) to use when reading editor changes
+    from the DOM. Defaults to calling
+    [`DOMParser.fromSchema`](https://prosemirror.net/docs/ref/#model.DOMParser^fromSchema) on the
+    editor's schema.
+    */
+    domParser?: DOMParser;
+    /**
+    Can be used to transform pasted HTML text, _before_ it is parsed,
+    for example to clean it up.
+    */
+    transformPastedHTML?: (html: string) => string;
+    /**
+    The [parser](https://prosemirror.net/docs/ref/#model.DOMParser) to use when reading content from
+    the clipboard. When not given, the value of the
+    [`domParser`](https://prosemirror.net/docs/ref/#view.EditorProps.domParser) prop is used.
+    */
+    clipboardParser?: DOMParser;
+    /**
+    Transform pasted plain text. The `plain` flag will be true when
+    the text is pasted as plain text.
+    */
+    transformPastedText?: (text: string, plain: boolean) => string;
+    /**
+    A function to parse text from the clipboard into a document
+    slice. Called after
+    [`transformPastedText`](https://prosemirror.net/docs/ref/#view.EditorProps.transformPastedText).
+    The default behavior is to split the text into lines, wrap them
+    in `<p>` tags, and call
+    [`clipboardParser`](https://prosemirror.net/docs/ref/#view.EditorProps.clipboardParser) on it.
+    The `plain` flag will be true when the text is pasted as plain text.
+    */
+    clipboardTextParser?: (text: string, $context: ResolvedPos, plain: boolean) => Slice;
+    /**
+    Can be used to transform pasted content before it is applied to
+    the document.
+    */
+    transformPasted?: (slice: Slice) => Slice;
+    /**
+    Allows you to pass custom rendering and behavior logic for nodes
+    and marks. Should map node and mark names to constructor
+    functions that produce a [`NodeView`](https://prosemirror.net/docs/ref/#view.NodeView) object
+    implementing the node's display behavior. For nodes, the third
+    argument `getPos` is a function that can be called to get the
+    node's current position, which can be useful when creating
+    transactions to update it. For marks, the third argument is a
+    boolean that indicates whether the mark's content is inline.
+    
+    `decorations` is an array of node or inline decorations that are
+    active around the node. They are automatically drawn in the
+    normal way, and you will usually just want to ignore this, but
+    they can also be used as a way to provide context information to
+    the node view without adding it to the document itself.
+    
+    `innerDecorations` holds the decorations for the node's content.
+    You can safely ignore this if your view has no content or a
+    `contentDOM` property, since the editor will draw the decorations
+    on the content. But if you, for example, want to create a nested
+    editor with the content, it may make sense to provide it with the
+    inner decorations.
+    */
+    nodeViews?: {
+        [node: string]: NodeViewConstructor;
+    };
+    /**
+    The DOM serializer to use when putting content onto the
+    clipboard. If not given, the result of
+    [`DOMSerializer.fromSchema`](https://prosemirror.net/docs/ref/#model.DOMSerializer^fromSchema)
+    will be used. This object will only have its
+    [`serializeFragment`](https://prosemirror.net/docs/ref/#model.DOMSerializer.serializeFragment)
+    method called, and you may provide an alternative object type
+    implementing a compatible method.
+    */
+    clipboardSerializer?: DOMSerializer;
+    /**
+    A function that will be called to get the text for the current
+    selection when copying text to the clipboard. By default, the
+    editor will use [`textBetween`](https://prosemirror.net/docs/ref/#model.Node.textBetween) on the
+    selected range.
+    */
+    clipboardTextSerializer?: (content: Slice) => string;
+    /**
+    A set of [document decorations](https://prosemirror.net/docs/ref/#view.Decoration) to show in the
+    view.
+    */
+    decorations?: (state: EditorState) => DecorationSource | null;
+    /**
+    When this returns false, the content of the view is not directly
+    editable.
+    */
+    editable?: (state: EditorState) => boolean;
+    /**
+    Control the DOM attributes of the editable element. May be either
+    an object or a function going from an editor state to an object.
+    By default, the element will get a class `"ProseMirror"`, and
+    will have its `contentEditable` attribute determined by the
+    [`editable` prop](https://prosemirror.net/docs/ref/#view.EditorProps.editable). Additional classes
+    provided here will be added to the class. For other attributes,
+    the value provided first (as in
+    [`someProp`](https://prosemirror.net/docs/ref/#view.EditorView.someProp)) will be used.
+    */
+    attributes?: {
+        [name: string]: string;
+    } | ((state: EditorState) => {
+        [name: string]: string;
+    });
+    /**
+    Determines the distance (in pixels) between the cursor and the
+    end of the visible viewport at which point, when scrolling the
+    cursor into view, scrolling takes place. Defaults to 0.
+    */
+    scrollThreshold?: number | {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    /**
+    Determines the extra space (in pixels) that is left above or
+    below the cursor when it is scrolled into view. Defaults to 5.
+    */
+    scrollMargin?: number | {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+}
+/**
+The props object given directly to the editor view supports some
+fields that can't be used in plugins:
+*/
+interface DirectEditorProps extends EditorProps {
+    /**
+    The current state of the editor.
+    */
+    state: EditorState;
+    /**
+    A set of plugins to use in the view, applying their [plugin
+    view](https://prosemirror.net/docs/ref/#state.PluginSpec.view) and
+    [props](https://prosemirror.net/docs/ref/#state.PluginSpec.props). Passing plugins with a state
+    component (a [state field](https://prosemirror.net/docs/ref/#state.PluginSpec.state) field or a
+    [transaction](https://prosemirror.net/docs/ref/#state.PluginSpec.filterTransaction) filter or
+    appender) will result in an error, since such plugins must be
+    present in the state to work.
+    */
+    plugins?: readonly Plugin[];
+    /**
+    The callback over which to send transactions (state updates)
+    produced by the view. If you specify this, you probably want to
+    make sure this ends up calling the view's
+    [`updateState`](https://prosemirror.net/docs/ref/#view.EditorView.updateState) method with a new
+    state that has the transaction
+    [applied](https://prosemirror.net/docs/ref/#state.EditorState.apply). The callback will be bound to have
+    the view instance as its `this` binding.
+    */
+    dispatchTransaction?: (tr: Transaction) => void;
+}
+
+export { DOMEventMap, Decoration, DecorationAttrs, DecorationSet, DecorationSource, DirectEditorProps, EditorProps, EditorView, NodeView };