mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-21 07:18:05 +08:00
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
---
|
||
description: Adds a cursor when something is dragged inside the editor.
|
||
icon: drag-drop-line
|
||
---
|
||
|
||
# Dropcursor
|
||
[](https://www.npmjs.com/package/@tiptap/extension-dropcursor)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-dropcursor?minimal=true)
|
||
|
||
This extension loads the [ProseMirror Dropcursor plugin](https://github.com/ProseMirror/prosemirror-dropcursor) by Marijn Haverbeke, which shows a cursor at the drop position when something is dragged into the editor.
|
||
|
||
Note that Tiptap is headless, but the dropcursor needs CSS for its appearance. There are settings for the color and width, and you’re free to add a custom CSS class.
|
||
|
||
## Installation
|
||
```bash
|
||
npm install @tiptap/extension-dropcursor
|
||
```
|
||
|
||
## Settings
|
||
|
||
### color
|
||
Color of the dropcursor.
|
||
|
||
Default: `'currentcolor'`
|
||
|
||
```js
|
||
Dropcursor.configure({
|
||
color: '#ff0000'
|
||
})
|
||
```
|
||
|
||
### width
|
||
Width of the dropcursor.
|
||
|
||
Default: `1`
|
||
|
||
```js
|
||
Dropcursor.configure({
|
||
width: 2,
|
||
})
|
||
```
|
||
|
||
### class
|
||
One or multiple CSS classes that should be applied to the dropcursor.
|
||
|
||
```js
|
||
Dropcursor.configure({
|
||
class: 'my-custom-class',
|
||
})
|
||
```
|
||
|
||
## Source code
|
||
[packages/extension-dropcursor/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-dropcursor/)
|
||
|
||
## Usage
|
||
https://embed.tiptap.dev/preview/Extensions/Dropcursor
|