github
/
ant-design-vue
mirror of https://github.com/vueComponent/ant-design-vue
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: update type menu (#2717)

pull/2725/head^2
binhaoCen 2020-08-19 21:47:08 +08:00 committed by GitHub
parent 13b01d7a70
commit 4063fe6627
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 128 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
types/menu/menu-item-group.d.ts vendored
View File

@ -4,17 +4,19 @@
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
import { MenuItem } from './menu-item'; import { MenuItem } from './menu-item';
import { VNodeChild } from 'vue';
export declare class MenuItemGroup extends AntdComponent { export declare class MenuItemGroup extends AntdComponent {
/** $props:{
/**
* sub menu items * sub menu items
* @type MenuItem[] * @type MenuItem[]
*/ */
children: MenuItem[]; children?: MenuItem[];
/** /**
* title of the group * title of the group
* @type string | slot * @type string | slot
*/ */
title: any; title?: VNodeChild | JSX.Element;
}
} }

34
types/menu/menu-item.d.ts vendored
View File

@ -5,22 +5,24 @@
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
export declare class MenuItem extends AntdComponent { export declare class MenuItem extends AntdComponent {
/** $props: {
* unique id of the menu item /**
* @type string * unique id of the menu item
*/ * @type string
key: string; */
key?: string;
/** /**
* whether menu item is disabled or not * whether menu item is disabled or not
* @default false * @default false
* @type boolean * @type boolean
*/ */
disabled: boolean; disabled?: boolean;
/** /**
* set display title for collapsed item * set display title for collapsed item
* @type string * @type string
*/ */
title: string; title?: string;
}
} }

160
types/menu/menu.d.ts vendored
View File

@ -7,102 +7,104 @@ import { MenuItem } from './menu-item';
import { SubMenu } from './sub-menu'; import { SubMenu } from './sub-menu';
import { MenuItemGroup } from './menu-item-group'; import { MenuItemGroup } from './menu-item-group';
import { Divider } from '../divider'; import { Divider } from '../divider';
import { CSSProperties } from 'vue';
export declare class Menu extends AntdComponent { export declare class Menu extends AntdComponent {
static Item: typeof MenuItem; static Item: typeof MenuItem;
static SubMenu: typeof SubMenu; static SubMenu: typeof SubMenu;
static ItemGroup: typeof MenuItemGroup; static ItemGroup: typeof MenuItemGroup;
static Divider: typeof Divider; static Divider: typeof Divider;
$props: {
/**
* Allow selection of multiple items
* @default false
* @type boolean
*/
multiple?: boolean;
/** /**
* Allow selection of multiple items * array with the keys of currently selected menu items
* @default false * @type string[]
* @type boolean */
*/ selectedKeys?: string[];
multiple: boolean;
/** /**
* array with the keys of currently selected menu items * array with the keys of default selected menu items
* @type string[] * @type string[]
*/ */
selectedKeys: string[]; defaultSelectedKeys?: string[];
/** /**
* array with the keys of default selected menu items * array with the keys of default opened sub menus
* @type string[] * @type string[]
*/ */
defaultSelectedKeys: string[]; defaultOpenKeys?: string[];
/** /**
* array with the keys of default opened sub menus * array with the keys of currently opened sub menus
* @type any * @type string[]
*/ */
defaultOpenKeys: any; openKeys?: string[];
/** /**
* array with the keys of currently opened sub menus * type of the menu; vertical, horizontal, and inline modes are supported
* @type string[] * @default 'vertical'
*/ * @type string
openKeys: string[]; */
mode?: 'horizontal' | 'vertical' | 'vertical-left' | 'vertical-right' | 'inline';
/** /**
* type of the menu; vertical, horizontal, and inline modes are supported * delay time to show submenu when mouse enter, unit: second
* @default 'vertical' * @default 0
* @type string * @type number
*/ */
mode: 'horizontal' | 'vertical' | 'vertical-left' | 'vertical-right' | 'inline'; subMenuOpenDelay?: number;
/** /**
* delay time to show submenu when mouse enter, unit: second * delay time to hide submenu when mouse leave, unit: second
* @default 0 * @default 0.1
* @type number * @type number
*/ */
subMenuOpenDelay: number; subMenuCloseDelay?: number;
/** /**
* delay time to hide submenu when mouse leave, unit: second * indent px of inline menu item on each level
* @default 0.1 * @default 24
* @type number * @type number
*/ */
subMenuCloseDelay: Number; inlineIndent?: number;
/** /**
* indent px of inline menu item on each level * style of the root node
* @default 24 * @type object
* @type number */
*/ style?: CSSProperties;
inlineIndent: number;
/** /**
* style of the root node * color theme of the menu
* @type object * @default 'light'
*/ * @type string
style: object; */
theme?: 'light' | 'dark';
/** /**
* color theme of the menu * render submenu into DOM before it shows
* @default 'light' * @default false
* @type string * @type boolean
*/ */
theme: 'light' | 'dark'; forceSubMenuRender?: boolean;
/** /**
* render submenu into DOM before it shows * allow selecting menu items
* @default false * @default true
* @type boolean * @type boolean
*/ */
forceSubMenuRender: boolean; selectable?: boolean;
/** /**
* allow selecting menu items * specifies the collapsed status when menu is inline mode
* @default true * @type boolean
* @type boolean */
*/ inlineCollapsed?: boolean;
selectable: boolean; }
/**
* specifies the collapsed status when menu is inline mode
* @type boolean
*/
inlineCollapsed: boolean;
} }

41
types/menu/sub-menu.d.ts vendored
View File

@ -4,26 +4,31 @@
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
import { MenuItem } from './menu-item'; import { MenuItem } from './menu-item';
import { VNodeChild } from 'vue';
export declare class SubMenu extends AntdComponent { export declare class SubMenu extends AntdComponent {
/** $props: {
* unique id of the menu item /**
* @type string * unique id of the menu item
*/ * @type string
key: string; */
key?: string;
/** /**
* whether menu item is disabled or not * whether menu item is disabled or not
* @default false * @default false
* @type boolean * @type boolean
*/ */
disabled: boolean; disabled?: boolean;
/** /**
* title of the sub menu * title of the sub menu
* @type string | slot * @type string | slot
*/ */
title: any; title?: VNodeChild | JSX.Element;
/**
popupClassName: string; * Sub-menu class name (1.5.0)
*/
popupClassName?: string;
}
} }