@ray-js/smart-ui-typings
Version:
@ray-js/smart-ui 智能小程序 UI 框架的类型声明文件
93 lines (92 loc) • 2.06 kB
TypeScript
/// <reference types="wechat-miniprogram" />
import { VantComponent, VantEventHandler } from '../base';
export interface VantDropdownItemOption {
/**
* 文字
*/
text?: string;
/**
* 标识符
*/
value?: string | number;
/**
* 左侧图标名称或图片链接
*/
icon?: string;
}
export interface VantDropdownItemProps {
/**
* 当前选中项对应的 `value`
*/
value?: number | string;
/**
* 菜单项标题
*
* @default 当前选中项文字
*/
title?: string;
/**
* 选项数组
*
* @default []
*/
options?: VantDropdownItemOption[];
/**
* 是否禁用菜单
*
* @default false
*/
disabled?: boolean;
/**
* 标题额外类名
*/
titleClass?: string;
/**
* 自定义弹出层样式
*/
popupStyle?: string;
/**
* 是否开启下拉菜单打开或者关闭前校验
* @default false
*/
useBeforeToggle?: boolean;
}
/**
* @deprecated
*/
export interface VantDropdownItemChangeEvent extends WechatMiniprogram.BaseEvent {
/**
* 当前选中的 value
*/
detail: number | string;
}
export interface VantDropdownItemEvents {
/**
* 点击选项导致 `value` 变化时触发
*/
onChange?: VantEventHandler<number | string>;
/**
* 打开菜单栏时触发
*/
opOpen?: VantEventHandler;
/**
* 关闭菜单栏时触发
*/
onClose?: VantEventHandler;
/**
* 打开菜单栏且动画结束后触发
*/
opOpened?: VantEventHandler;
/**
* 关闭菜单栏且动画结束后触发
*/
onClosed?: VantEventHandler;
/**
* 下拉菜单打开或者关闭前触发,需要将use-before-toggle属性设置为true
*/
onBeforeToggle?: VantEventHandler<{
status: boolean;
callback: (value: boolean) => Promise<boolean>;
}>;
}
export type VantDropdownItem = VantComponent<VantDropdownItemProps, VantDropdownItemEvents>;