Browse Source

chore: update type menu (#2717)

pull/2725/head^2
binhaoCen 4 years ago committed by GitHub
parent
commit
4063fe6627
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      types/menu/menu-item-group.d.ts
  2. 34
      types/menu/menu-item.d.ts
  3. 186
      types/menu/menu.d.ts
  4. 41
      types/menu/sub-menu.d.ts

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

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

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

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

186
types/menu/menu.d.ts vendored

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

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

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

Loading…
Cancel
Save