Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.46 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.46 KB
Raw

This module implements the state object of a ProseMirror editor, along with the representation of the selection and the plugin abstraction.

Editor State

ProseMirror keeps all editor state (the things, basically, that would be required to create an editor just like the current one) in a single object. That object is updated (creating a new state) by applying transactions to it.

@EditorState @EditorStateConfig @Transaction @Command

Selection

A ProseMirror selection can be one of several types. This module defines types for classical text selections (of which cursors are a special case) and node selections, where a specific document node is selected. It is possible to extend the editor with custom selection types.

@Selection @TextSelection @NodeSelection @AllSelection

@SelectionRange @SelectionBookmark

Plugin System

To make it easy to package and enable extra editor functionality, ProseMirror has a plugin system.

@PluginSpec @StateField @PluginView @Plugin @PluginKey

Maven / Gradle dependency

Check the latest package at Maven central on: https://packages.atlassian.com/maven-central/com/atlassian/prosemirror/state.

Maven:

<dependency>
    <groupId>com.atlassian.prosemirror</groupId>
    <artifactId>state</artifactId>
    <version>1.0.2</version>
</dependency>

Gradle:

implementation("com.atlassian.prosemirror:state:1.0.2")