Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Classes

ListDOMSerializer

A custom DOM serializer class that can serialize flat list nodes into native HTML list elements (i.e. <ul> and <ol>).

ProsemirrorNode

This class represents a node in the tree that makes up a ProseMirror document. So a document is an instance of Node, with children that are also instances of Node.

§Variables

backspaceCommand

Keybinding for Backspace. It's chained with following commands:

createListNodeView

A simple node view that is used to render the list node. It ensures that the list node get updated when its marker styling should changes.

defaultListClickHandler
deleteCommand

Keybinding for Delete. It's chained with following commands:

enterCommand

Keybinding for Enter. It's chained with following commands:

enterWithoutLift

This command has the same behavior as the Enter keybinding from prosemirror-commands, but without the liftEmptyBlock command.

flatListGroup

The default group name for list nodes. This is used to find the list node type from the schema.

joinCollapsedListBackward

If the selection is empty and at the start of a block, and there is a collapsed list node right before the cursor, move current block and append it to the first child of the collapsed list node (i.e. skip the hidden content).

joinListUp

If the text cursor is at the start of the first child of a list node, lift all content inside the list. If the text cursor is at the start of the last child of a list node, lift this child.

listInputRules

All input rules for lists.

listKeymap

Returns an object containing the keymap for the list commands.

protectCollapsed

This command will protect the collapsed items from being deleted.

§Functions

createDedentListCommand

Returns a command function that decreases the indentation of selected list nodes.

createIndentListCommand

Returns a command function that increases the indentation of selected list nodes.

createListClipboardPlugin

Serialize list nodes into native HTML list elements (i.e. <ul>, <ol>) to clipboard. See ListDOMSerializer.

createListEventPlugin

Handle DOM events for list.

createListPlugins

This function returns an array of plugins that are required for list to work.

createListRenderingPlugin

Handle the list node rendering.

createListSpec

Return the spec for list node.

createMoveListCommand

Returns a command function that moves up or down selected list nodes.

createParseDomRules

Returns a set of rules for parsing HTML into ProseMirror list nodes.

createSafariInputMethodWorkaroundPlugin

Return a plugin as a workaround for a bug in Safari that causes the composition based IME to remove the empty HTML element with CSS position: relative.

createSplitListCommand

Returns a command that split the current list node.

createToggleCollapsedCommand

Return a command function that toggle the collapsed attribute of the list node.

createToggleListCommand

Returns a command function that wraps the selection in a list with the given type and attributes, or change the list kind if the selection is already in another kind of list, or unwrap the selected list if otherwise.

createUnwrapListCommand

Returns a command function that unwraps the list around the selection.

createWrapInListCommand

Returns a command function that wraps the selection in a list with the given type and attributes.

defaultAttributesGetter
defaultMarkerGetter
doSplitList
findCheckboxInListItem

Finds a <input type="checkbox"> element from a <li> element. It will stop searching if it reaches a sub-list.

findListsRange

Returns a minimal block range that includes the given two positions and represents one or multiple sibling list nodes.

getListType
handleListMarkerMouseDown
isCollapsedListNode
isListNode
isListsRange
isListType
joinListElements

Merge adjacent elements or adjacent elements into a single list element.

listToDOM

Renders a list node to DOM output spec.

migrateDocJSON

Migrate a ProseMirror document JSON object from the old list structure to the new. A new document JSON object is returned if the document is updated, otherwise null is returned.

parseInteger
rangeToString

Return a debugging string that describes this range.

setSafeSelection

If one of the selection's end points is inside a collapsed node, move the selection outside of it

unwrapListSlice

Reduce the open depth of a slice if it only contains a single list node. When copying some text from a deep nested list node, we don't want to paste the entire list structure into the document later.

wrappingListInputRule

Build an input rule for automatically wrapping a textblock into a list node when a given string is typed.

§Interfaces

DedentListOptions
IndentListOptions
ListAttributes
ListToDOMOptions
ProsemirrorNodeJSON
ToggleCollapsedOptions
UnwrapListOptions

§Type Aliases

ListClickHandler
ListInputRuleAttributesGetter

A callback function to get the attributes for a list input rule.

ListKind

All default list node kinds.

WrapInListGetAttrs

The list node attributes or a callback function to take the current selection block range and return list node attributes. If this callback function returns null, the command won't do anything.