tdesign-react/cjs/dropdown/type.d.ts

TDesign Component for React

/**
 * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
 * */
import { PopupProps } from '../popup';
import { TNode, TElement } from '../common';
import { MouseEvent } from 'react';
export interface TdDropdownProps {
    /**
     * 多层级操作时，子层级展开方向
     * @default right
     */
    direction?: 'left' | 'right';
    /**
     * 是否禁用组件
     * @default false
     */
    disabled?: boolean;
    /**
     * 点击选项后是否自动隐藏弹窗
     * @default true
     */
    hideAfterItemClick?: boolean;
    /**
     * 选项最大宽度，内容超出时，显示为省略号。值为字符串时，值就是最大宽度；值为数字时，单位：px
     * @default 100
     */
    maxColumnWidth?: string | number;
    /**
     * 弹窗最大高度，单位：px 。统一控制每一列的高度
     * @default 300
     */
    maxHeight?: number;
    /**
     * 选项最小宽度。值为字符串时，值就是最小宽度；值为数字时，单位：px
     * @default 10
     */
    minColumnWidth?: string | number;
    /**
     * 下拉操作项
     * @default []
     */
    options?: Array<DropdownOption>;
    /**
     * 面板内的底部内容
     */
    panelBottomContent?: TNode;
    /**
     * 面板内的顶部内容
     */
    panelTopContent?: TNode;
    /**
     * 弹窗定位方式，可选值同 Popup 组件
     * @default bottom-left
     */
    placement?: 'top' | 'left' | 'right' | 'bottom' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom';
    /**
     * 透传  Popup 组件属性，方便更加自由地控制。比如使用 `popupProps.overlayStyle` 设置浮层样式
     */
    popupProps?: PopupProps;
    /**
     * 触发下拉显示的方式
     * @default hover
     */
    trigger?: 'hover' | 'click' | 'focus' | 'context-menu';
    /**
     * 下拉操作项点击时触发
     */
    onClick?: (dropdownItem: DropdownOption, context: {
        e: MouseEvent<HTMLDivElement>;
    }) => void;
}
export interface TdDropdownItemProps {
    /**
     * 是否高亮当前操作项
     * @default false
     */
    active?: boolean;
    /**
     * 下拉操作项内容
     * @default ''
     */
    content?: TNode;
    /**
     * 是否禁用操作项
     * @default false
     */
    disabled?: boolean;
    /**
     * 是否显示操作项之间的分隔线（分隔线默认在下方）
     * @default false
     */
    divider?: boolean;
    /**
     * 组件前置图标
     */
    prefixIcon?: TElement;
    /**
     * 下拉菜单选项主题
     * @default default
     */
    theme?: DropdownItemTheme;
    /**
     * 下拉操作项唯一标识
     */
    value?: string | number | {
        [key: string]: any;
    };
    /**
     * 点击时触发
     */
    onClick?: (dropdownItem: DropdownOption, context: {
        e: MouseEvent<HTMLDivElement>;
    }) => void;
}
export type DropdownOption = {
    children?: Array<TdDropdownItemProps>;
} & TdDropdownItemProps & Record<string, any>;
export type DropdownItemTheme = 'default' | 'success' | 'warning' | 'error';