2021-04-01 21:47:00 +08:00
|
|
|
# Floating Menu
|
|
|
|
[![Version](https://img.shields.io/npm/v/@tiptap/extension-floating-menu.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-floating-menu)
|
|
|
|
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-floating-menu.svg)](https://npmcharts.com/compare/@tiptap/extension-floating-menu?minimal=true)
|
|
|
|
|
|
|
|
This extension will make a contextual menu appear near a selection of text.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
|
|
# with npm
|
|
|
|
npm install @tiptap/extension-floating-menu
|
|
|
|
# with Yarn
|
|
|
|
yarn add @tiptap/extension-floating-menu
|
|
|
|
```
|
|
|
|
|
|
|
|
## Settings
|
2021-08-11 20:37:58 +08:00
|
|
|
| Option | Type | Default | Description |
|
|
|
|
| ------------ | -------------------- | ---------------- | ----------------------------------------------------------------------- |
|
|
|
|
| element | `HTMLElement` | `null` | The DOM element of your menu. |
|
|
|
|
| tippyOptions | `Object` | `{}` | [Options for tippy.js](https://atomiks.github.io/tippyjs/v6/all-props/) |
|
2021-08-13 18:33:06 +08:00
|
|
|
| pluginKey | `string | PluginKey` | `'floatingMenu'` | The key for the underlying ProseMirror plugin. |
|
2021-08-11 20:37:58 +08:00
|
|
|
| shouldShow | `(props) => boolean` | | Controls whether the menu should be shown or not. |
|
2021-04-01 21:47:00 +08:00
|
|
|
|
|
|
|
## Source code
|
2021-04-21 21:31:11 +08:00
|
|
|
[packages/extension-floating-menu/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-floating-menu/)
|
2021-04-01 21:47:00 +08:00
|
|
|
|
|
|
|
## Using Vanilla JavaScript
|
|
|
|
```js
|
|
|
|
import { Editor } from '@tiptap/core'
|
|
|
|
import FloatingMenu from '@tiptap/extension-floating-menu'
|
|
|
|
|
|
|
|
new Editor({
|
|
|
|
extensions: [
|
|
|
|
FloatingMenu.configure({
|
|
|
|
element: document.querySelector('.menu'),
|
|
|
|
}),
|
|
|
|
],
|
|
|
|
})
|
|
|
|
```
|
|
|
|
|
|
|
|
## Using a framework
|
|
|
|
<demos :items="{
|
|
|
|
Vue: 'Extensions/FloatingMenu/Vue',
|
|
|
|
React: 'Extensions/FloatingMenu/React',
|
|
|
|
}" />
|
2021-08-11 20:37:58 +08:00
|
|
|
|
|
|
|
### Custom logic
|
|
|
|
Customize the logic for showing the menu with the `shouldShow` option. For components, `shouldShow` can be passed as a prop.
|
|
|
|
|
|
|
|
```js
|
|
|
|
FloatingMenu.configure({
|
|
|
|
shouldShow: ({ editor, view, state, oldState }) => {
|
|
|
|
// show the floating within any paragraph
|
|
|
|
return editor.isActive('paragraph')
|
|
|
|
},
|
|
|
|
})
|
|
|
|
```
|
|
|
|
|
|
|
|
### Multiple menus
|
2021-08-13 18:33:06 +08:00
|
|
|
Use multiple menus by setting an unique `pluginKey`.
|
2021-08-11 20:37:58 +08:00
|
|
|
|
|
|
|
```js
|
|
|
|
import { Editor } from '@tiptap/core'
|
|
|
|
import FloatingMenu from '@tiptap/extension-floating-menu'
|
|
|
|
|
|
|
|
new Editor({
|
|
|
|
extensions: [
|
|
|
|
FloatingMenu.configure({
|
2021-08-13 18:33:06 +08:00
|
|
|
pluginKey: 'floatingMenuOne',
|
2021-08-11 20:37:58 +08:00
|
|
|
element: document.querySelector('.menu-one'),
|
|
|
|
}),
|
|
|
|
FloatingMenu.configure({
|
2021-08-13 18:33:06 +08:00
|
|
|
pluginKey: 'floatingMenuTwo',
|
2021-08-11 20:37:58 +08:00
|
|
|
element: document.querySelector('.menu-two'),
|
|
|
|
}),
|
|
|
|
],
|
|
|
|
})
|
|
|
|
```
|
|
|
|
|
|
|
|
Alternatively you can pass a ProseMirror `PluginKey`.
|
|
|
|
|
|
|
|
```js
|
|
|
|
import { Editor } from '@tiptap/core'
|
|
|
|
import FloatingMenu from '@tiptap/extension-floating-menu'
|
|
|
|
import { PluginKey } from 'prosemirror-state'
|
|
|
|
|
|
|
|
new Editor({
|
|
|
|
extensions: [
|
|
|
|
FloatingMenu.configure({
|
2021-08-13 18:33:06 +08:00
|
|
|
pluginKey: new PluginKey('floatingMenuOne'),
|
2021-08-11 20:37:58 +08:00
|
|
|
element: document.querySelector('.menu-one'),
|
|
|
|
}),
|
|
|
|
FloatingMenu.configure({
|
2021-08-13 18:33:06 +08:00
|
|
|
pluginKey: new PluginKey('floatingMenuOne'),
|
2021-08-11 20:37:58 +08:00
|
|
|
element: document.querySelector('.menu-two'),
|
|
|
|
}),
|
|
|
|
],
|
|
|
|
})
|
|
|
|
```
|