Skip to content

Commit a5bb94c

Browse files
committed
Update docs
1 parent f3eb01a commit a5bb94c

File tree

5 files changed

+11
-3
lines changed

5 files changed

+11
-3
lines changed

docs/en/api/ContextMenuInstance.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,9 @@ Global Function
7676
| adjustPadding | Padding for submenu position adjust. | `{ x: number, y: number }` or `number` || `{ x:0, y: 10 }` |
7777
| adjustPosition | By default, the menu will automatically adjust its position to prevent it overflow the container. If you allow menu overflow containers, you can set this to false. | `boolean` || `true` |
7878
| direction | Set the mian menu pop-up direction relative to coordinates. Default is `'br'`, if `adjustPosition` is true then the menu will determine the pop-up direction based on its distance from the screen edge. | `'br' or 'b' or 'bl' or 'tr' or 't' or 'tl' or 'l' or 'r'` || `'br'` |
79+
| menuTransitionProps | The Vue Transition props used when menu show or hide. | `TransitionProps` ||
7980
| ignoreClickClassName | If your element in menu item has this className, click it will ignore event. | `string` ||
80-
| clickCloseOnOutside | Set should close menu when the user click on other places. | `boolean` | `true` |
81+
| clickCloseOnOutside | Set should close menu when the user click on other places. | `boolean` | | `true` |
8182
| clickCloseClassName | If your element in menu item has this className, click it will ignore event and close hole menu. | `string` ||
8283
| updownButtonSpaceholder | Determine whether the up/down buttons in the menu item require space holder. The purpose of this variable is because some menu themes add blank padding above and below the menu, which are just enough to place up/down buttons. If there is no blank padding in your custom menu theme, you can set this field to provide blank space for up/down buttons to prevent obscuring menu items. | `boolean` || `false` |
8384
| getContainer | Return the mounted node for MenuRoot. [Guide](../guide/custom-container.md) | `HTMLElement` or `(() => HTMLElement)` |||

docs/en/change/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ nav:
44
title: Changelog
55
order: 5
66
---
7+
## v1.3.7 - 2024/01/23
8+
9+
* [Added] Add `MenuOptions.menuTransitionProps` attribute used set transition effects when menu display/hiding. ([#80](https://github.com/imengyu/vue3-context-menu/issues/80))
710

811
## v1.3.6 - 2024/01/17
912

docs/zh/api/ContextMenuInstance.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ import ContextMenu from '@imengyu/vue3-context-menu'
7676
| adjustPosition | 默认情况下,菜单将自动调整其位置,以防止溢出容器。如果允许菜单溢出容器,则可以将其设置为false。 | `boolean` || `true` |
7777
| direction | 设置主菜单相对于坐标的弹出方向。如果 `adjustPosition``true` ,则菜单会根据可用空间自动调整弹出方向。 | `'br'|'b'|'bl'|'tr'|'t'|'tl'|'l'|'r'` || `'br'` |
7878
| ignoreClickClassName | 若菜单项中的元素有这个className,单击它将忽略事件。| `string` ||
79-
| clickCloseOnOutside | 设置是否当用户点击其他位置时应关闭菜单。| `boolean` | `true` |
79+
| menuTransitionProps | 设置菜单显示隐藏时的 Vue Transition 组件属性。 | `TransitionProps` ||
80+
| clickCloseOnOutside | 设置是否当用户点击其他位置时应关闭菜单。| `boolean` || `true` |
8081
| clickCloseClassName | 若菜单项中的元素有这个className,单击它将忽略事件,并且点击后会关闭菜单。| `string` ||
8182
| updownButtonSpaceholder | 决定菜单项中的上/下按钮是否需要空白占位。设置这个变量的目的是因为有些菜单主题会在菜单上下添加空白边距,这一部分空白边距刚好可以放置上/下按钮。如果你的自定义主题菜单中没有空白边距,则可以设置此字段为上/下按提供要空白占位,防止遮挡菜单条目。 | `boolean` || `false` |
8283
| getContainer | 自定义菜单挂载容器。[详情请参考](../guide/custom-container.md) | `HTMLElement` or `(() => HTMLElement)` |||

docs/zh/change/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ nav:
55
order: 5
66
---
77

8+
## v1.3.7 - 2024/01/23
9+
10+
* [Added] 添加 `MenuOptions.menuTransitionProps` 属性用于实现菜单显示/隐藏的过度动效。 ([#80](https://github.com/imengyu/vue3-context-menu/issues/80))
811

912
## v1.3.6 - 2024/01/17
1013

library/ContextMenuDefine.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ export interface MenuOptions {
148148
iconFontClass ?: string;
149149
/**
150150
* The Vue Transition props used when menu show or hide.
151-
* @default ''
151+
* @default undefined
152152
*/
153153
menuTransitionProps ?: TransitionProps;
154154
/**

0 commit comments

Comments
 (0)