Skip to content
A drop cursor plugin for ProseMirror
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Add class option to in-code docs Sep 5, 2019
.gitignore Initial add Dec 7, 2016
.npmignore Add .npmignore Dec 9, 2016
CHANGELOG.md
CONTRIBUTING.md Update README/CONTRIBUTING files Sep 13, 2017
LICENSE Update README/CONTRIBUTING files Sep 13, 2017
README.md Link to https in readme and changelog Nov 26, 2019
package.json Mark version 1.3.2 Nov 20, 2019
rollup.config.js Make ES module files use .js extension Nov 20, 2019

README.md

prosemirror-dropcursor

[ WEBSITE | ISSUES | FORUM | GITTER ]

This is a non-core example module for ProseMirror. ProseMirror is a well-behaved rich semantic content editor based on contentEditable, with support for collaborative editing and custom document schemas.

This module implements a plugin that shows a drop cursor for ProseMirror.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license. There's a forum for general discussion and support requests, and the Github bug tracker is the place to report issues.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

Documentation

dropCursor(options: ?Object) → Plugin

Create a plugin that, when added to a ProseMirror instance, causes a decoration to show up at the drop position when something is dragged over the editor.

  • options: ?Object
    • color: ?string (default: black)
    • width: ?number (default: 1)
    • class: ?string
      Adds a class to the cursor.
      Layout overrides such as width are not recommended
You can’t perform that action at this time.