fix: rename key to pluginKey for menus
This commit is contained in:
@@ -9,7 +9,7 @@ import { EditorView } from 'prosemirror-view'
|
||||
import tippy, { Instance, Props } from 'tippy.js'
|
||||
|
||||
export interface BubbleMenuPluginProps {
|
||||
key: PluginKey | string,
|
||||
pluginKey: PluginKey | string,
|
||||
editor: Editor,
|
||||
element: HTMLElement,
|
||||
tippyOptions?: Partial<Props>,
|
||||
@@ -191,9 +191,9 @@ export class BubbleMenuView {
|
||||
|
||||
export const BubbleMenuPlugin = (options: BubbleMenuPluginProps) => {
|
||||
return new Plugin({
|
||||
key: typeof options.key === 'string'
|
||||
? new PluginKey(options.key)
|
||||
: options.key,
|
||||
key: typeof options.pluginKey === 'string'
|
||||
? new PluginKey(options.pluginKey)
|
||||
: options.pluginKey,
|
||||
view: view => new BubbleMenuView({ view, ...options }),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ export const BubbleMenu = Extension.create<BubbleMenuOptions>({
|
||||
defaultOptions: {
|
||||
element: null,
|
||||
tippyOptions: {},
|
||||
key: 'bubbleMenu',
|
||||
pluginKey: 'bubbleMenu',
|
||||
shouldShow: null,
|
||||
},
|
||||
|
||||
@@ -22,7 +22,7 @@ export const BubbleMenu = Extension.create<BubbleMenuOptions>({
|
||||
|
||||
return [
|
||||
BubbleMenuPlugin({
|
||||
key: this.options.key,
|
||||
pluginKey: this.options.pluginKey,
|
||||
editor: this.editor,
|
||||
element: this.options.element,
|
||||
tippyOptions: this.options.tippyOptions,
|
||||
|
||||
@@ -4,7 +4,7 @@ import { EditorView } from 'prosemirror-view'
|
||||
import tippy, { Instance, Props } from 'tippy.js'
|
||||
|
||||
export interface FloatingMenuPluginProps {
|
||||
key: PluginKey | string,
|
||||
pluginKey: PluginKey | string,
|
||||
editor: Editor,
|
||||
element: HTMLElement,
|
||||
tippyOptions?: Partial<Props>,
|
||||
@@ -160,9 +160,9 @@ export class FloatingMenuView {
|
||||
|
||||
export const FloatingMenuPlugin = (options: FloatingMenuPluginProps) => {
|
||||
return new Plugin({
|
||||
key: typeof options.key === 'string'
|
||||
? new PluginKey(options.key)
|
||||
: options.key,
|
||||
key: typeof options.pluginKey === 'string'
|
||||
? new PluginKey(options.pluginKey)
|
||||
: options.pluginKey,
|
||||
view: view => new FloatingMenuView({ view, ...options }),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ export const FloatingMenu = Extension.create<FloatingMenuOptions>({
|
||||
defaultOptions: {
|
||||
element: null,
|
||||
tippyOptions: {},
|
||||
key: 'floatingMenu',
|
||||
pluginKey: 'floatingMenu',
|
||||
shouldShow: null,
|
||||
},
|
||||
|
||||
@@ -22,7 +22,7 @@ export const FloatingMenu = Extension.create<FloatingMenuOptions>({
|
||||
|
||||
return [
|
||||
FloatingMenuPlugin({
|
||||
key: this.options.key,
|
||||
pluginKey: this.options.pluginKey,
|
||||
editor: this.editor,
|
||||
element: this.options.element,
|
||||
tippyOptions: this.options.tippyOptions,
|
||||
|
||||
@@ -10,14 +10,14 @@ export const BubbleMenu: React.FC<BubbleMenuProps> = props => {
|
||||
|
||||
useEffect(() => {
|
||||
const {
|
||||
key,
|
||||
pluginKey,
|
||||
editor,
|
||||
tippyOptions,
|
||||
shouldShow,
|
||||
} = props
|
||||
|
||||
editor.registerPlugin(BubbleMenuPlugin({
|
||||
key,
|
||||
pluginKey,
|
||||
editor,
|
||||
element: element.current as HTMLElement,
|
||||
tippyOptions,
|
||||
@@ -25,7 +25,7 @@ export const BubbleMenu: React.FC<BubbleMenuProps> = props => {
|
||||
}))
|
||||
|
||||
return () => {
|
||||
editor.unregisterPlugin(key)
|
||||
editor.unregisterPlugin(pluginKey)
|
||||
}
|
||||
}, [])
|
||||
|
||||
|
||||
@@ -10,14 +10,14 @@ export const FloatingMenu: React.FC<FloatingMenuProps> = props => {
|
||||
|
||||
useEffect(() => {
|
||||
const {
|
||||
key,
|
||||
pluginKey,
|
||||
editor,
|
||||
tippyOptions,
|
||||
shouldShow,
|
||||
} = props
|
||||
|
||||
editor.registerPlugin(FloatingMenuPlugin({
|
||||
key,
|
||||
pluginKey,
|
||||
editor,
|
||||
element: element.current as HTMLElement,
|
||||
tippyOptions,
|
||||
@@ -25,7 +25,7 @@ export const FloatingMenu: React.FC<FloatingMenuProps> = props => {
|
||||
}))
|
||||
|
||||
return () => {
|
||||
editor.unregisterPlugin(key)
|
||||
editor.unregisterPlugin(pluginKey)
|
||||
}
|
||||
}, [])
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ import Vue, { Component, PropType } from 'vue'
|
||||
import { BubbleMenuPlugin, BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu'
|
||||
|
||||
export interface BubbleMenuInterface extends Vue {
|
||||
pluginKey: BubbleMenuPluginProps['key'],
|
||||
pluginKey: BubbleMenuPluginProps['pluginKey'],
|
||||
editor: BubbleMenuPluginProps['editor'],
|
||||
tippyOptions: BubbleMenuPluginProps['tippyOptions'],
|
||||
shouldShow: BubbleMenuPluginProps['shouldShow'],
|
||||
@@ -13,7 +13,7 @@ export const BubbleMenu: Component = {
|
||||
|
||||
props: {
|
||||
pluginKey: {
|
||||
type: [String, Object as PropType<Exclude<BubbleMenuPluginProps['key'], string>>],
|
||||
type: [String, Object as PropType<Exclude<BubbleMenuPluginProps['pluginKey'], string>>],
|
||||
default: 'bubbleMenu',
|
||||
},
|
||||
|
||||
@@ -43,7 +43,7 @@ export const BubbleMenu: Component = {
|
||||
|
||||
this.$nextTick(() => {
|
||||
editor.registerPlugin(BubbleMenuPlugin({
|
||||
key: this.pluginKey,
|
||||
pluginKey: this.pluginKey,
|
||||
editor,
|
||||
element: this.$el as HTMLElement,
|
||||
tippyOptions: this.tippyOptions,
|
||||
|
||||
@@ -2,7 +2,7 @@ import Vue, { Component, PropType } from 'vue'
|
||||
import { FloatingMenuPlugin, FloatingMenuPluginProps } from '@tiptap/extension-floating-menu'
|
||||
|
||||
export interface FloatingMenuInterface extends Vue {
|
||||
pluginKey: FloatingMenuPluginProps['key'],
|
||||
pluginKey: FloatingMenuPluginProps['pluginKey'],
|
||||
tippyOptions: FloatingMenuPluginProps['tippyOptions'],
|
||||
editor: FloatingMenuPluginProps['editor'],
|
||||
shouldShow: FloatingMenuPluginProps['shouldShow'],
|
||||
@@ -13,7 +13,7 @@ export const FloatingMenu: Component = {
|
||||
|
||||
props: {
|
||||
pluginKey: {
|
||||
type: [String, Object as PropType<Exclude<FloatingMenuPluginProps['key'], string>>],
|
||||
type: [String, Object as PropType<Exclude<FloatingMenuPluginProps['pluginKey'], string>>],
|
||||
default: 'floatingMenu',
|
||||
},
|
||||
|
||||
@@ -43,7 +43,7 @@ export const FloatingMenu: Component = {
|
||||
|
||||
this.$nextTick(() => {
|
||||
editor.registerPlugin(FloatingMenuPlugin({
|
||||
key: this.pluginKey,
|
||||
pluginKey: this.pluginKey,
|
||||
editor,
|
||||
element: this.$el as HTMLElement,
|
||||
tippyOptions: this.tippyOptions,
|
||||
|
||||
@@ -14,7 +14,7 @@ export const BubbleMenu = defineComponent({
|
||||
props: {
|
||||
pluginKey: {
|
||||
// TODO: TypeScript breaks :(
|
||||
// type: [String, Object as PropType<Exclude<BubbleMenuPluginProps['key'], string>>],
|
||||
// type: [String, Object as PropType<Exclude<BubbleMenuPluginProps['pluginKey'], string>>],
|
||||
type: [String, Object],
|
||||
default: 'bubbleMenu',
|
||||
},
|
||||
@@ -47,7 +47,7 @@ export const BubbleMenu = defineComponent({
|
||||
} = props
|
||||
|
||||
editor.registerPlugin(BubbleMenuPlugin({
|
||||
key: pluginKey,
|
||||
pluginKey,
|
||||
editor,
|
||||
element: root.value as HTMLElement,
|
||||
tippyOptions,
|
||||
|
||||
@@ -14,7 +14,7 @@ export const FloatingMenu = defineComponent({
|
||||
props: {
|
||||
pluginKey: {
|
||||
// TODO: TypeScript breaks :(
|
||||
// type: [String, Object as PropType<Exclude<FloatingMenuPluginProps['key'], string>>],
|
||||
// type: [String, Object as PropType<Exclude<FloatingMenuPluginProps['pluginKey'], string>>],
|
||||
type: [String, Object],
|
||||
default: 'floatingMenu',
|
||||
},
|
||||
@@ -47,7 +47,7 @@ export const FloatingMenu = defineComponent({
|
||||
} = props
|
||||
|
||||
editor.registerPlugin(FloatingMenuPlugin({
|
||||
key: pluginKey,
|
||||
pluginKey,
|
||||
editor,
|
||||
element: root.value as HTMLElement,
|
||||
tippyOptions,
|
||||
|
||||
Reference in New Issue
Block a user