element/types/menu.d.ts
Bo Zhang d0809e4915 Types: complete method declarations in the documentation (#10233)
* Chore: complete the method declarations specified in the document

* Fix: fix a misspell mistake
2018-03-19 17:27:40 +08:00

47 lines
1.3 KiB
TypeScript

import { ElementUIComponent } from './component'
export type MenuDisplayMode = 'horizontal' | 'vertical'
export type MenuTheme = 'light' | 'dark'
/** Menu that provides navigation for your website */
export declare class ElMenu extends ElementUIComponent {
/** Menu display mode */
mode: MenuDisplayMode
/** Whether the menu is collapsed (available only in vertical mode) */
collapse: boolean
/** Background color of Menu (hex format) */
backgroundColor: string
/** Text color of Menu (hex format) */
textColor: string
/** Text color of currently active menu item (hex format) */
activeTextColor: string
/** Index of currently active menu */
defaultActive: string
/** Array that contains keys of currently active sub-menus */
defaultOpeneds: string[]
/** Whether only one sub-menu can be active */
uniqueOpened: boolean
/** How sub-menus are triggered, only works when mode is 'horizontal' */
menuTrigger: string
/** Whether vue-router mode is activated. If true, index will be used as 'path' to activate the route action */
router: boolean
/** Whether the menu collapse transition is active */
collapseTransition: boolean
/** Open the specified sub-menu */
open (index: string): void
/** Close the specified sub-menu */
close (index: string): void
}