mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-15 11:09:01 +08:00
120 lines
3.0 KiB
Markdown
120 lines
3.0 KiB
Markdown
# Bubble Menu
|
|
[](https://www.npmjs.com/package/@tiptap/extension-bubble-menu)
|
|
[](https://npmcharts.com/compare/@tiptap/extension-bubble-menu?minimal=true)
|
|
|
|
This extension will make a contextual menu appear near a selection of text. Use it to let users apply [marks](/api/marks) to their text selection.
|
|
|
|
As always, the markup and styling is totally up to you.
|
|
|
|
## Installation
|
|
```bash
|
|
# with npm
|
|
npm install @tiptap/extension-bubble-menu
|
|
# with Yarn
|
|
yarn add @tiptap/extension-bubble-menu
|
|
```
|
|
|
|
## Settings
|
|
|
|
### element
|
|
The DOM element that contains your menu.
|
|
|
|
Type: `HTMLElement`
|
|
|
|
Default: `null`
|
|
|
|
### tippyOptions
|
|
Under the hood, the `BubbleMenu` uses [tippy.js](https://atomiks.github.io/tippyjs/v6/all-props/). You can directly pass options to it.
|
|
|
|
Type: `Object`
|
|
|
|
Default: `{}`
|
|
|
|
### pluginKey
|
|
The key for the underlying ProseMirror plugin. Make sure to use different keys if you add more than one instance.
|
|
|
|
Type: `string | PluginKey`
|
|
|
|
Default: `'bubbleMenu'`
|
|
|
|
### shouldShow
|
|
A callback to control whether the menu should be shown or not.
|
|
|
|
Type: `(props) => boolean`
|
|
|
|
## Source code
|
|
[packages/extension-bubble-menu/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bubble-menu/)
|
|
|
|
## Usage
|
|
|
|
### JavaScript
|
|
```js
|
|
import { Editor } from '@tiptap/core'
|
|
import BubbleMenu from '@tiptap/extension-bubble-menu'
|
|
|
|
new Editor({
|
|
extensions: [
|
|
BubbleMenu.configure({
|
|
element: document.querySelector('.menu'),
|
|
}),
|
|
],
|
|
})
|
|
```
|
|
|
|
### Frameworks
|
|
<tiptap-demo name="Extensions/BubbleMenu"></tiptap-demo>
|
|
|
|
### Custom logic
|
|
Customize the logic for showing the menu with the `shouldShow` option. For components, `shouldShow` can be passed as a prop.
|
|
|
|
```js
|
|
BubbleMenu.configure({
|
|
shouldShow: ({ editor, view, state, oldState, from, to }) => {
|
|
// only show the bubble menu for images and links
|
|
return editor.isActive('image') || editor.isActive('link')
|
|
},
|
|
})
|
|
```
|
|
|
|
### Multiple menus
|
|
Use multiple menus by setting an unique `pluginKey`.
|
|
|
|
```js
|
|
import { Editor } from '@tiptap/core'
|
|
import BubbleMenu from '@tiptap/extension-bubble-menu'
|
|
|
|
new Editor({
|
|
extensions: [
|
|
BubbleMenu.configure({
|
|
pluginKey: 'bubbleMenuOne',
|
|
element: document.querySelector('.menu-one'),
|
|
}),
|
|
BubbleMenu.configure({
|
|
pluginKey: 'bubbleMenuTwo',
|
|
element: document.querySelector('.menu-two'),
|
|
}),
|
|
],
|
|
})
|
|
```
|
|
|
|
Alternatively you can pass a ProseMirror `PluginKey`.
|
|
|
|
```js
|
|
import { Editor } from '@tiptap/core'
|
|
import BubbleMenu from '@tiptap/extension-bubble-menu'
|
|
import { PluginKey } from 'prosemirror-state'
|
|
|
|
new Editor({
|
|
extensions: [
|
|
BubbleMenu.configure({
|
|
pluginKey: new PluginKey('bubbleMenuOne'),
|
|
element: document.querySelector('.menu-one'),
|
|
}),
|
|
BubbleMenu.configure({
|
|
pluginKey: new PluginKey('bubbleMenuTwo'),
|
|
element: document.querySelector('.menu-two'),
|
|
}),
|
|
],
|
|
})
|
|
```
|