style(extension/bubble-menu): change delay option to updateDelay

ueberdosis · Nov 4, 2022 · 3d04941 · 3d04941
1 parent e889e10
commit 3d04941
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 20 deletions.
diff --git a/docs/api/extensions/bubble-menu.md b/docs/api/extensions/bubble-menu.md
@@ -25,7 +25,7 @@ Type: `HTMLElement`
 
 Default: `null`
 
-### delay
+### updateDelay
 The `BubbleMenu` debounces the `update` method to allow the bubble menu to not be updated on every selection update. This can be controlled in milliseconds.
 The BubbleMenuPlugin will come with a default delay of 250ms. This can be deactivated, by setting the delay to `0` which deactivates the debounce.
 

diff --git a/packages/extension-bubble-menu/src/bubble-menu-plugin.ts b/packages/extension-bubble-menu/src/bubble-menu-plugin.ts
@@ -14,7 +14,7 @@ export interface BubbleMenuPluginProps {
   editor: Editor,
   element: HTMLElement,
   tippyOptions?: Partial<Props>,
-  delay?: number,
+  updateDelay?: number,
   shouldShow?: ((props: {
     editor: Editor,
     view: EditorView,
@@ -42,7 +42,7 @@ export class BubbleMenuView {
 
   public tippyOptions?: Partial<Props>
 
-  public delay: number
+  public updateDelay: number
 
   public shouldShow: Exclude<BubbleMenuPluginProps['shouldShow'], null> = ({
     view,
@@ -83,13 +83,13 @@ export class BubbleMenuView {
     element,
     view,
     tippyOptions = {},
-    delay = 250,
+    updateDelay = 250,
     shouldShow,
   }: BubbleMenuViewProps) {
     this.editor = editor
     this.element = element
     this.view = view
-    this.delay = delay
+    this.updateDelay = updateDelay
 
     if (shouldShow) {
       this.shouldShow = shouldShow
@@ -169,8 +169,8 @@ export class BubbleMenuView {
     const hasValidSelection = state.selection.$from.pos !== state.selection.$to.pos
 
     if (hasValidSelection) {
-      if (this.delay > 0) {
-        debounce(this.updateHandler, this.delay)(view, oldState)
+      if (this.updateDelay > 0) {
+        debounce(this.updateHandler, this.updateDelay)(view, oldState)
       } else {
         this.updateHandler(view, oldState)
       }

diff --git a/packages/extension-bubble-menu/src/bubble-menu.ts b/packages/extension-bubble-menu/src/bubble-menu.ts
@@ -14,7 +14,7 @@ export const BubbleMenu = Extension.create<BubbleMenuOptions>({
       element: null,
       tippyOptions: {},
       pluginKey: 'bubbleMenu',
-      delay: undefined,
+      updateDelay: undefined,
       shouldShow: null,
     }
   },
@@ -30,7 +30,7 @@ export const BubbleMenu = Extension.create<BubbleMenuOptions>({
         editor: this.editor,
         element: this.options.element,
         tippyOptions: this.options.tippyOptions,
-        delay: this.options.delay,
+        updateDelay: this.options.updateDelay,
         shouldShow: this.options.shouldShow,
       }),
     ]

diff --git a/packages/react/src/BubbleMenu.tsx b/packages/react/src/BubbleMenu.tsx
@@ -6,7 +6,7 @@ type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 export type BubbleMenuProps = Omit<Optional<BubbleMenuPluginProps, 'pluginKey'>, 'element'> & {
   className?: string;
   children: React.ReactNode;
-  delay?: number;
+  updateDelay?: number;
 };
 
 export const BubbleMenu = (props: BubbleMenuProps) => {
@@ -22,11 +22,11 @@ export const BubbleMenu = (props: BubbleMenuProps) => {
     }
 
     const {
-      pluginKey = 'bubbleMenu', editor, tippyOptions = {}, delay, shouldShow = null,
+      pluginKey = 'bubbleMenu', editor, tippyOptions = {}, updateDelay, shouldShow = null,
     } = props
 
     const plugin = BubbleMenuPlugin({
-      delay,
+      updateDelay,
       editor,
       element,
       pluginKey,

diff --git a/packages/vue-2/src/BubbleMenu.ts b/packages/vue-2/src/BubbleMenu.ts
@@ -5,7 +5,7 @@ export interface BubbleMenuInterface extends Vue {
   pluginKey: BubbleMenuPluginProps['pluginKey'],
   editor: BubbleMenuPluginProps['editor'],
   tippyOptions: BubbleMenuPluginProps['tippyOptions'],
-  delay: BubbleMenuPluginProps['delay'],
+  updateDelay: BubbleMenuPluginProps['updateDelay'],
   shouldShow: BubbleMenuPluginProps['shouldShow'],
 }
 
@@ -23,8 +23,8 @@ export const BubbleMenu: Component = {
       required: true,
     },
 
-    delay: {
-      type: Number as PropType<BubbleMenuPluginProps['delay']>,
+    updateDelay: {
+      type: Number as PropType<BubbleMenuPluginProps['updateDelay']>,
     },
 
     tippyOptions: {
@@ -48,7 +48,7 @@ export const BubbleMenu: Component = {
 
         this.$nextTick(() => {
           editor.registerPlugin(BubbleMenuPlugin({
-            delay: this.delay,
+            updateDelay: this.updateDelay,
             editor,
             element: this.$el as HTMLElement,
             pluginKey: this.pluginKey,

diff --git a/packages/vue-3/src/BubbleMenu.ts b/packages/vue-3/src/BubbleMenu.ts
@@ -24,8 +24,8 @@ export const BubbleMenu = defineComponent({
       required: true,
     },
 
-    delay: {
-      type: Number as PropType<BubbleMenuPluginProps['delay']>,
+    updateDelay: {
+      type: Number as PropType<BubbleMenuPluginProps['updateDelay']>,
       default: undefined,
     },
 
@@ -45,15 +45,15 @@ export const BubbleMenu = defineComponent({
 
     onMounted(() => {
       const {
-        delay,
+        updateDelay,
         editor,
         pluginKey,
         shouldShow,
         tippyOptions,
       } = props
 
       editor.registerPlugin(BubbleMenuPlugin({
-        delay,
+        updateDelay,
         editor,
         element: root.value as HTMLElement,
         pluginKey,