iview/types/dropdown.d.ts

91 lines
No EOL
2.3 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Type definitions for iview 3.3.1
// Project: https://github.com/iview/iview
// Definitions by: yangdan
// Definitions: https://github.com/yangdan8/iview.git
import Vue, { VNode } from 'vue';
export declare class Dropdown extends Vue {
/**
* 触发方式,可选值为 hover悬停click点击contextMenu右键custom自定义使用 custom 时,需配合 visible 一起使用
* @default hover
*/
trigger?: 'hover'|'click'|'custom'|'contextMenu';
/**
* 手动控制下拉框的显示,在 trigger = 'custom' 时使用
* @default false
*/
visible?: boolean;
/**
* 下拉菜单出现的位置,可选值为
* toptop-starttop-endbottombottom-startbottom-end
* leftleft-startleft-endrightright-startright-end
* 2.12.0 版本开始支持自动识别
* @default bottom
*/
placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end';
/**
* 是否将弹层放置于 body 内,在 Tabs、带有 fixed 的 Table 列内使用时,建议添加此属性,它将不受父级样式影响,从而达到更好的效果
* @default false
*/
transfer?: boolean;
/**
* 开启 transfer 时,给浮层添加额外的 class 名称
*/
'transfer-class-name'?: string;
/**
* 是否开启 stop-propagation
* @default false
*/
'stop-propagation'?: boolean;
/**
* 点击菜单项时触发
*
*/
$emit(eventName: 'on-click', value: string): this;
/**
* 菜单显示状态改变时调用
*/
$emit(eventName: 'on-visible-change', value: boolean): this;
/**
* 点击外部关闭下拉菜单时触发
*/
$emit(eventName: 'on-clickoutside', event: object): this;
/**
* slot插槽对象
*/
$slots: {
/**
* 主体内容
*/
'': VNode[];
/**
* 列表内容,一般由 DropdownMenu 承担
*/
list: VNode[];
};
}
export declare class DropdownMenu extends Vue {
}
export declare class DropdownItem extends Vue {
/**
* 用来标识这一项
*/
name?: string;
/**
* 禁用该项
* @default false
*/
disabled?: boolean;
/**
* 显示分割线
* @default false
*/
divided?: boolean;
/**
* 标记该项为选中状态
* @default false
*/
selected?: boolean;
}