UNPKG

1.32 kBTypeScriptView Raw
1import { ElementUIComponent } from './component'
2
3export type MenuDisplayMode = 'horizontal' | 'vertical'
4export type MenuTheme = 'light' | 'dark'
5
6/** Menu that provides navigation for your website */
7export declare class ElMenu extends ElementUIComponent {
8 /** Menu display mode */
9 mode: MenuDisplayMode
10
11 /** Whether the menu is collapsed (available only in vertical mode) */
12 collapse: boolean
13
14 /** Background color of Menu (hex format) */
15 backgroundColor: string
16
17 /** Text color of Menu (hex format) */
18 textColor: string
19
20 /** Text color of currently active menu item (hex format) */
21 activeTextColor: string
22
23 /** Index of currently active menu */
24 defaultActive: string
25
26 /** Array that contains keys of currently active sub-menus */
27 defaultOpeneds: string[]
28
29 /** Whether only one sub-menu can be active */
30 uniqueOpened: boolean
31
32 /** How sub-menus are triggered, only works when mode is 'horizontal' */
33 menuTrigger: string
34
35 /** Whether vue-router mode is activated. If true, index will be used as 'path' to activate the route action */
36 router: boolean
37
38 /** Whether the menu collapse transition is active */
39 collapseTransition: boolean
40
41 /** Open the specified sub-menu */
42 open (index: string): void
43
44 /** Close the specified sub-menu */
45 close (index: string): void
46}