vxe-table

vxe-table

Version 4.6.25
Published 21 days ago
10.8 MB
2 dependencies
MIT license

Install

npm i vxe-table

yarn add vxe-table

pnpm add vxe-table

Overview

一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟树、列拖拽，懒加载、快捷菜单、数据校验、树形结构、打印导出、自定义模板、渲染器、JSON 配置式...

Index

Variables

Variables

variable Button

const Button: VXEComponent<VxeButtonProps, VxeButtonEventProps, VxeButtonSlots>;

组件 - 按钮

variable ButtonGroup

const ButtonGroup: VXEComponent<
    VxeButtonGroupProps,
    VxeButtonGroupEventProps,
    VxeButtonGroupSlots
>;

组件 - 按钮组

variable Checkbox

const Checkbox: VXEComponent<
    VxeCheckboxProps,
    VxeCheckboxEventProps,
    VxeCheckboxSlots
>;

组件 - 复选框

variable CheckboxGroup

const CheckboxGroup: VXEComponent<
    VxeCheckboxGroupProps,
    VxeCheckboxGroupEventProps,
    VxeCheckboxGroupSlots
>;

组件 - 复选框组

variable Colgroup

const Colgroup: VXEComponent<
    VxeColgroupProps,
    VxeColgroupEventProps,
    VxeColgroupSlots<any>
>;

组件 - 表格分组列

variable Column

const Column: VXEComponent<
    VxeColumnProps<any>,
    VxeColumnEventProps,
    VxeColumnSlots<any>
>;

组件 - 表格列

variable commands

const commands: VxeGlobalCommands;

variable config

const config: VXETableGlobalConfig;

请使用 setConfig
Deprecated

variable Custom

const Custom: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 自定义列

variable drawer

const drawer: DrawerController;

variable Drawer

const Drawer: VXEComponent<
    VxeDrawerProps,
    VxeDrawerEventProps,
    { [key: string]: (...args: any[]) => any }
>;

variable Edit

const Edit: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 可编辑

variable Export

const Export: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 导出、导入、打印

variable Filter

const Filter: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 筛选

variable Form

const Form: VXEComponent<
    VxeFormProps<any>,
    VxeFormEventProps,
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单

variable formats

const formats: VxeGlobalFormats;

variable FormGather

const FormGather: VXEComponent<
    VxeFormGatherProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单项集合

variable FormItem

const FormItem: VXEComponent<
    VxeFormItemProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单项

variable getTheme

const getTheme: VxeGlobalGetThemeMethod;

variable globalConfs

const globalConfs: VXETableConfig;

已废弃
Deprecated

variable globalStore

const globalStore: VxeGlobalStore;

variable Grid

const Grid: VXEComponent<
    VxeGridProps<any>,
    VxeGridEventProps<any>,
    VxeGridSlots<any>
>;

组件 - 配置式表格

variable hooks

const hooks: VxeGlobalHooks;

variable Icon

const Icon: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 图标

variable Input

const Input: VXEComponent<VxeInputProps, VxeInputEventProps, VxeInputSlots>;

组件 - 输入框

variable interceptor

const interceptor: VxeGlobalInterceptor;

variable Keyboard

const Keyboard: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 键盘导航

variable List

const List: VXEComponent<VxeListProps<any>, VxeListEventProps, VxeListSlots>;

组件 - 虚拟列表

variable Loading

const Loading: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 加载中

const Menu: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 快捷菜单

variable menus

const menus: VxeGlobalMenus;

const modal: ModalController;

const Modal: VXEComponent<VxeModalProps, VxeModalEventProps, VxeModalSlots>;

组件 - 弹窗

variable Optgroup

const Optgroup: VXEComponent<
    VxeOptgroupProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 下拉框选项分组

variable Option

const Option: VXEComponent<
    VxeOptionProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 下拉框选项

const Pager: VXEComponent<VxePagerProps, VxePagerEventProps, VxePagerSlots>;

组件 - 分页

variable print

const print: PrintFunction;

variable Pulldown

const Pulldown: VXEComponent<
    VxePulldownProps,
    VxePulldownEventProps,
    VxePulldownSlots
>;

组件 - 下拉容器

variable Radio

const Radio: VXEComponent<VxeRadioProps, VxeRadioEventProps, VxeRadioSlots>;

组件 - 单选框

variable RadioButton

const RadioButton: VXEComponent<
    VxeRadioButtonProps,
    VxeRadioButtonEventProps,
    VxeRadioButtonSlots
>;

组件 - 单选框按钮

variable RadioGroup

const RadioGroup: VXEComponent<
    VxeRadioGroupProps,
    VxeRadioGroupEventProps,
    VxeRadioGroupSlots
>;

组件 - 单选框组

variable readFile

const readFile: ReadFileFunction;

variable renderer

const renderer: VxeGlobalRenderer;

variable saveFile

const saveFile: SaveFileFunction;

variable Select

const Select: VXEComponent<VxeSelectProps, VxeSelectEventProps, VxeSelectSlots>;

组件 - 下拉框

variable setConfig

const setConfig: VxeGlobalConfigMethod;

variable setTheme

const setTheme: VxeGlobalThemeMethod;

variable setup

const setup: VXETableSetupOptions;

请使用 setConfig
Deprecated

variable Switch

const Switch: VXEComponent<VxeSwitchProps, VxeSwitchEventProps, VxeSwitchSlots>;

组件 - 开关

variable t

const t: VxeGlobalI18n;

variable Table

const Table: VXEComponent<
    VxeTableProps<any>,
    VxeTableEventProps<any>,
    VxeTableSlots<any>
>;

组件 - 表格

variable Textarea

const Textarea: VXEComponent<
    VxeTextareaProps,
    VxeTextareaEventProps,
    VxeTextareaSlots
>;

组件 - 文本域

const Toolbar: VXEComponent<VxeToolbarProps, VxeToolbarEventProps, VxeToolbarSlots>;

组件 - 工具栏

const Tooltip: VXEComponent<VxeTooltipProps, VxeTooltipEventProps, VxeTooltipSlots>;

组件 - 工具提示

variable use

const use: VxeGlobalUse;

variable v

const v: VXETableVersion;

variable Validator

const Validator: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 校验模块

variable validators

const validators: VxeGlobalValidators;

variable VxeButton

const VxeButton: VXEComponent<VxeButtonProps, VxeButtonEventProps, VxeButtonSlots>;

组件 - 按钮
Example 1
import { VxeButton } from 'vxe-table'

variable VxeButtonGroup

const VxeButtonGroup: VXEComponent<
    VxeButtonGroupProps,
    VxeButtonGroupEventProps,
    VxeButtonGroupSlots
>;

组件 - 按钮组
Example 1
import { VxeButtonGroup } from 'vxe-table'

variable VxeCheckbox

const VxeCheckbox: VXEComponent<
    VxeCheckboxProps,
    VxeCheckboxEventProps,
    VxeCheckboxSlots
>;

组件 - 复选框
Example 1
import { VxeCheckbox } from 'vxe-table'

variable VxeCheckboxGroup

const VxeCheckboxGroup: VXEComponent<
    VxeCheckboxGroupProps,
    VxeCheckboxGroupEventProps,
    VxeCheckboxGroupSlots
>;

组件 - 复选框组
Example 1
import { VxeCheckboxGroup } from 'vxe-table'

variable VxeColgroup

const VxeColgroup: VXEComponent<
    VxeColgroupProps,
    VxeColgroupEventProps,
    VxeColgroupSlots<any>
>;

组件 - 表格分组列
Example 1
import { VxeColgroup } from 'vxe-table'

variable VxeColumn

const VxeColumn: VXEComponent<
    VxeColumnProps<any>,
    VxeColumnEventProps,
    VxeColumnSlots<any>
>;

组件 - 表格列
Example 1
import { VxeColumn } from 'vxe-table'

variable VxeDrawer

const VxeDrawer: VXEComponent<
    VxeDrawerProps,
    VxeDrawerEventProps,
    { [key: string]: (...args: any[]) => any }
>;

variable VxeForm

const VxeForm: VXEComponent<
    VxeFormProps<any>,
    VxeFormEventProps,
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单
Example 1
import { VxeForm } from 'vxe-table'

variable VxeFormGather

const VxeFormGather: VXEComponent<
    VxeFormGatherProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单项集合
Example 1
import { VxeFormGather } from 'vxe-table'

variable VxeFormItem

const VxeFormItem: VXEComponent<
    VxeFormItemProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 表单项
Example 1
import { VxeFormItem } from 'vxe-table'

variable VxeGrid

const VxeGrid: VXEComponent<
    VxeGridProps<any>,
    VxeGridEventProps<any>,
    VxeGridSlots<any>
>;

组件 - 配置式表格
Example 1
import { VxeGrid } from 'vxe-table'

variable VxeIcon

const VxeIcon: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 图标
Example 1
import { VxeIcon } from 'vxe-table'

variable VxeInput

const VxeInput: VXEComponent<VxeInputProps, VxeInputEventProps, VxeInputSlots>;

组件 - 输入框
Example 1
import { VxeInput } from 'vxe-table'

variable VxeList

const VxeList: VXEComponent<VxeListProps<any>, VxeListEventProps, VxeListSlots>;

组件 - 虚拟列表
Example 1
import { VxeList } from 'vxe-table'

variable VxeLoading

const VxeLoading: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 加载中

variable VxeModal

const VxeModal: VXEComponent<VxeModalProps, VxeModalEventProps, VxeModalSlots>;

组件 - 弹窗
Example 1
import { VxeModal } from 'vxe-table'

variable VxeOptgroup

const VxeOptgroup: VXEComponent<
    VxeOptgroupProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 下拉框选项分组
Example 1
import { VxeOptgroup } from 'vxe-table'

variable VxeOption

const VxeOption: VXEComponent<
    VxeOptionProps,
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

组件 - 下拉框选项
Example 1
import { VxeOption } from 'vxe-table'

variable VxePager

const VxePager: VXEComponent<VxePagerProps, VxePagerEventProps, VxePagerSlots>;

组件 - 分页
Example 1
import { VxePager } from 'vxe-table'

variable VxePulldown

const VxePulldown: VXEComponent<
    VxePulldownProps,
    VxePulldownEventProps,
    VxePulldownSlots
>;

组件 - 下拉容器
Example 1
import { Pulldown as VxePulldown } from 'vxe-table'

variable VxeRadio

const VxeRadio: VXEComponent<VxeRadioProps, VxeRadioEventProps, VxeRadioSlots>;

组件 - 单选框
Example 1
import { VxeRadio } from 'vxe-table'

variable VxeRadioButton

const VxeRadioButton: VXEComponent<
    VxeRadioButtonProps,
    VxeRadioButtonEventProps,
    VxeRadioButtonSlots
>;

组件 - 单选框按钮
Example 1
import { VxeRadioButton } from 'vxe-table'

variable VxeRadioGroup

const VxeRadioGroup: VXEComponent<
    VxeRadioGroupProps,
    VxeRadioGroupEventProps,
    VxeRadioGroupSlots
>;

组件 - 单选框组
Example 1
import { VxeRadioGroup } from 'vxe-table'

variable VxeSelect

const VxeSelect: VXEComponent<VxeSelectProps, VxeSelectEventProps, VxeSelectSlots>;

组件 - 下拉框
Example 1
import { VxeSelect } from 'vxe-table'

variable VxeSwitch

const VxeSwitch: VXEComponent<VxeSwitchProps, VxeSwitchEventProps, VxeSwitchSlots>;

组件 - 开关
Example 1
import { VxeSwitch } from 'vxe-table'

variable VxeTable

const VxeTable: VXEComponent<
    VxeTableProps<any>,
    VxeTableEventProps<any>,
    VxeTableSlots<any>
>;

组件 - 表格
Example 1
import { VxeTable } from 'vxe-table'

variable VXETable

const VXETable: VXETableCore;

一个基于 vue 的 PC 端表单/表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、JSON 配置式...

variable VxeTableCustomModule

const VxeTableCustomModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 自定义列

variable VxeTableEditModule

const VxeTableEditModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 可编辑

variable VxeTableExportModule

const VxeTableExportModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 导出、导入、打印

variable VxeTableFilterModule

const VxeTableFilterModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 筛选

variable VxeTableKeyboardModule

const VxeTableKeyboardModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 键盘导航

variable VxeTableMenuModule

const VxeTableMenuModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 快捷菜单

variable VxeTableValidatorModule

const VxeTableValidatorModule: VXEComponent<
    { [key: string]: any },
    { [key: string]: any },
    { [key: string]: (...args: any[]) => any }
>;

表格模块 - 校验模块

variable VxeTextarea

const VxeTextarea: VXEComponent<
    VxeTextareaProps,
    VxeTextareaEventProps,
    VxeTextareaSlots
>;

组件 - 文本域
Example 1
import { VxeTextarea } from 'vxe-table'

variable VxeToolbar

const VxeToolbar: VXEComponent<
    VxeToolbarProps,
    VxeToolbarEventProps,
    VxeToolbarSlots
>;

组件 - 工具栏
Example 1
import { VxeToolbar } from 'vxe-table'

variable VxeTooltip

const VxeTooltip: VXEComponent<
    VxeTooltipProps,
    VxeTooltipEventProps,
    VxeTooltipSlots
>;

组件 - 工具提示
Example 1
import { VxeTooltip } from 'vxe-table'

variable VxeUI

const VxeUI: VXETableCore;

Functions

function component

component: (comp: any) => any;

function getComponent

getComponent: (name: string) => any;

function install

install: (app: App, options?: VXETableConfigOptions) => void;

function setIcon

setIcon: (options?: VxeGlobalIcon) => VXETableCore;

Classes

class VXETableConfig

class VXETableConfig {}

property clipboard

clipboard: { text: string; html: string };

property exportTypes

readonly exportTypes: string[];

获取导出的所有文件类型

property importTypes

readonly importTypes: string[];

获取导入的所有文件类型

property nextZIndex

readonly nextZIndex: number;

property zIndex

readonly zIndex: number;

Interfaces

interface ButtonGroupMethods

interface ButtonGroupMethods {}

method dispatchEvent

dispatchEvent: (
    type: ValueOf<VxeButtonGroupEmits>,
    params: any,
    evnt: Event
) => void;

interface ButtonGroupPrivateMethods

interface ButtonGroupPrivateMethods {}

method handleClick

handleClick: (params: { name: VxeButtonPropTypes.Name }, evnt: Event) => void;

interface ButtonInternalData

interface ButtonInternalData {}

property showTime

showTime: any;

interface ButtonMethods

interface ButtonMethods {}

method blur

blur: () => Promise<any>;

失去焦点

method dispatchEvent

dispatchEvent: (type: ValueOf<VxeButtonEmits>, params: any, evnt: Event) => void;

method focus

focus: () => Promise<any>;

获取焦点

interface ButtonPrivateComputed

interface ButtonPrivateComputed {}

interface ButtonPrivateMethods

interface ButtonPrivateMethods {}

interface ButtonPrivateRef

interface ButtonPrivateRef {}

property refElem

refElem: Ref<HTMLDivElement>;

interface ButtonReactData

interface ButtonReactData {}

property animatVisible

animatVisible: boolean;

property inited

inited: boolean;

property panelIndex

panelIndex: number;

property panelPlacement

panelPlacement: any;

property panelStyle

panelStyle: VNodeStyle;

property showPanel

showPanel: boolean;

interface CheckboxGroupMethods

interface CheckboxGroupMethods {}

method dispatchEvent

dispatchEvent: (
    type: ValueOf<VxeCheckboxGroupEmits>,
    params: any,
    evnt: Event
) => void;

interface CheckboxGroupPrivateMethods

interface CheckboxGroupPrivateMethods {}

method handleChecked

handleChecked: (
    params: {
        checked: boolean;
        value: VxeCheckboxPropTypes.ModelValue;
        label: VxeCheckboxPropTypes.Label;
    },
    evnt: Event
) => void;

interface CheckboxMethods

interface CheckboxMethods {}

method dispatchEvent

dispatchEvent: (
    type: ValueOf<VxeCheckboxEmits>,
    params: any,
    evnt: Event
) => void;

interface CheckboxPrivateComputed

interface CheckboxPrivateComputed {}

property computeIsMaximize

computeIsMaximize: ComputedRef<boolean>;

interface CheckboxPrivateMethods

interface CheckboxPrivateMethods {}

interface DefineRendererOption

interface DefineRendererOption<T> {}

property autofocus

autofocus?:
    | string
    | ((
          params:
              | VxeGlobalRendererHandles.RenderEditParams<any>
              | VxeGlobalRendererHandles.RenderCellParams<any>
      ) => HTMLElement | null);

property autoselect

autoselect?: boolean;

property cellClassName

cellClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderDefaultParams<any>
      ) => string | VNodeClassName);

property cellStyle

cellStyle?:
    | VNodeStyle
    | ((
          params: VxeGlobalRendererHandles.RenderDefaultParams<any>
      ) => VNodeStyle);

property className

className?: string;

Deprecated
已废弃

property filterClassName

filterClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderFilterParams<any>
      ) => string | VNodeClassName);

property itemClassName

itemClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderItemTitleParams
      ) => string | VNodeClassName);

property itemContentClassName

itemContentClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderItemTitleParams
      ) => string | VNodeClassName);

property itemContentStyle

itemContentStyle?:
    | VNodeStyle
    | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => VNodeStyle);

property itemStyle

itemStyle?:
    | VNodeStyle
    | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => VNodeStyle);

property itemTitleClassName

itemTitleClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderItemTitleParams
      ) => string | VNodeClassName);

property itemTitleStyle

itemTitleStyle?:
    | VNodeStyle
    | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => VNodeStyle);

property showFilterFooter

showFilterFooter?: boolean;

property toolbarButtonClassName

toolbarButtonClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderButtonParams<any>
      ) => string | VNodeClassName);

property toolbarToolClassName

toolbarToolClassName?:
    | string
    | ((
          params: VxeGlobalRendererHandles.RenderToolParams<any>
      ) => string | VNodeClassName);

method defaultFilterMethod

defaultFilterMethod: (
    params: VxeGlobalRendererHandles.FilterMethodParams<any>
) => boolean;

method exportMethod

exportMethod: (
    params: VxeGlobalRendererHandles.ExportMethodParams<any>
) => string;

method filterMethod

filterMethod: (
    params: VxeGlobalRendererHandles.FilterMethodParams<any>
) => boolean;

method filterRecoverMethod

filterRecoverMethod: (
    params: VxeGlobalRendererHandles.FilterRecoverMethodParams<any>
) => void;

method filterRemoteMethod

filterRemoteMethod: (
    params: VxeGlobalRendererHandles.FilterRemoteMethod<any>
) => boolean;

method filterResetMethod

filterResetMethod: (
    params: VxeGlobalRendererHandles.FilterResetMethodParams<any>
) => void;

method footerExportMethod

footerExportMethod: (
    params: VxeGlobalRendererHandles.FooterExportMethodParams<any>
) => string;

method itemResetMethod

itemResetMethod: (
    params: VxeGlobalRendererHandles.ItemResetMethodParams
) => void;

method itemVisibleMethod

itemVisibleMethod: (
    params: VxeGlobalRendererHandles.ItemVisibleMethodParams
) => boolean;

method renderCell

renderCell: (
    renderOpts: VxeGlobalRendererHandles.RenderCellOptions<any>,
    params: VxeGlobalRendererHandles.RenderCellParams<any>
) => T;

method renderDefault

renderDefault: (
    renderOpts: VxeGlobalRendererHandles.RenderDefaultOptions,
    params: VxeGlobalRendererHandles.RenderDefaultParams<any>
) => T;

method renderEdit

renderEdit: (
    renderOpts: VxeGlobalRendererHandles.RenderEditOptions<any>,
    params: VxeGlobalRendererHandles.RenderEditParams<any>
) => T;

method renderEmpty

renderEmpty: (
    renderOpts: VxeGlobalRendererHandles.RenderTableEmptyViewOptions,
    params: VxeGlobalRendererHandles.RenderEmptyParams
) => T;

已废弃，请使用 renderTableEmptyView
Deprecated

method renderExpand

renderExpand: (
    renderOpts: VxeGlobalRendererHandles.RenderExpandOptions,
    params: VxeGlobalRendererHandles.RenderExpandParams<any>
) => T;

method renderFilter

renderFilter: (
    renderOpts: VxeGlobalRendererHandles.RenderFilterOptions,
    params: VxeGlobalRendererHandles.RenderFilterParams<any>
) => T;

method renderFooter

renderFooter: (
    renderOpts: VxeGlobalRendererHandles.RenderFooterOptions,
    params: VxeGlobalRendererHandles.RenderFooterParams<any>
) => T;

method renderHeader

renderHeader: (
    renderOpts: VxeGlobalRendererHandles.RenderHeaderOptions,
    params: VxeGlobalRendererHandles.RenderHeaderParams<any>
) => T;

method renderItemContent

renderItemContent: (
    renderOpts: VxeGlobalRendererHandles.RenderItemContentOptions,
    params: VxeGlobalRendererHandles.RenderItemContentParams
) => T;

method renderItemTitle

renderItemTitle: (
    renderOpts: VxeGlobalRendererHandles.RenderItemTitleOptions,
    params: VxeGlobalRendererHandles.RenderItemTitleParams
) => T;

method renderTableEmptyView

renderTableEmptyView: (
    renderOpts: VxeGlobalRendererHandles.RenderTableEmptyViewOptions,
    params: VxeGlobalRendererHandles.RenderEmptyParams
) => T;

method renderToolbarButton

renderToolbarButton: (
    renderOpts: VxeGlobalRendererHandles.RenderButtonOptions,
    params: VxeGlobalRendererHandles.RenderButtonParams<any>
) => T;

method renderToolbarTool

renderToolbarTool: (
    renderOpts: VxeGlobalRendererHandles.RenderToolOptions,
    params: VxeGlobalRendererHandles.RenderToolParams<any>
) => T;

interface DrawerController

interface DrawerController {}

全局窗口控制器

method close

close: (id?: VxeDrawerPropTypes.ID) => Promise<any>;

关闭动态的活动窗口，如果为空则关闭所有
Parameter id
窗口唯一标识

method get

get: (id: string) => VxeDrawerConstructor & VxeDrawerMethods;

获取动态的活动窗口
Parameter id
窗口唯一标识

method open

open: (options: VxeDrawerDefines.DrawerOptions) => Promise<DrawerEventTypes>;

创建窗口
Parameter options
参数

interface DrawerMethods

interface DrawerMethods {}

method close

close: () => Promise<any>;

手动关闭窗口

method dispatchEvent

dispatchEvent: (
    type: ValueOf<VxeDrawerEmits>,
    params: any,
    evnt?: Event
) => void;

method getBox

getBox: () => HTMLElement;

获取当前窗口元素

method open

open: () => Promise<any>;

手动打开窗口

interface DrawerPrivateComputed

interface DrawerPrivateComputed {}

interface DrawerPrivateMethods

interface DrawerPrivateMethods {}

interface DrawerPrivateRef

interface DrawerPrivateRef {}

property refElem

refElem: Ref<HTMLDivElement | undefined>;

interface DrawerReactData

interface DrawerReactData {}

property contentVisible

contentVisible: boolean;

property drawerZIndex

drawerZIndex: number;

property firstOpen

firstOpen: boolean;

property inited

inited: boolean;

property visible

visible: boolean;

interface FormInternalData

interface FormInternalData {}

property tooltipStore

tooltipStore: {
    item: VxeFormDefines.ItemInfo | null;
    visible: boolean;
};

property tooltipTimeout

tooltipTimeout: any;

interface FormItemContentRenderParams

interface FormItemContentRenderParams {}

项内容渲染参数

property $form

$form: VxeFormConstructor;

property $grid

$grid: VxeGridConstructor | null;

property data

data: any;

property field

field: string;

property item

item: VxeFormDefines.ItemInfo;

property property

property: string;

Deprecated

interface FormItemRenderOptions

interface FormItemRenderOptions extends VxeGlobalRendererHandles.RenderOptions {}

项渲染配置项

property autofocus

autofocus?: string;

property content

content?: string;

渲染组件的内容（需要渲染器支持）

property defaultValue

defaultValue?:
    | ((params: { item: VxeFormItemProps }) => any)
    | null
    | undefined
    | string
    | number
    | RegExp
    | object
    | any[]
    | Date;

property optionGroupProps

optionGroupProps?: VxeGlobalRendererHandles.RenderOptionGroupProps;

下拉分组选项属性参数配置（需要渲染器支持）

property optionGroups

optionGroups?: any[];

下拉分组选项列表（需要渲染器支持）

property optionProps

optionProps?: VxeGlobalRendererHandles.RenderOptionProps;

下拉选项属性参数配置（需要渲染器支持）

property options

options?: any[];

下拉选项列表（需要渲染器支持）

interface FormItemResetParams

interface FormItemResetParams {}

项重置方法参数

property $form

$form: VxeFormConstructor;

property $grid

$grid: VxeGridConstructor | null;

property data

data: any;

property field

field: string;

property item

item: VxeFormDefines.ItemInfo;

property property

property: string;

Deprecated

interface FormItemTitleRenderParams

interface FormItemTitleRenderParams {}

项标题渲染参数

property $form

$form: VxeFormConstructor;

property $grid

$grid: VxeGridConstructor | null;

property data

data: any;

property field

field: string;

property item

item: VxeFormDefines.ItemInfo;

property property

property: string;

Deprecated

interface FormItemVisibleParams

interface FormItemVisibleParams {}

项可视方法参数

property $form

$form: VxeFormConstructor;

property $grid

$grid: VxeGridConstructor | null;

property data

data: any;

property field

field: string;

property item

item: VxeFormDefines.ItemInfo;

property property

property: string;

Deprecated

interface FormMethods

interface FormMethods {}

method clearValidate

clearValidate: (
    field?:
        | VxeFormItemPropTypes.Field
        | VxeFormItemPropTypes.Field[]
        | VxeFormDefines.ItemInfo
        | VxeFormDefines.ItemInfo[]
) => Promise<any>;

手动清除校验状态，如果指定 field 则清除指定的项，否则清除整个表单
Parameter field
字段名

method closeTooltip

closeTooltip: () => Promise<any>;

关闭 tooltip 提示

method dispatchEvent

dispatchEvent: (type: ValueOf<VxeFormEmits>, params: any, evnt: Event) => void;

method getItemByField

getItemByField: (
    field: VxeFormItemPropTypes.Field
) => VxeFormDefines.ItemInfo | null;

根据列的字段名获取表单项
Parameter field
字段名

method getItems

getItems: () => VxeFormDefines.ItemInfo[];

获取表单项列表

method reset

reset: () => Promise<any>;

重置表单

method toggleCollapse

toggleCollapse: () => Promise<any>;

手动切换折叠状态

method updateStatus

updateStatus: (
    params: { field: VxeFormItemPropTypes.Field },
    itemValue?: any
) => void;

更新项状态当使用自定义渲染时可能会用到
Parameter params
插槽对象

method validate

validate: (
    callback?: (errMap?: VxeFormDefines.ValidateErrorMapParams) => void
) => Promise<VxeFormDefines.ValidateErrorMapParams>;

对表单进行校验，参数为一个回调函数。该回调函数会在校验结束后被调用 callback(errMap)。若不传入回调函数，则会返回一个 promise
Parameter callback
回调函数

method validateField

validateField: (
    field:
        | VxeFormItemPropTypes.Field
        | VxeFormItemPropTypes.Field[]
        | VxeFormDefines.ItemInfo
        | VxeFormDefines.ItemInfo[],
    callback?: (errMap?: VxeFormDefines.ValidateErrorMapParams) => void
) => Promise<VxeFormDefines.ValidateErrorMapParams>;

对表单指定项进行校验，参数为一个回调函数。该回调函数会在校验结束后被调用 callback(errMap)。若不传入回调函数，则会返回一个 promise
Parameter callback
回调函数

interface FormPrivateComputed

interface FormPrivateComputed {}

vxe-table

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable Button

variable ButtonGroup

variable Checkbox

variable CheckboxGroup

variable Colgroup

variable Column

variable commands

variable config

Deprecated

variable Custom

variable drawer

variable Drawer

variable Edit

variable Export

variable Filter

variable Form

variable formats

variable FormGather

variable FormItem

variable getTheme

variable globalConfs

Deprecated

variable globalStore

variable Grid

variable hooks

variable Icon

variable Input

variable interceptor

variable Keyboard

variable List

variable Loading

variable Menu

variable menus

variable modal

variable Modal

variable Optgroup

variable Option

variable Pager

variable print

variable Pulldown

variable Radio

variable RadioButton

variable RadioGroup

variable readFile

variable renderer

variable saveFile

variable Select

variable setConfig

variable setTheme

variable setup

Deprecated

variable Switch

variable t

variable Table

variable Textarea

variable Toolbar

variable Tooltip

variable use

variable v

variable Validator

variable validators

variable VxeButton

Example 1

variable VxeButtonGroup

Example 1

variable VxeCheckbox

Example 1

variable VxeCheckboxGroup

Example 1