@vtj / Modules / ui

Module: ui

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ActionBarEmits

Ƭ ActionBarEmits: Object

Type declaration

Name	Type
`click`	[action: ActionProps]
`command`	[action: ActionProps, menu: ActionMenuItem]

Defined in

packages/ui/types/components/action-bar/types.d.ts:121

ActionBarItem

Ƭ ActionBarItem: ActionProps & { [key: string]: any; }

Defined in

packages/ui/types/components/action-bar/types.d.ts:8

ActionBarItems

Ƭ ActionBarItems: (ActionBarItem | "|")[]

Defined in

packages/ui/types/components/action-bar/types.d.ts:11

ActionBarProps

Ƭ ActionBarProps: ComponentPropsType<typeof actionBarProps> & ContainerProps

Defined in

packages/ui/types/components/action-bar/types.d.ts:120

ActionDropdown

Ƭ ActionDropdown: Partial<ExtractPropTypes<typeof dropdownProps>>

Defined in

packages/ui/types/components/action/types.d.ts:17

ActionEmits

Ƭ ActionEmits: Object

Type declaration

Name	Type
`click`	[props: ActionProps]
`command`	[item: ActionMenuItem]
`dragend`	[props: ActionProps, e: any]
`dragstart`	[props: ActionProps, e: any]

Defined in

packages/ui/types/components/action/types.d.ts:154

ActionMode

Ƭ ActionMode: "button" | "text" | "icon"

Defined in

packages/ui/types/components/action/types.d.ts:8

ActionProps

Ƭ ActionProps: ComponentPropsType<typeof actionProps>

Defined in

packages/ui/types/components/action/types.d.ts:153

AttachmentEmits

Ƭ AttachmentEmits: Object

Type declaration

Name	Type
`change`	[files: AttachmentFile[]]
`click`	[file: AttachmentFile]
`download`	[file: AttachmentFile]
`preview`	[file: AttachmentFile]
`remove`	[file: AttachmentFile]
`select`	[files: AttachmentFile[]]
`update:modelValue`	[files: AttachmentFile[]]
`update:selectValue`	[files: AttachmentFile \| AttachmentFile[]]

Defined in

packages/ui/types/components/attachment/types.d.ts:14

AttachmentFileType

Ƭ AttachmentFileType: "img" | "css" | "excel" | "word" | "ppt" | "pdf" | "js" | "zip" | "video" | "audio" | "unknow"

Defined in

packages/ui/types/components/attachment/types.d.ts:5

AttachmentProps

Ƭ AttachmentProps: ComponentPropsType<typeof attachmentProps>

Defined in

packages/ui/types/components/attachment/types.d.ts:13

AttachmentThumbnail

Ƭ AttachmentThumbnail: (file: AttachmentFile) => string

Type declaration

▸ (file): string

Parameters

Name	Type
`file`	`AttachmentFile`

Returns

string

Defined in

packages/ui/types/components/attachment/types.d.ts:12

AttachmentUploader

Ƭ AttachmentUploader: (file: File) => Promise<string | AttachmentFile | null>

Type declaration

▸ (file): Promise<string | AttachmentFile | null>

Parameters

Name	Type
`file`	`File`

Returns

Promise<string | AttachmentFile | null>

Defined in

packages/ui/types/components/attachment/types.d.ts:11

BaseSize

Ƭ BaseSize: "large" | "default" | "small"

Defined in

packages/ui/types/components/shared.d.ts:21

BaseType

Ƭ BaseType: "primary" | "success" | "warning" | "danger" | "info"

Defined in

packages/ui/types/components/shared.d.ts:22

BuiltinFieldEditorType

Defined in

packages/ui/types/components/field/builtin.d.ts:6

ComponentPropsType

Ƭ ComponentPropsType<T>: Readonly<Partial<ExtractPropTypes<T>>>

Type parameters

Name
`T`

Defined in

packages/ui/types/components/shared.d.ts:17

ContainerAlignContent

Defined in

packages/ui/types/components/container/types.d.ts:9

ContainerAlignItems

Ƭ ContainerAlignItems: "flex-start" | "flex-end" | "center" | "baseline" | "stretch"

Defined in

packages/ui/types/components/container/types.d.ts:8

ContainerDirection

Ƭ ContainerDirection: "row" | "row-reverse" | "column" | "column-reverse"

Defined in

packages/ui/types/components/container/types.d.ts:5

ContainerInstance

Ƭ ContainerInstance: InstanceType<typeof XContainer>

Defined in

packages/ui/types/components/container/types.d.ts:127

ContainerJustifyContent

Ƭ ContainerJustifyContent: "flex-start" | "flex-end" | "center" | "space-between" | "space-around"

Defined in

packages/ui/types/components/container/types.d.ts:7

ContainerProps

Ƭ ContainerProps: ComponentPropsType<typeof containerProps>

Defined in

packages/ui/types/components/container/types.d.ts:126

ContainerWrap

Ƭ ContainerWrap: "nowrap" | "wrap" | "wrap-reverse"

Defined in

packages/ui/types/components/container/types.d.ts:6

CreateDialogProps

Ƭ CreateDialogProps: DialogProps & { [index: string]: any; }

Defined in

packages/ui/types/components/dialog/create.d.ts:4

DataItemEmits

Ƭ DataItemEmits: Object

Type declaration

Name	Type
`actionClick`	[action: ActionProps]
`actionCommand`	[action: ActionProps, menu: ActionMenuItem]
`imageClick`	[]
`titleClick`	[]

Defined in

packages/ui/types/components/data-item/types.d.ts:45

DataItemProps

Ƭ DataItemProps: ComponentPropsType<typeof dataItemProps>

Defined in

packages/ui/types/components/data-item/types.d.ts:44

DataLoader

Ƭ DataLoader<T, P>: T | (params?: P) => T | Promise<T>

Type parameters

Name	Type
`T`	`any`
`P`	`any`

Defined in

packages/ui/types/components/shared.d.ts:28

DialogEmits

Ƭ DialogEmits: Object

Type declaration

Name	Type
`cancel`	[]
`close`	[]
`destroy`	[]
`dragEnd`	[position: Position]
`dragStart`	[position: Position]
`dragging`	[position: Position]
`maximized`	[]
`minimized`	[]
`modeChange`	[mode: DialogMode]
`normal`	[]
`open`	[instance: ComponentInternalInstance]
`resizeEnd`	[dir: string, mie: UseMouseInElementReturn]
`resizeStart`	[dir: string, mie: UseMouseInElementReturn]
`resizing`	[dir: string, mie: UseMouseInElementReturn]
`submit`	[]
`update:modelValue`	[value: boolean]

Defined in

packages/ui/types/components/dialog/types.d.ts:96

DialogFormEmits

Ƭ DialogFormEmits: Object

Type declaration

Name	Type
`close`	[]
`submit`	[model: Record<string, any>]
`update:modelValue`	[value: boolean]

Defined in

packages/ui/types/components/dialog-form/types.d.ts:42

DialogFormProps

Ƭ DialogFormProps: ComponentPropsType<typeof dialogFormProps>

Defined in

packages/ui/types/components/dialog-form/types.d.ts:47

DialogMode

Ƭ DialogMode: "normal" | "maximized" | "minimized"

Defined in

packages/ui/types/components/dialog/types.d.ts:7

DialogProps

Ƭ DialogProps: ComponentPropsType<typeof dialogProps>

Defined in

packages/ui/types/components/dialog/types.d.ts:95

Emits

Ƭ Emits<T>: UnionToIntersection<RecordToUnion<{ [K in keyof T]: Function }>>

Type parameters

Name	Type
`T`	extends `Record`<`string`, `any`>

Defined in

packages/ui/types/components/shared.d.ts:25

FieldEmits

Ƭ FieldEmits: Object

Type declaration

Name	Type
`blur`	[]
`change`	[value: any]
`focus`	[]
`update:modelValue`	[value: any]

Defined in

packages/ui/types/components/field/types.d.ts:143

FieldOptionsLoader

Ƭ FieldOptionsLoader: (model?: FormModel) => FieldOption[] | Promise<FieldOption[]>

Type declaration

▸ (model?): FieldOption[] | Promise<FieldOption[]>

Parameters

Name	Type
`model?`	`FormModel`

Returns

FieldOption[] | Promise<FieldOption[]>

Defined in

packages/ui/types/components/field/types.d.ts:26

FieldProps

Ƭ FieldProps: ComponentPropsType<typeof fieldProps>

Defined in

packages/ui/types/components/field/types.d.ts:142

FieldVisibleCondition

Ƭ FieldVisibleCondition: boolean | Record<string, any> | (model: FormModel) => boolean

Defined in

packages/ui/types/components/field/types.d.ts:27

FormEmits

Ƭ FormEmits: Object

Type declaration

Name	Type
`change`	[model: Record<string, any>]
`reset`	[]
`submit`	[model: Record<string, any>]

Defined in

packages/ui/types/components/form/types.d.ts:62

FormInstance

Ƭ FormInstance: InstanceType<typeof XForm>

Defined in

packages/ui/types/components/form/types.d.ts:67

FormModel

Ƭ FormModel: Record<string, any>

Defined in

packages/ui/types/components/form/types.d.ts:69

FormProps

Ƭ FormProps: ComponentPropsType<typeof formProps>

Defined in

packages/ui/types/components/form/types.d.ts:61

HeaderEmits

Ƭ HeaderEmits: Object

Type declaration

Name	Type
`click`	[]
`clickIcon`	[]

Defined in

packages/ui/types/components/header/types.d.ts:28

HeaderProps

Ƭ HeaderProps: ComponentPropsType<typeof headerProps>

Defined in

packages/ui/types/components/header/types.d.ts:27

IUseDisabled

Ƭ IUseDisabled: MaybeRef<undefined | boolean | (...args: any[]) => boolean>

Defined in

packages/ui/types/hooks/useDisabled.d.ts:3

IconParam

Ƭ IconParam: string | VNode | IconProps | Record<string, any>

Defined in

packages/ui/types/components/icon/types.d.ts:3

IconProps

Ƭ IconProps: Partial<ExtractPropTypes<typeof iconProps>>

Defined in

packages/ui/types/components/icon/types.d.ts:37

IconSize

Ƭ IconSize: number | "inherit" | "large" | "default" | "small"

Defined in

packages/ui/types/components/icon/types.d.ts:4

IconSizeKey

Ƭ IconSizeKey: keyof typeof iconSizeMap

Defined in

packages/ui/types/components/icon/types.d.ts:10

ImageCodeInputProps

Ƭ ImageCodeInputProps: ComponentPropsType<typeof imageCodeInputProps>

Defined in

packages/ui/types/components/image-code-input/types.d.ts:32

InputUnitEmits

Ƭ InputUnitEmits: Object

Type declaration

Name	Type
`change`	[`string` \| `number` \| `undefined`]
`unit-change`	[`string` \| `undefined`]
`update:modelValue`	[`string` \| `number` \| `undefined`]
`update:unit`	[`string` \| `number` \| `undefined`]

Defined in

packages/ui/types/components/input-unit/types.d.ts:34

InputUnitProps

Ƭ InputUnitProps: ComponentPropsType<typeof inputUnitProps>

Defined in

packages/ui/types/components/input-unit/types.d.ts:33

ListEmits

Ƭ ListEmits: Object

Type declaration

Name	Type
`load`	[state: ListState]

Defined in

packages/ui/types/components/list/types.d.ts:57

ListProps

Ƭ ListProps: ComponentPropsType<typeof listProps>

Defined in

packages/ui/types/components/list/types.d.ts:56

MaskEmits

Ƭ MaskEmits: Object

Type declaration

Name	Type
`actionClick`	[action: ActionProps]
`actionCommand`	[action: ActionProps, item: ActionMenuItem]
`select`	[menu: MenuDataItem]

Defined in

packages/ui/types/components/mask/types.d.ts:89

MaskEmitsFn

Ƭ MaskEmitsFn: Emits<MaskEmits>

Defined in

packages/ui/types/components/mask/types.d.ts:94

MaskInstance

Ƭ MaskInstance: InstanceType<typeof XMask>

Defined in

packages/ui/types/components/mask/types.d.ts:88

MaskProps

Ƭ MaskProps: ComponentPropsType<typeof maskProps>

Defined in

packages/ui/types/components/mask/types.d.ts:87

MaskSlots

Ƭ MaskSlots: Object

Type declaration

Name	Type
`default`	() => `any`
`user`	() => `any`

Defined in

packages/ui/types/components/mask/types.d.ts:95

MenuBadge

Ƭ MenuBadge: number | string | Partial<BadgeProps>

Defined in

packages/ui/types/components/menu/types.d.ts:16

MenuEmits

Ƭ MenuEmits: Object

Type declaration

Name	Type
`select`	[item: MenuDataItem]

Defined in

packages/ui/types/components/menu/types.d.ts:22

PanelProps

Ƭ PanelProps: ComponentPropsType<typeof panelProps>

Defined in

packages/ui/types/components/panel/types.d.ts:234

QRCodeProps

Ƭ QRCodeProps: Omit<QRCodeToDataURLOptions, "renderOptions"> & QRCodeToDataURLOptionsJpegWebp["rendererOpts"] & { value: QRCodeValue }

Defined in

packages/ui/types/components/qrcode/types.d.ts:8

QRCodeValue

Ƭ QRCodeValue: string | () => Promise<string>

Defined in

packages/ui/types/components/qrcode/types.d.ts:6

QrcodeProps

Ƭ QrcodeProps: ComponentPropsType<typeof qrcodeProps>

Defined in

packages/ui/types/components/qrcode/types.d.ts:65

RecordToUnion

Ƭ RecordToUnion<T>: T[keyof T]

Type parameters

Name	Type
`T`	extends `Record`<`string`, `any`>

Defined in

packages/ui/types/components/shared.d.ts:24

ResizableDir

Ƭ ResizableDir: "n" | "s" | "w" | "e"

Defined in

packages/ui/types/directives/vResizable.d.ts:10

StartupProps

Ƭ StartupProps: ComponentPropsType<typeof startupProps>

Defined in

packages/ui/types/components/startup/types.d.ts:21

SubMenuProps

Ƭ SubMenuProps: Partial<ElSubMenuProps>

Defined in

packages/ui/types/components/menu/types.d.ts:15

TabCreator

Ƭ TabCreator: () => Promise<Partial<MaskTab>> | Partial<MaskTab>

Type declaration

▸ (): Promise<Partial<MaskTab>> | Partial<MaskTab>

Returns

Promise<Partial<MaskTab>> | Partial<MaskTab>

Defined in

packages/ui/types/components/mask/types.d.ts:111

TabsEmits

Ƭ TabsEmits: Object

Type declaration

Name	Type
`actionClick`	[props: ActionProps]
`actionCommand`	[item: ActionMenuItem]

Defined in

packages/ui/types/components/tabs/types.d.ts:33

TabsProps

Ƭ TabsProps: ComponentPropsType<typeof tabsProps>

Defined in

packages/ui/types/components/tabs/types.d.ts:32

TestEmits

Ƭ TestEmits: Object

Type declaration

Name	Type
`change`	[data: any]
`click`	[props: TestProps]
`submit`	[props: TestProps]
`update:modelValue`	[value?: string]
`update:syncProp`	[value?: string]

Defined in

packages/ui/types/components/test/types.d.ts:36

TestProps

Ƭ TestProps: ComponentPropsType<typeof testProps>

Defined in

packages/ui/types/components/test/types.d.ts:35

UnReadOnly

Ƭ UnReadOnly<T>: { -readonly [P in keyof T]: T[P] }

Type parameters

Name
`T`

Defined in

packages/ui/types/components/shared.d.ts:18

UnionToIntersection

Ƭ UnionToIntersection<U>: U extends any ? (k: U) => void : never extends (k: infer I) => void ? I : never

Type parameters

Name
`U`

Defined in

packages/ui/types/components/shared.d.ts:23

Uploader

Ƭ Uploader: (file: File) => Promise<string | UploaderResponse | null>

Type declaration

▸ (file): Promise<string | UploaderResponse | null>

Parameters

Name	Type
`file`	`File`

Returns

Promise<string | UploaderResponse | null>

Defined in

packages/ui/types/adapter.d.ts:9

UseMouseInElementReturn

Ƭ UseMouseInElementReturn: ReturnType<typeof useMouseInElement>

Defined in

packages/ui/types/directives/vResizable.d.ts:9

qrcodeEmits

Ƭ qrcodeEmits: Object

Type declaration

Name	Type
`refresh`	[]

Defined in

packages/ui/types/components/qrcode/types.d.ts:66

Variables

ADAPTER_KEY

• Const ADAPTER_KEY: InjectionKey<Adapter>

Defined in

packages/ui/types/adapter.d.ts:3

AdapterPlugin

• Const AdapterPlugin: Plugin

Defined in

packages/ui/types/adapter.d.ts:14

INSTALLED_KEY

• Const INSTALLED_KEY: unique symbol

Defined in

packages/ui/types/constants.d.ts:1

MASK_KEY

• Const MASK_KEY: unique symbol

Defined in

packages/ui/types/components/mask/types.d.ts:113

TAB_CREATORS_KEY

• Const TAB_CREATORS_KEY: InjectionKey<Record<string, TabCreator>>

Defined in

packages/ui/types/components/mask/types.d.ts:112

TAB_ITEM_WIDTH

• Const TAB_ITEM_WIDTH: 140

Defined in

packages/ui/types/components/mask/types.d.ts:6

TYPES

• Const TYPES: readonly ["image/png", "image/jpeg", "image/webp"]

Defined in

packages/ui/types/components/qrcode/types.d.ts:7

VTJ_UI_VERSION

• Const VTJ_UI_VERSION: "0.8.8"

Name

@vtj/ui

Author

CHC chenhuachun1549@dingtalk.com

Version

0.8.8

License

MIT License

Defined in

packages/ui/types/version.d.ts:8

XAction

• Const XAction: DefineComponent<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<BadgeProps>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | () => boolean> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<{ buttonProps: { __epPropKey: true ; required: false ; type: PropType<ButtonProps> ; validator: (val: ...) => ... | undefined } ; disabled: IconAccessdeclined<BooleanConstructor, unknown, unknown, false, boolean> ; effect: { __epPropKey: true ; default: "light" ; required: false ; type: PropType<string> ; validator: (val: ...) => ... | undefined } ; hideOnClick: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; hideTimeout: IconAccessdeclined<NumberConstructor, unknown, unknown, 150, boolean> ; id: StringConstructor ; loop: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; maxHeight: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "", boolean> ; placement: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "bottom", boolean> ; popperClass: IconAccessdeclined<StringConstructor, unknown, unknown, "", boolean> ; popperOptions: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, () => {}, boolean> ; role: IconAccessdeclined<StringConstructor, unknown, unknown, "menu", boolean> ; showTimeout: IconAccessdeclined<NumberConstructor, unknown, unknown, 150, boolean> ; size: IconAccessdeclined<StringConstructor, unknown, unknown, "", boolean> ; splitButton: BooleanConstructor ; tabindex: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, 0, boolean> ; teleported: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; trigger: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "hover", boolean> ; type: { __epPropKey: true ; required: false ; type: PropType<IconAccessdeclined<... | ... | ..., unknown, unknown>> ; validator: (val: ...) => ... | undefined } }>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<ElTooltipProps>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { click: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<...>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<...>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<...>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>) => void ; command: (item: ActionMenuItem) => void ; dragend: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<...>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<...>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<...>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>, e: any) => void ; dragstart: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<...>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<...>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<...>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>, e: any) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<BadgeProps>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | () => boolean> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<{ buttonProps: { __epPropKey: ... ; required: ... ; type: ... ; validator: ... } ; disabled: IconAccessdeclined<..., ..., ..., ..., ...> ; effect: { __epPropKey: ... ; default: ... ; required: ... ; type: ... ; validator: ... } ; hideOnClick: IconAccessdeclined<..., ..., ..., ..., ...> ; hideTimeout: IconAccessdeclined<..., ..., ..., ..., ...> ; id: StringConstructor ; loop: IconAccessdeclined<..., ..., ..., ..., ...> ; maxHeight: IconAccessdeclined<..., ..., ..., ..., ...> ; placement: IconAccessdeclined<..., ..., ..., ..., ...> ; popperClass: IconAccessdeclined<..., ..., ..., ..., ...> ; popperOptions: IconAccessdeclined<..., ..., ..., ..., ...> ; role: IconAccessdeclined<..., ..., ..., ..., ...> ; showTimeout: IconAccessdeclined<..., ..., ..., ..., ...> ; size: IconAccessdeclined<..., ..., ..., ..., ...> ; splitButton: BooleanConstructor ; tabindex: IconAccessdeclined<..., ..., ..., ..., ...> ; teleported: IconAccessdeclined<..., ..., ..., ..., ...> ; trigger: IconAccessdeclined<..., ..., ..., ..., ...> ; type: { __epPropKey: ... ; required: ... ; type: ... ; validator: ... } }>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<ElTooltipProps>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>> & { onClick?: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: ... ; type: ... } ; badge: { type: ... } ; button: { type: ... } ; circle: { type: ... } ; disabled: { type: ... } ; draggable: { type: ... } ; dropdown: { type: ... } ; icon: { type: ... } ; label: { type: ... } ; menus: { type: ... } ; mode: { default: ... ; type: ... } ; name: { type: ... } ; size: { default: ... ; type: ... } ; tooltip: { type: ... } ; type: { default: ... ; type: ... } ; value: { type: ... } }>>>) => any ; onCommand?: (item: ActionMenuItem) => any ; onDragend?: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: ... ; type: ... } ; badge: { type: ... } ; button: { type: ... } ; circle: { type: ... } ; disabled: { type: ... } ; draggable: { type: ... } ; dropdown: { type: ... } ; icon: { type: ... } ; label: { type: ... } ; menus: { type: ... } ; mode: { default: ... ; type: ... } ; name: { type: ... } ; size: { default: ... ; type: ... } ; tooltip: { type: ... } ; type: { default: ... ; type: ... } ; value: { type: ... } }>>>, e: any) => any ; onDragstart?: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: ... ; type: ... } ; badge: { type: ... } ; button: { type: ... } ; circle: { type: ... } ; disabled: { type: ... } ; draggable: { type: ... } ; dropdown: { type: ... } ; icon: { type: ... } ; label: { type: ... } ; menus: { type: ... } ; mode: { default: ... ; type: ... } ; name: { type: ... } ; size: { default: ... ; type: ... } ; tooltip: { type: ... } ; type: { default: ... ; type: ... } ; value: { type: ... } }>>>, e: any) => any }, { background: "hover" | "always" | "none" ; circle: boolean ; draggable: boolean ; mode: ActionMode ; size: BaseSize ; type: BaseType }, {}>

Defined in

packages/ui/types/components/action/Action.d.ts:7

XActionBar

• Const XActionBar: DefineComponent<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<Partial<BadgeProps>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | (item: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>) => boolean> } ; dropdown: { type: PropType<Partial<ExtractPropTypes<{ buttonProps: { __epPropKey: true ; required: false ; type: PropType<ButtonProps> ; validator: (val: ...) => ... | undefined } ; disabled: IconAccessdeclined<BooleanConstructor, unknown, unknown, false, boolean> ; effect: { __epPropKey: true ; default: "light" ; required: false ; type: PropType<string> ; validator: (val: ...) => ... | undefined } ; hideOnClick: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; hideTimeout: IconAccessdeclined<NumberConstructor, unknown, unknown, 150, boolean> ; id: StringConstructor ; loop: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; maxHeight: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "", boolean> ; placement: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "bottom", boolean> ; popperClass: IconAccessdeclined<StringConstructor, unknown, unknown, "", boolean> ; popperOptions: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, () => {}, boolean> ; role: IconAccessdeclined<StringConstructor, unknown, unknown, "menu", boolean> ; showTimeout: IconAccessdeclined<NumberConstructor, unknown, unknown, 150, boolean> ; size: IconAccessdeclined<StringConstructor, unknown, unknown, "", boolean> ; splitButton: BooleanConstructor ; tabindex: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, 0, boolean> ; teleported: IconAccessdeclined<BooleanConstructor, unknown, unknown, true, boolean> ; trigger: IconAccessdeclined<(...args: ...) => ... | () => ... | ...[], unknown, unknown, "hover", boolean> ; type: { __epPropKey: true ; required: false ; type: PropType<IconAccessdeclined<... | ... | ..., unknown, unknown>> ; validator: (val: ...) => ... | undefined } }>>> } ; items: { type: PropType<ActionBarItems> } ; mode: { default: string ; type: PropType<ActionMode> } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<Partial<ElTooltipProps>> } ; type: { default: string ; type: PropType<BaseType> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { click: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<...>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<...>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<...>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>) => void ; command: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<string | number | Partial<...>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<ExtractPropTypes<...>>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<ActionMenuItem[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<string | Partial<...>> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>, menu: ActionMenuItem) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ background: { default: string ; type: PropType<"hover" | "always" | "none"> } ; badge: { type: PropType<Partial<BadgeProps>> } ; button: { type: PropType<Partial<ButtonProps>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<boolean | (item: Readonly<...>) => boolean> } ; dropdown: { type: PropType<Partial<ExtractPropTypes<{ buttonProps: { __epPropKey: ... ; required: ... ; type: ... ; validator: ... } ; disabled: IconAccessdeclined<..., ..., ..., ..., ...> ; effect: { __epPropKey: ... ; default: ... ; required: ... ; type: ... ; validator: ... } ; hideOnClick: IconAccessdeclined<..., ..., ..., ..., ...> ; hideTimeout: IconAccessdeclined<..., ..., ..., ..., ...> ; id: StringConstructor ; loop: IconAccessdeclined<..., ..., ..., ..., ...> ; maxHeight: IconAccessdeclined<..., ..., ..., ..., ...> ; placement: IconAccessdeclined<..., ..., ..., ..., ...> ; popperClass: IconAccessdeclined<..., ..., ..., ..., ...> ; popperOptions: IconAccessdeclined<..., ..., ..., ..., ...> ; role: IconAccessdeclined<..., ..., ..., ..., ...> ; showTimeout: IconAccessdeclined<..., ..., ..., ..., ...> ; size: IconAccessdeclined<..., ..., ..., ..., ...> ; splitButton: BooleanConstructor ; tabindex: IconAccessdeclined<..., ..., ..., ..., ...> ; teleported: IconAccessdeclined<..., ..., ..., ..., ...> ; trigger: IconAccessdeclined<..., ..., ..., ..., ...> ; type: { __epPropKey: ... ; required: ... ; type: ... ; validator: ... } }>>> } ; items: { type: PropType<ActionBarItems> } ; mode: { default: string ; type: PropType<ActionMode> } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<Partial<ElTooltipProps>> } ; type: { default: string ; type: PropType<BaseType> } }>> & { onClick?: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: ... ; type: ... } ; badge: { type: ... } ; button: { type: ... } ; circle: { type: ... } ; disabled: { type: ... } ; draggable: { type: ... } ; dropdown: { type: ... } ; icon: { type: ... } ; label: { type: ... } ; menus: { type: ... } ; mode: { default: ... ; type: ... } ; name: { type: ... } ; size: { default: ... ; type: ... } ; tooltip: { type: ... } ; type: { default: ... ; type: ... } ; value: { type: ... } }>>>) => any ; onCommand?: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: ... ; type: ... } ; badge: { type: ... } ; button: { type: ... } ; circle: { type: ... } ; disabled: { type: ... } ; draggable: { type: ... } ; dropdown: { type: ... } ; icon: { type: ... } ; label: { type: ... } ; menus: { type: ... } ; mode: { default: ... ; type: ... } ; name: { type: ... } ; size: { default: ... ; type: ... } ; tooltip: { type: ... } ; type: { default: ... ; type: ... } ; value: { type: ... } }>>>, menu: ActionMenuItem) => any }, { background: "hover" | "always" | "none" ; circle: boolean ; mode: ActionMode ; size: BaseSize ; type: BaseType }, {}>

Defined in

packages/ui/types/components/action-bar/ActionBar.d.ts:9

XAttachment

• Const XAttachment: __VLS_WithTemplateSlots<DefineComponent<{ accept: { default: string ; type: StringConstructor } ; addable: { default: boolean ; type: BooleanConstructor } ; clickable: { default: boolean ; type: BooleanConstructor } ; disabled: { type: BooleanConstructor } ; downloadable: { default: boolean ; type: BooleanConstructor } ; limit: { type: NumberConstructor } ; listType: { default: string ; type: PropType<"card" | "list"> } ; modelValue: { default: () => never[] ; type: PropType<AttachmentFile[]> } ; multiple: { type: BooleanConstructor } ; previewable: { default: boolean ; type: BooleanConstructor } ; removable: { default: boolean ; type: BooleanConstructor } ; selectValue: { type: PropType<AttachmentFile | AttachmentFile[]> } ; selectable: { default: boolean ; type: BooleanConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; thumbnail: { type: PropType<AttachmentThumbnail> } ; uploader: { type: PropType<AttachmentUploader> } }, { download: (file: AttachmentFile) => void ; elUploadRef: Ref<any> ; fileList: Ref<UploadUserFile[]> ; remove: (file: AttachmentFile) => Promise<void> ; selections: Ref<{ [x: string]: any; name?: string ; type?: AttachmentFileType ; url: string }[]> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (files: AttachmentFile[]) => void ; click: (file: AttachmentFile) => void ; download: (file: AttachmentFile) => void ; preview: (file: AttachmentFile) => void ; remove: (file: AttachmentFile) => void ; select: (files: AttachmentFile[]) => void ; update:modelValue: (files: AttachmentFile[]) => void ; update:selectValue: (files: AttachmentFile | AttachmentFile[]) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ accept: { default: string ; type: StringConstructor } ; addable: { default: boolean ; type: BooleanConstructor } ; clickable: { default: boolean ; type: BooleanConstructor } ; disabled: { type: BooleanConstructor } ; downloadable: { default: boolean ; type: BooleanConstructor } ; limit: { type: NumberConstructor } ; listType: { default: string ; type: PropType<"card" | "list"> } ; modelValue: { default: () => never[] ; type: PropType<AttachmentFile[]> } ; multiple: { type: BooleanConstructor } ; previewable: { default: boolean ; type: BooleanConstructor } ; removable: { default: boolean ; type: BooleanConstructor } ; selectValue: { type: PropType<AttachmentFile | AttachmentFile[]> } ; selectable: { default: boolean ; type: BooleanConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; thumbnail: { type: PropType<AttachmentThumbnail> } ; uploader: { type: PropType<AttachmentUploader> } }>> & { onChange?: (files: AttachmentFile[]) => any ; onClick?: (file: AttachmentFile) => any ; onDownload?: (file: AttachmentFile) => any ; onPreview?: (file: AttachmentFile) => any ; onRemove?: (file: AttachmentFile) => any ; onSelect?: (files: AttachmentFile[]) => any ; onUpdate:modelValue?: (files: AttachmentFile[]) => any ; onUpdate:selectValue?: (files: AttachmentFile | AttachmentFile[]) => any }, { accept: string ; addable: boolean ; clickable: boolean ; disabled: boolean ; downloadable: boolean ; listType: "card" | "list" ; modelValue: AttachmentFile[] ; multiple: boolean ; previewable: boolean ; removable: boolean ; selectable: boolean ; size: BaseSize }, {}>, { tip?: (_: {}) => any }>

Defined in

packages/ui/types/components/attachment/Attachment.d.ts:6

XContainer

• Const XContainer: __VLS_WithTemplateSlots<DefineComponent<{ align: { default: string ; type: PropType<ContainerAlignItems> } ; alignContent: { default: string ; type: PropType<ContainerAlignContent> } ; alignSelf: { default: string ; type: PropType<ContainerAlignItems | "auto"> } ; autoPointer: { type: BooleanConstructor } ; direction: { default: string ; type: PropType<ContainerDirection> } ; fit: { default: boolean ; type: BooleanConstructor } ; flex: { default: boolean ; type: BooleanConstructor } ; gap: { type: BooleanConstructor } ; grow: { default: boolean ; type: BooleanConstructor } ; height: { type: (StringConstructor | NumberConstructor)[] } ; inline: { type: BooleanConstructor } ; justify: { default: string ; type: PropType<ContainerJustifyContent> } ; overflow: { type: PropType<"hidden" | "visible" | "auto"> } ; padding: { default: boolean ; type: BooleanConstructor } ; shrink: { default: boolean ; type: BooleanConstructor } ; tag: { default: string ; type: StringConstructor } ; width: { type: (StringConstructor | NumberConstructor)[] } ; wrap: { default: string ; type: PropType<ContainerWrap> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ align: { default: string ; type: PropType<ContainerAlignItems> } ; alignContent: { default: string ; type: PropType<ContainerAlignContent> } ; alignSelf: { default: string ; type: PropType<ContainerAlignItems | "auto"> } ; autoPointer: { type: BooleanConstructor } ; direction: { default: string ; type: PropType<ContainerDirection> } ; fit: { default: boolean ; type: BooleanConstructor } ; flex: { default: boolean ; type: BooleanConstructor } ; gap: { type: BooleanConstructor } ; grow: { default: boolean ; type: BooleanConstructor } ; height: { type: (StringConstructor | NumberConstructor)[] } ; inline: { type: BooleanConstructor } ; justify: { default: string ; type: PropType<ContainerJustifyContent> } ; overflow: { type: PropType<"hidden" | "visible" | "auto"> } ; padding: { default: boolean ; type: BooleanConstructor } ; shrink: { default: boolean ; type: BooleanConstructor } ; tag: { default: string ; type: StringConstructor } ; width: { type: (StringConstructor | NumberConstructor)[] } ; wrap: { default: string ; type: PropType<ContainerWrap> } }>>, { align: ContainerAlignItems ; alignContent: ContainerAlignContent ; alignSelf: ContainerAlignItems | "auto" ; autoPointer: boolean ; direction: ContainerDirection ; fit: boolean ; flex: boolean ; gap: boolean ; grow: boolean ; inline: boolean ; justify: ContainerJustifyContent ; padding: boolean ; shrink: boolean ; tag: string ; wrap: ContainerWrap }, {}>, { default?: (_: {}) => any }>

Defined in

packages/ui/types/components/container/Container.d.ts:3

XDataItem

• Const XDataItem: __VLS_WithTemplateSlots<DefineComponent<{ actionBarProps: { type: PropType<ActionBarProps> } ; actions: { type: PropType<ActionBarItems> } ; description: { type: StringConstructor } ; direction: { default: string ; type: PropType<"row" | "column"> } ; icon: { type: PropType<IconParam> } ; imageHeight: { type: (StringConstructor | NumberConstructor)[] } ; imageSrc: { type: StringConstructor } ; imageWidth: { type: (StringConstructor | NumberConstructor)[] } ; onImageClick: { type: FunctionConstructor } ; onTitleClick: { type: FunctionConstructor } ; split: { type: BooleanConstructor } ; title: { type: StringConstructor } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { actionClick: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<... | ... | ...> } ; badge: { type: PropType<... | ... | ...> } ; button: { type: PropType<Partial<...>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<... | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<...>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<...[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<... | ...> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>) => void ; actionCommand: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<... | ... | ...> } ; badge: { type: PropType<... | ... | ...> } ; button: { type: PropType<Partial<...>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<... | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<...>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<...[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<... | ...> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>, menu: ActionMenuItem) => void ; imageClick: () => void ; titleClick: () => void }, string, PublicProps, Readonly<ExtractPropTypes<{ actionBarProps: { type: PropType<ActionBarProps> } ; actions: { type: PropType<ActionBarItems> } ; description: { type: StringConstructor } ; direction: { default: string ; type: PropType<"row" | "column"> } ; icon: { type: PropType<IconParam> } ; imageHeight: { type: (StringConstructor | NumberConstructor)[] } ; imageSrc: { type: StringConstructor } ; imageWidth: { type: (StringConstructor | NumberConstructor)[] } ; onImageClick: { type: FunctionConstructor } ; onTitleClick: { type: FunctionConstructor } ; split: { type: BooleanConstructor } ; title: { type: StringConstructor } }>> & { onActionClick?: (action: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>) => any ; onActionCommand?: (action: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>, menu: ActionMenuItem) => any ; onImageClick?: () => any ; onTitleClick?: () => any }, { direction: "row" | "column" ; split: boolean }, {}>, { actions?: (_: {}) => any ; default?: (_: {}) => any ; description?: (_: {}) => any ; image?: (_: {}) => any ; title?: (_: {}) => any }>

Defined in

packages/ui/types/components/data-item/DataItem.d.ts:8

XDialog

• Const XDialog: __VLS_WithTemplateSlots<DefineComponent<{ beforeClose: { type: PropType<() => boolean | Promise<boolean>> } ; bodyPadding: { default: boolean ; type: BooleanConstructor } ; cancel: { type: (BooleanConstructor | StringConstructor)[] } ; closable: { default: boolean ; type: BooleanConstructor } ; componentInstance: { type: PropType<Record<string, any> | null> } ; content: { type: PropType<Record<string, any> | VNode<RendererNode, RendererElement, { [key: string]: any; }> | DefineComponent<any, any, any, any>> } ; draggable: { default: boolean ; type: PropType<boolean | DraggableOptions> } ; height: { default: string ; type: (StringConstructor | NumberConstructor)[] } ; icon: { type: PropType<IconParam> } ; left: { type: (StringConstructor | NumberConstructor)[] } ; maximizable: { default: boolean ; type: BooleanConstructor } ; minimizable: { default: boolean ; type: BooleanConstructor } ; modal: { default: boolean ; type: BooleanConstructor } ; mode: { default: string ; type: PropType<DialogMode> } ; modelValue: { default: boolean ; type: BooleanConstructor } ; primary: { type: BooleanConstructor } ; resizable: { type: PropType<boolean | ResizableOptions> } ; size: { default: string ; type: PropType<BaseSize> } ; src: { type: StringConstructor } ; submit: { type: (BooleanConstructor | StringConstructor)[] } ; subtitle: { type: StringConstructor } ; title: { type: StringConstructor } ; top: { type: (StringConstructor | NumberConstructor)[] } ; width: { default: string ; type: (StringConstructor | NumberConstructor)[] } }, { $vtjEl: ComputedRef<any> ; cancel: () => void ; changeMode: (mode: DialogMode) => void ; close: () => Promise<void> ; componentInstance: { componentInstance: Record<string, any> } | undefined ; hide: () => void ; maximized: ComputedRef<boolean> ; minimized: ComputedRef<boolean> ; panelRef: Ref<any> ; show: () => void ; state: { dragging: boolean ; height: number ; left: number ; mode: DialogMode ; resizing: boolean ; top: number ; width: number ; wrapperHeight: number ; wrapperWidth: number ; zIndex: number } ; submit: () => void }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { cancel: () => void ; close: () => void ; destroy: () => void ; dragEnd: (position: Position) => void ; dragStart: (position: Position) => void ; dragging: (position: Position) => void ; maximized: () => void ; minimized: () => void ; modeChange: (mode: DialogMode) => void ; normal: () => void ; open: (instance: ComponentInternalInstance) => void ; resizeEnd: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => void ; resizeStart: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => void ; resizing: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => void ; submit: () => void ; update:modelValue: (value: boolean) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ beforeClose: { type: PropType<() => boolean | Promise<...>> } ; bodyPadding: { default: boolean ; type: BooleanConstructor } ; cancel: { type: (BooleanConstructor | StringConstructor)[] } ; closable: { default: boolean ; type: BooleanConstructor } ; componentInstance: { type: PropType<Record<string, any> | null> } ; content: { type: PropType<Record<string, any> | VNode<RendererNode, RendererElement, { [key: ...]: ...; }> | DefineComponent<any, any, any, any>> } ; draggable: { default: boolean ; type: PropType<boolean | DraggableOptions> } ; height: { default: string ; type: (StringConstructor | NumberConstructor)[] } ; icon: { type: PropType<IconParam> } ; left: { type: (StringConstructor | NumberConstructor)[] } ; maximizable: { default: boolean ; type: BooleanConstructor } ; minimizable: { default: boolean ; type: BooleanConstructor } ; modal: { default: boolean ; type: BooleanConstructor } ; mode: { default: string ; type: PropType<DialogMode> } ; modelValue: { default: boolean ; type: BooleanConstructor } ; primary: { type: BooleanConstructor } ; resizable: { type: PropType<boolean | ResizableOptions> } ; size: { default: string ; type: PropType<BaseSize> } ; src: { type: StringConstructor } ; submit: { type: (BooleanConstructor | StringConstructor)[] } ; subtitle: { type: StringConstructor } ; title: { type: StringConstructor } ; top: { type: (StringConstructor | NumberConstructor)[] } ; width: { default: string ; type: (StringConstructor | NumberConstructor)[] } }>> & { onCancel?: () => any ; onClose?: () => any ; onDestroy?: () => any ; onDragEnd?: (position: Position) => any ; onDragStart?: (position: Position) => any ; onDragging?: (position: Position) => any ; onMaximized?: () => any ; onMinimized?: () => any ; onModeChange?: (mode: DialogMode) => any ; onNormal?: () => any ; onOpen?: (instance: ComponentInternalInstance) => any ; onResizeEnd?: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => any ; onResizeStart?: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => any ; onResizing?: (dir: string, mie: { elementHeight: Ref<number> ; elementPositionX: Ref<number> ; elementPositionY: Ref<number> ; elementWidth: Ref<number> ; elementX: Ref<number> ; elementY: Ref<number> ; isOutside: Ref<boolean> ; sourceType: Ref<UseMouseSourceType> ; stop: () => void ; x: Ref<number> ; y: Ref<number> }) => any ; onSubmit?: () => any ; onUpdate:modelValue?: (value: boolean) => any }, { bodyPadding: boolean ; closable: boolean ; draggable: boolean | DraggableOptions ; height: string | number ; maximizable: boolean ; minimizable: boolean ; modal: boolean ; mode: DialogMode ; modelValue: boolean ; primary: boolean ; size: BaseSize ; width: string | number }, {}>, { actions?: (_: {}) => any ; default?: (_: {}) => any ; extra?: (_: {}) => any ; footer?: (_: {}) => any ; handle?: (_: {}) => any }>

Defined in

packages/ui/types/components/dialog/Dialog.d.ts:7

XDialogForm

• Const XDialogForm: __VLS_WithTemplateSlots<DefineComponent<{ cancel: { default: string ; type: (BooleanConstructor | StringConstructor)[] } ; formProps: { type: PropType<Record<string, any>> } ; model: { type: PropType<Record<string, any>> ; default: () => any } ; modelValue: { default: boolean ; type: BooleanConstructor } ; rules: { type: PropType<Partial<Record<string, IconAccessdeclined<FormItemRule>>>> } ; size: { type: PropType<BaseSize> } ; submit: { default: string ; type: (BooleanConstructor | StringConstructor)[] } ; submitMethod: { type: PropType<(model: Record<string, any>) => Promise<boolean>> } }, { $vtjEl: ComputedRef<any> ; dialogRef: Ref<any> ; formRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { close: () => void ; submit: (model: Record<string, any>) => void ; update:modelValue: (value: boolean) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ cancel: { default: string ; type: (BooleanConstructor | StringConstructor)[] } ; formProps: { type: PropType<Record<string, any>> } ; model: { type: PropType<Record<string, any>> ; default: () => any } ; modelValue: { default: boolean ; type: BooleanConstructor } ; rules: { type: PropType<Partial<Record<string, IconAccessdeclined<...>>>> } ; size: { type: PropType<BaseSize> } ; submit: { default: string ; type: (BooleanConstructor | StringConstructor)[] } ; submitMethod: { type: PropType<(model: Record<string, any>) => Promise<boolean>> } }>> & { onClose?: () => any ; onSubmit?: (model: Record<string, any>) => any ; onUpdate:modelValue?: (value: boolean) => any }, { cancel: string | boolean ; model: Record<string, any> ; modelValue: boolean ; submit: string | boolean }, {}>, { default?: (_: {}) => any ; extra?: (_: {}) => any ; footer?: (_: {}) => any ; handle?: (_: {}) => any }>

Defined in

packages/ui/types/components/dialog-form/DialogForm.d.ts:5

XField

• Const XField: __VLS_WithTemplateSlots<DefineComponent<{ cascader: { type: PropType<string | string[]> } ; disabled: { type: PropType<boolean> } ; editor: { default: string ; type: PropType<Record<string, any> | VNode<RendererNode, RendererElement, { [key: string]: any; }> | BuiltinFieldEditorType> } ; error: { type: StringConstructor } ; inline: { type: BooleanConstructor } ; label: { type: StringConstructor } ; modelValue: { type: PropType<any> ; default: (context: any) => any } ; name: { type: StringConstructor } ; options: { type: PropType<FieldOption[] | FieldOptionsLoader> } ; placeholder: { type: PropType<string | null> } ; props: { type: PropType<Record<string, any>> } ; readonly: { type: PropType<boolean> } ; size: { type: PropType<BaseSize> } ; tip: { type: StringConstructor } ; tooltipMessage: { default: boolean ; type: PropType<boolean | Partial<ElTooltipProps>> } ; tooltipPosition: { default: string ; type: PropType<number | "inner" | "outer"> } ; visible: { default: boolean ; type: (BooleanConstructor | ObjectConstructor | FunctionConstructor)[] } ; width: { type: PropType<string | number> } }, { blur: () => void ; editorRef: Ref<any> ; fieldValue: Ref<any> ; focus: () => void ; itemRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { blur: () => void ; change: (value: any) => void ; focus: () => void ; update:modelValue: (value: any) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ cascader: { type: PropType<string | string[]> } ; disabled: { type: PropType<boolean> } ; editor: { default: string ; type: PropType<Record<string, any> | VNode<RendererNode, RendererElement, { [key: ...]: ...; }> | BuiltinFieldEditorType> } ; error: { type: StringConstructor } ; inline: { type: BooleanConstructor } ; label: { type: StringConstructor } ; modelValue: { type: PropType<any> ; default: (context: any) => any } ; name: { type: StringConstructor } ; options: { type: PropType<FieldOption[] | FieldOptionsLoader> } ; placeholder: { type: PropType<string | null> } ; props: { type: PropType<Record<string, any>> } ; readonly: { type: PropType<boolean> } ; size: { type: PropType<BaseSize> } ; tip: { type: StringConstructor } ; tooltipMessage: { default: boolean ; type: PropType<boolean | Partial<ElTooltipProps>> } ; tooltipPosition: { default: string ; type: PropType<number | "inner" | "outer"> } ; visible: { default: boolean ; type: (BooleanConstructor | ObjectConstructor | FunctionConstructor)[] } ; width: { type: PropType<string | number> } }>> & { onBlur?: () => any ; onChange?: (value: any) => any ; onFocus?: () => any ; onUpdate:modelValue?: (value: any) => any }, { editor: Record<string, any> | VNode<RendererNode, RendererElement, { [key: string]: any; }> | BuiltinFieldEditorType ; inline: boolean ; modelValue: any ; tooltipMessage: boolean | Partial<ElTooltipProps> ; tooltipPosition: number | "inner" | "outer" ; visible: boolean | Function | Record<string, any> }, {}>, { default?: (_: {}) => any ; editor?: (_: { editor: FieldEditorProps }) => any ; error?: (_: { error: any }) => any ; label?: (_: {}) => any ; option?: (_: { option: any }) => any ; tip?: (_: {}) => any }>

Defined in

packages/ui/types/components/field/Field.d.ts:7

XForm

• Const XForm: __VLS_WithTemplateSlots<DefineComponent<{ footer: { default: boolean ; type: BooleanConstructor } ; inline: { type: BooleanConstructor } ; inlineColumns: { type: NumberConstructor } ; model: { type: PropType<Record<string, any>> ; default: () => any } ; resetText: { default: string ; type: StringConstructor } ; submitMethod: { type: PropType<(model: FormModel) => Promise<any>> } ; submitText: { default: string ; type: StringConstructor } ; tooltipMessage: { default: undefined ; type: PropType<boolean | Partial<ElTooltipProps>> } }, { formRef: Ref<any> ; model: FormModel ; reset: (fields?: string | string[]) => void ; submit: () => Promise<void> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (model: Record<string, any>) => void ; reset: () => void ; submit: (model: Record<string, any>) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ footer: { default: boolean ; type: BooleanConstructor } ; inline: { type: BooleanConstructor } ; inlineColumns: { type: NumberConstructor } ; model: { type: PropType<Record<string, any>> ; default: () => any } ; resetText: { default: string ; type: StringConstructor } ; submitMethod: { type: PropType<(model: FormModel) => Promise<any>> } ; submitText: { default: string ; type: StringConstructor } ; tooltipMessage: { default: undefined ; type: PropType<boolean | Partial<ElTooltipProps>> } }>> & { onChange?: (model: Record<string, any>) => any ; onReset?: () => any ; onSubmit?: (model: Record<string, any>) => any }, { footer: boolean ; inline: boolean ; model: Record<string, any> ; resetText: string ; submitText: string ; tooltipMessage: boolean | Partial<ElTooltipProps> }, {}>, { action?: (_: {}) => any ; default?: (_: {}) => any ; footer?: (_: {}) => any }>

Defined in

packages/ui/types/components/form/Form.d.ts:5

XHeader

• Const XHeader: __VLS_WithTemplateSlots<DefineComponent<{ border: { type: BooleanConstructor } ; content: { default: string ; type: StringConstructor } ; icon: { type: PropType<IconParam> } ; more: { type: BooleanConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; subtitle: { type: StringConstructor } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ border: { type: BooleanConstructor } ; content: { default: string ; type: StringConstructor } ; icon: { type: PropType<IconParam> } ; more: { type: BooleanConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; subtitle: { type: StringConstructor } }>>, { border: boolean ; content: string ; more: boolean ; size: BaseSize }, {}>, { actions?: (_: {}) => any ; default?: (_: {}) => any ; subtitle?: (_: {}) => any }>

Defined in

packages/ui/types/components/header/Header.d.ts:4

XIcon

• Const XIcon: __VLS_WithTemplateSlots<DefineComponent<{ background: { type: StringConstructor } ; color: { type: StringConstructor } ; icon: { type: PropType<string | object | VNode<RendererNode, RendererElement, { [key: string]: any; }>> } ; padding: { type: NumberConstructor } ; radius: { type: NumberConstructor } ; size: { default: string ; type: PropType<IconSize> } ; src: { type: StringConstructor } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ background: { type: StringConstructor } ; color: { type: StringConstructor } ; icon: { type: PropType<string | object | VNode<RendererNode, RendererElement, { [key: string]: any; }>> } ; padding: { type: NumberConstructor } ; radius: { type: NumberConstructor } ; size: { default: string ; type: PropType<IconSize> } ; src: { type: StringConstructor } }>>, { size: IconSize }, {}>, { default?: (_: {}) => any }>

Defined in

packages/ui/types/components/icon/Icon.d.ts:3

XImageCodeInput

• Const XImageCodeInput: DefineComponent<{ image: { type: PropType<() => Promise<string>> } ; maxLength: { default: number ; type: NumberConstructor } ; placeholder: { default: string ; type: StringConstructor } ; validate: { type: PropType<(value: string) => Promise<boolean>> } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ image: { type: PropType<() => Promise<string>> } ; maxLength: { default: number ; type: NumberConstructor } ; placeholder: { default: string ; type: StringConstructor } ; validate: { type: PropType<(value: string) => Promise<boolean>> } }>>, { maxLength: number ; placeholder: string }, {}>

Defined in

packages/ui/types/components/image-code-input/ImageCodeInput.d.ts:2

XInputUnit

• Const XInputUnit: DefineComponent<{ appendWidth: { default: number ; type: NumberConstructor } ; format: { type: StringConstructor } ; modelValue: { type: (StringConstructor | NumberConstructor)[] } ; selectProps: { type: PropType<Record<string, any>> } ; unit: { type: StringConstructor } ; units: { type: PropType<(string | InputUnitOption)[]> } ; withUnit: { default: boolean ; type: BooleanConstructor } }, { formatValue: (value?: string | number) => string | number | undefined ; parser: (value?: string | number) => { unit: string | undefined ; value: string | number | undefined } }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (args_0: string | number | undefined) => void ; unit-change: (args_0: string | undefined) => void ; update:modelValue: (args_0: string | number | undefined) => void ; update:unit: (args_0: string | number | undefined) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ appendWidth: { default: number ; type: NumberConstructor } ; format: { type: StringConstructor } ; modelValue: { type: (StringConstructor | NumberConstructor)[] } ; selectProps: { type: PropType<Record<string, any>> } ; unit: { type: StringConstructor } ; units: { type: PropType<(string | InputUnitOption)[]> } ; withUnit: { default: boolean ; type: BooleanConstructor } }>> & { onChange?: (args_0: string | number | undefined) => any ; onUnit-change?: (args_0: string | undefined) => any ; onUpdate:modelValue?: (args_0: string | number | undefined) => any ; onUpdate:unit?: (args_0: string | number | undefined) => any }, { appendWidth: number ; withUnit: boolean }, {}>

Defined in

packages/ui/types/components/input-unit/InputUnit.d.ts:3

XList

• Const XList: __VLS_WithTemplateSlots<DefineComponent<{ data: { type: PropType<DataLoader<ListData, ListState>> ; default: () => never[] } ; dataKey: { type: StringConstructor } ; height: { default: string ; type: (StringConstructor | NumberConstructor)[] } ; infiniteScroll: { type: PropType<boolean | ListInfiniteScroll> } ; itemHeight: { type: PropType<number | (index: number) => number> } ; page: { default: number ; type: NumberConstructor } ; pageSize: { default: number ; type: NumberConstructor } ; pager: { type: PropType<boolean | Partial<PaginationProps>> } ; width: { default: string ; type: (StringConstructor | NumberConstructor)[] } }, { data: ShallowRef<ListData> ; getKey: (item: any) => any ; list: Ref<UseVirtualListItem<any>[]> ; loading: Ref<boolean> ; nomore: Ref<boolean> ; pageCount: ComputedRef<number> ; scrollTo: (index: number) => void ; state: { page: number ; pageSize: number } ; wrapperRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { load: (state: ListState) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ data: { type: PropType<DataLoader<ListData, ListState>> ; default: () => never[] } ; dataKey: { type: StringConstructor } ; height: { default: string ; type: (StringConstructor | NumberConstructor)[] } ; infiniteScroll: { type: PropType<boolean | ListInfiniteScroll> } ; itemHeight: { type: PropType<number | (index: ...) => ...> } ; page: { default: number ; type: NumberConstructor } ; pageSize: { default: number ; type: NumberConstructor } ; pager: { type: PropType<boolean | Partial<PaginationProps>> } ; width: { default: string ; type: (StringConstructor | NumberConstructor)[] } }>> & { onLoad?: (state: ListState) => any }, { data: DataLoader<ListData, ListState> ; height: string | number ; page: number ; pageSize: number ; width: string | number }, {}>, { default?: (_: { index: number ; item: any }) => any ; empty?: (_: {}) => any ; loading?: (_: {}) => any ; nomore?: (_: {}) => any }>

Defined in

packages/ui/types/components/list/List.d.ts:7

XMask

• Const XMask: __VLS_WithTemplateSlots<DefineComponent<{ actions: { type: PropType<ActionBarItems> } ; addFavorite: { type: PropType<(menu: MenuDataItem) => void> } ; avatar: { type: StringConstructor } ; disabled: { type: BooleanConstructor } ; favorites: { type: PropType<MenuDataItem[] | () => MenuDataItem[] | Promise<...[]>> ; default: () => never[] } ; home: { default: string ; type: PropType<string | MaskTab> } ; logo: { default: string ; type: StringConstructor } ; menuAdapter: { type: PropType<(menu: MenuDataItem) => MenuDataItem> } ; menus: { type: PropType<MenuDataItem[] | () => MenuDataItem[] | Promise<...[]>> ; default: () => never[] } ; removeFavorite: { type: PropType<(menu: MenuDataItem) => void> } ; tabs: { default: number ; type: NumberConstructor } ; theme: { type: BooleanConstructor } ; title: { default: string ; type: StringConstructor } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { actionClick: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<... | ... | ...> } ; badge: { type: PropType<... | ... | ...> } ; button: { type: PropType<Partial<...>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<... | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<...>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<...[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<... | ...> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>) => void ; actionCommand: (action: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<... | ... | ...> } ; badge: { type: PropType<... | ... | ...> } ; button: { type: PropType<Partial<...>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<... | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<...>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<...[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<... | ...> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>, item: ActionMenuItem) => void ; select: (menu: MenuDataItem) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ actions: { type: PropType<ActionBarItems> } ; addFavorite: { type: PropType<(menu: MenuDataItem) => void> } ; avatar: { type: StringConstructor } ; disabled: { type: BooleanConstructor } ; favorites: { type: PropType<MenuDataItem[] | () => ...> ; default: () => never[] } ; home: { default: string ; type: PropType<string | MaskTab> } ; logo: { default: string ; type: StringConstructor } ; menuAdapter: { type: PropType<(menu: MenuDataItem) => MenuDataItem> } ; menus: { type: PropType<MenuDataItem[] | () => ...> ; default: () => never[] } ; removeFavorite: { type: PropType<(menu: MenuDataItem) => void> } ; tabs: { default: number ; type: NumberConstructor } ; theme: { type: BooleanConstructor } ; title: { default: string ; type: StringConstructor } }>> & { onActionClick?: (action: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>) => any ; onActionCommand?: (action: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>, item: ActionMenuItem) => any ; onSelect?: (menu: MenuDataItem) => any }, { disabled: boolean ; favorites: MenuDataItem[] | () => MenuDataItem[] | Promise<MenuDataItem[]> ; home: string | MaskTab ; logo: string ; menus: MenuDataItem[] | () => MenuDataItem[] | Promise<MenuDataItem[]> ; tabs: number ; theme: boolean ; title: string }, {}>, { default?: (_: {}) => any ; user?: (_: {}) => any }>

Defined in

packages/ui/types/components/mask/Mask.d.ts:9

XMenu

• Const XMenu: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<MenuProps>, { data: () => never[] ; subMenuProps: () => {} }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { select: (item: MenuDataItem) => void }, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<MenuProps>, { data: () => never[] ; subMenuProps: () => {} }>>> & { onSelect?: (item: MenuDataItem) => any }, { data: MenuDataItem[] }, {}>

Defined in

packages/ui/types/components/menu/Menu.d.ts:4

XPanel

• Const XPanel: __VLS_WithTemplateSlots<DefineComponent<{ body: { type: PropType<Readonly<Partial<ExtractPropTypes<{ align: { default: string ; type: PropType<...> } ; alignContent: { default: string ; type: PropType<...> } ; alignSelf: { default: string ; type: PropType<...> } ; autoPointer: { type: BooleanConstructor } ; direction: { default: string ; type: PropType<...> } ; fit: { default: boolean ; type: BooleanConstructor } ; flex: { default: boolean ; type: BooleanConstructor } ; gap: { type: BooleanConstructor } ; grow: { default: boolean ; type: BooleanConstructor } ; height: { type: ...[] } ; inline: { type: BooleanConstructor } ; justify: { default: string ; type: PropType<...> } ; overflow: { type: PropType<...> } ; padding: { default: boolean ; type: BooleanConstructor } ; shrink: { default: boolean ; type: BooleanConstructor } ; tag: { default: string ; type: StringConstructor } ; width: { type: ...[] } ; wrap: { default: string ; type: PropType<...> } }>>>> } ; border: { default: boolean ; type: BooleanConstructor } ; card: { type: BooleanConstructor } ; fit: { default: boolean ; type: BooleanConstructor } ; footer: { type: PropType<Readonly<Partial<ExtractPropTypes<{ align: { default: string ; type: PropType<...> } ; alignContent: { default: string ; type: PropType<...> } ; alignSelf: { default: string ; type: PropType<...> } ; autoPointer: { type: BooleanConstructor } ; direction: { default: string ; type: PropType<...> } ; fit: { default: boolean ; type: BooleanConstructor } ; flex: { default: boolean ; type: BooleanConstructor } ; gap: { type: BooleanConstructor } ; grow: { default: boolean ; type: BooleanConstructor } ; height: { type: ...[] } ; inline: { type: BooleanConstructor } ; justify: { default: string ; type: PropType<...> } ; overflow: { type: PropType<...> } ; padding: { default: boolean ; type: BooleanConstructor } ; shrink: { default: boolean ; type: BooleanConstructor } ; tag: { default: string ; type: StringConstructor } ; width: { type: ...[] } ; wrap: { default: string ; type: PropType<...> } }>>>> } ; header: { type: PropType<string | Readonly<Partial<ExtractPropTypes<{ border: { type: ... } ; content: { default: ... ; type: ... } ; icon: { type: ... } ; more: { type: ... } ; size: { default: ... ; type: ... } ; subtitle: { type: ... } }>>> | null> } ; height: { type: (StringConstructor | NumberConstructor)[] } ; radius: { default: boolean ; type: BooleanConstructor } ; shadow: { type: PropType<"hover" | "always" | "none"> } ; size: { type: PropType<BaseSize> } ; width: { type: (StringConstructor | NumberConstructor)[] } }, { bodyRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ body: { type: PropType<Readonly<Partial<ExtractPropTypes<{ align: ... ; alignContent: ... ; alignSelf: ... ; autoPointer: ... ; direction: ... ; fit: ... ; flex: ... ; gap: ... ; grow: ... ; height: ... ; inline: ... ; justify: ... ; overflow: ... ; padding: ... ; shrink: ... ; tag: ... ; width: ... ; wrap: ... }>>>> } ; border: { default: boolean ; type: BooleanConstructor } ; card: { type: BooleanConstructor } ; fit: { default: boolean ; type: BooleanConstructor } ; footer: { type: PropType<Readonly<Partial<ExtractPropTypes<{ align: ... ; alignContent: ... ; alignSelf: ... ; autoPointer: ... ; direction: ... ; fit: ... ; flex: ... ; gap: ... ; grow: ... ; height: ... ; inline: ... ; justify: ... ; overflow: ... ; padding: ... ; shrink: ... ; tag: ... ; width: ... ; wrap: ... }>>>> } ; header: { type: PropType<string | Readonly<Partial<ExtractPropTypes<...>>> | null> } ; height: { type: (StringConstructor | NumberConstructor)[] } ; radius: { default: boolean ; type: BooleanConstructor } ; shadow: { type: PropType<"hover" | "always" | "none"> } ; size: { type: PropType<BaseSize> } ; width: { type: (StringConstructor | NumberConstructor)[] } }>>, { border: boolean ; card: boolean ; fit: boolean ; radius: boolean }, {}>, { actions?: (_: {}) => any ; default?: (_: {}) => any ; footer?: (_: {}) => any ; header?: (_: {}) => any ; title?: (_: {}) => any }>

Defined in

packages/ui/types/components/panel/Panel.d.ts:4

XQrcode

• Const XQrcode: __VLS_WithTemplateSlots<DefineComponent<{ color: { type: ObjectConstructor } ; darkColor: { default: string ; type: StringConstructor } ; lightColor: { default: string ; type: StringConstructor } ; margin: { type: NumberConstructor } ; quality: { default: number ; type: NumberConstructor } ; scale: { type: NumberConstructor } ; timeout: { default: number ; type: NumberConstructor } ; tip: { default: string ; type: StringConstructor } ; value: { default: string ; type: PropType<QRCodeValue> } ; width: { default: number ; type: NumberConstructor } }, { qrcodeRef: Ref<any> }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { refresh: () => void }, string, PublicProps, Readonly<ExtractPropTypes<{ color: { type: ObjectConstructor } ; darkColor: { default: string ; type: StringConstructor } ; lightColor: { default: string ; type: StringConstructor } ; margin: { type: NumberConstructor } ; quality: { default: number ; type: NumberConstructor } ; scale: { type: NumberConstructor } ; timeout: { default: number ; type: NumberConstructor } ; tip: { default: string ; type: StringConstructor } ; value: { default: string ; type: PropType<QRCodeValue> } ; width: { default: number ; type: NumberConstructor } }>> & { onRefresh?: () => any }, { darkColor: string ; lightColor: string ; quality: number ; timeout: number ; tip: string ; value: QRCodeValue ; width: number }, {}>, { logo?: (_: {}) => any ; tip?: (_: {}) => any }>

Defined in

packages/ui/types/components/qrcode/Qrcode.d.ts:3

XSmsCodeInput

• Const XSmsCodeInput: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>

Defined in

packages/ui/types/components/sms-code-input/SmsCodeInput.d.ts:2

XStartup

• Const XStartup: DefineComponent<{ actionLink: { default: string ; type: StringConstructor } ; actionText: { default: string ; type: StringConstructor } ; name: { default: string ; type: StringConstructor } ; tagline: { default: string ; type: StringConstructor } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{ actionLink: { default: string ; type: StringConstructor } ; actionText: { default: string ; type: StringConstructor } ; name: { default: string ; type: StringConstructor } ; tagline: { default: string ; type: StringConstructor } }>>, { actionLink: string ; actionText: string ; name: string ; tagline: string }, {}>

Defined in

packages/ui/types/components/startup/Startup.d.ts:2

XTabs

• Const XTabs: __VLS_WithTemplateSlots<DefineComponent<{ align: { type: PropType<"center" | "left" | "right"> } ; border: { type: BooleanConstructor } ; fit: { type: BooleanConstructor } ; items: { type: PropType<TabsItem[]> ; default: () => never[] } }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { actionClick: (props: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<... | ... | ...> } ; badge: { type: PropType<... | ... | ...> } ; button: { type: PropType<Partial<...>> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<... | ...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<Partial<...>> } ; icon: { type: PropType<IconParam> } ; label: { type: StringConstructor } ; menus: { type: PropType<...[]> } ; mode: { default: string ; type: PropType<ActionMode> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<BaseSize> } ; tooltip: { type: PropType<... | ...> } ; type: { default: string ; type: PropType<BaseType> } ; value: { type: PropType<unknown> } }>>>) => void ; actionCommand: (item: ActionMenuItem) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ align: { type: PropType<"center" | "left" | "right"> } ; border: { type: BooleanConstructor } ; fit: { type: BooleanConstructor } ; items: { type: PropType<TabsItem[]> ; default: () => never[] } }>> & { onActionClick?: (props: Readonly<Partial<ExtractPropTypes<{ background: ... ; badge: ... ; button: ... ; circle: ... ; disabled: ... ; draggable: ... ; dropdown: ... ; icon: ... ; label: ... ; menus: ... ; mode: ... ; name: ... ; size: ... ; tooltip: ... ; type: ... ; value: ... }>>>) => any ; onActionCommand?: (item: ActionMenuItem) => any }, { border: boolean ; fit: boolean ; items: TabsItem[] }, {}>, { default?: (_: { actions?: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<...> } ; badge: { type: PropType<...> } ; button: { type: PropType<...> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<...> } ; icon: { type: PropType<...> } ; label: { type: StringConstructor } ; menus: { type: PropType<...> } ; mode: { default: string ; type: PropType<...> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<...> } ; tooltip: { type: PropType<...> } ; type: { default: string ; type: PropType<...> } ; value: { type: PropType<...> } }>>>[] ; closable?: boolean ; component?: any ; disabled?: boolean ; icon?: IconParam ; label: string ; lazy?: boolean ; name?: string | number ; props?: Record<string, any> ; value?: string | number }) => any ; label?: (_: { actions?: Readonly<Partial<ExtractPropTypes<{ background: { default: string ; type: PropType<...> } ; badge: { type: PropType<...> } ; button: { type: PropType<...> } ; circle: { type: BooleanConstructor } ; disabled: { type: PropType<...> } ; draggable: { type: BooleanConstructor } ; dropdown: { type: PropType<...> } ; icon: { type: PropType<...> } ; label: { type: StringConstructor } ; menus: { type: PropType<...> } ; mode: { default: string ; type: PropType<...> } ; name: { type: StringConstructor } ; size: { default: string ; type: PropType<...> } ; tooltip: { type: PropType<...> } ; type: { default: string ; type: PropType<...> } ; value: { type: PropType<...> } }>>>[] ; closable?: boolean ; component?: any ; disabled?: boolean ; icon?: IconParam ; label: string ; lazy?: boolean ; name?: string | number ; props?: Record<string, any> ; value?: string | number }) => any }>

Defined in

packages/ui/types/components/tabs/Tabs.d.ts:9

XTest

• Const XTest: __VLS_WithTemplateSlots<DefineComponent<{ arrayProp: { type: ArrayConstructor } ; booleanProp: { type: BooleanConstructor } ; colorProp: { type: StringConstructor } ; iconProp: { type: StringConstructor } ; modelValue: { type: StringConstructor } ; numberProp: { type: NumberConstructor } ; objectProp: { type: ObjectConstructor } ; selectProp: { type: StringConstructor } ; stringProp: { type: StringConstructor } ; syncProp: { type: StringConstructor } }, { change: (params: any) => void ; click: () => void ; data: Ref<any> ; submit: () => void }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, { change: (data: any) => void ; click: (props: Readonly<Partial<ExtractPropTypes<{ arrayProp: { type: ArrayConstructor } ; booleanProp: { type: BooleanConstructor } ; colorProp: { type: StringConstructor } ; iconProp: { type: StringConstructor } ; modelValue: { type: StringConstructor } ; numberProp: { type: NumberConstructor } ; objectProp: { type: ObjectConstructor } ; selectProp: { type: StringConstructor } ; stringProp: { type: StringConstructor } ; syncProp: { type: StringConstructor } }>>>) => void ; submit: (props: Readonly<Partial<ExtractPropTypes<{ arrayProp: { type: ArrayConstructor } ; booleanProp: { type: BooleanConstructor } ; colorProp: { type: StringConstructor } ; iconProp: { type: StringConstructor } ; modelValue: { type: StringConstructor } ; numberProp: { type: NumberConstructor } ; objectProp: { type: ObjectConstructor } ; selectProp: { type: StringConstructor } ; stringProp: { type: StringConstructor } ; syncProp: { type: StringConstructor } }>>>) => void ; update:modelValue: (value?: string) => void ; update:syncProp: (value?: string) => void }, string, PublicProps, Readonly<ExtractPropTypes<{ arrayProp: { type: ArrayConstructor } ; booleanProp: { type: BooleanConstructor } ; colorProp: { type: StringConstructor } ; iconProp: { type: StringConstructor } ; modelValue: { type: StringConstructor } ; numberProp: { type: NumberConstructor } ; objectProp: { type: ObjectConstructor } ; selectProp: { type: StringConstructor } ; stringProp: { type: StringConstructor } ; syncProp: { type: StringConstructor } }>> & { onChange?: (data: any) => any ; onClick?: (props: Readonly<Partial<ExtractPropTypes<{ arrayProp: ... ; booleanProp: ... ; colorProp: ... ; iconProp: ... ; modelValue: ... ; numberProp: ... ; objectProp: ... ; selectProp: ... ; stringProp: ... ; syncProp: ... }>>>) => any ; onSubmit?: (props: Readonly<Partial<ExtractPropTypes<{ arrayProp: ... ; booleanProp: ... ; colorProp: ... ; iconProp: ... ; modelValue: ... ; numberProp: ... ; objectProp: ... ; selectProp: ... ; stringProp: ... ; syncProp: ... }>>>) => any ; onUpdate:modelValue?: (value?: string) => any ; onUpdate:syncProp?: (value?: string) => any }, { booleanProp: boolean }, {}>, { default?: (_: { data: any ; props: { arrayProp?: unknown[] ; booleanProp: boolean ; colorProp?: string ; iconProp?: string ; modelValue?: string ; numberProp?: number ; objectProp?: Record<string, any> ; selectProp?: string ; stringProp?: string ; syncProp?: string } }) => any ; extra?: (_: { data: any ; props: { arrayProp?: unknown[] ; booleanProp: boolean ; colorProp?: string ; iconProp?: string ; modelValue?: string ; numberProp?: number ; objectProp?: Record<string, any> ; selectProp?: string ; stringProp?: string ; syncProp?: string } }) => any }>

Defined in

packages/ui/types/components/test/Test.d.ts:2

actionBarProps

• Const actionBarProps: Object

Type declaration

Name	Type	Description
`background`	{ `default`: `string` ; `type`: `PropType`<`"hover"` \| `"always"` \| `"none"`> }	icon 背景设置，当 mode为 icon 时有效
`background.default`	`string`	-
`background.type`	`PropType`<`"hover"` \| `"always"` \| `"none"`>	-
`badge`	{ `type`: `PropType`<`Partial`<`BadgeProps`>> }	Badge 配置
`badge.type`	`PropType`<`Partial`<`BadgeProps`>>	-
`button`	{ `type`: `PropType`<`Partial`<`ButtonProps`>> }	ElButton 组件配置，mode为button时有效
`button.type`	`PropType`<`Partial`<`ButtonProps`>>	-
`circle`	{ `type`: `BooleanConstructor` }	icon 背景样式圆形，当 mode为 icon 时有效
`circle.type`	`BooleanConstructor`	-
`disabled`	{ `type`: `PropType`<`boolean` \| (`item`: `ActionProps`) => `boolean`> }	禁用
`disabled.type`	`PropType`<`boolean` \| (`item`: `ActionProps`) => `boolean`>	-
`dropdown`	{ `type`: `PropType`<`Partial`<`ExtractPropTypes`<{ `buttonProps`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`ButtonProps`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `disabled`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `false`, `boolean`> ; `effect`: { `__epPropKey`: `true` ; `default`: `"light"` ; `required`: `false` ; `type`: `PropType`<`string`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `hideOnClick`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `hideTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `id`: `StringConstructor` ; `loop`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `maxHeight`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `""`, `boolean`> ; `placement`: `IconAccessdeclined`<(...`args`: ...[]) => `any` \| () => `Placement` \| (... \| ...)[], `unknown`, `unknown`, `"bottom"`, `boolean`> ; `popperClass`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `popperOptions`: `IconAccessdeclined`<(...`args`: ...[]) => `Options` \| () => `Options` \| (... \| ...)[], `unknown`, `unknown`, () => {}, `boolean`> ; `role`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `"menu"`, `boolean`> ; `showTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `size`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `splitButton`: `BooleanConstructor` ; `tabindex`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `0`, `boolean`> ; `teleported`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `trigger`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| ... \| ... \| ... \| () => `IconAccessdeclined`<...> \| (... \| ...)[], `unknown`, `unknown`, `"hover"`, `boolean`> ; `type`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`IconAccessdeclined`<... \| ... \| ...[], `unknown`, `unknown`>> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } }>>> }	ElDropdown 组件配置
`dropdown.type`	`PropType`<`Partial`<`ExtractPropTypes`<{ `buttonProps`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`ButtonProps`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `disabled`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `false`, `boolean`> ; `effect`: { `__epPropKey`: `true` ; `default`: `"light"` ; `required`: `false` ; `type`: `PropType`<`string`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `hideOnClick`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `hideTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `id`: `StringConstructor` ; `loop`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `maxHeight`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `""`, `boolean`> ; `placement`: `IconAccessdeclined`<(...`args`: ...[]) => `any` \| () => `Placement` \| (... \| ...)[], `unknown`, `unknown`, `"bottom"`, `boolean`> ; `popperClass`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `popperOptions`: `IconAccessdeclined`<(...`args`: ...[]) => `Options` \| () => `Options` \| (... \| ...)[], `unknown`, `unknown`, () => {}, `boolean`> ; `role`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `"menu"`, `boolean`> ; `showTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `size`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `splitButton`: `BooleanConstructor` ; `tabindex`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `0`, `boolean`> ; `teleported`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `trigger`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| ... \| ... \| ... \| () => `IconAccessdeclined`<...> \| (... \| ...)[], `unknown`, `unknown`, `"hover"`, `boolean`> ; `type`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`IconAccessdeclined`<... \| ... \| ...[], `unknown`, `unknown`>> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } }>>>	-
`items`	{ `type`: `PropType`<`ActionBarItems`> }	动作项
`items.type`	`PropType`<`ActionBarItems`>	-
`mode`	{ `default`: `string` ; `type`: `PropType`<`ActionMode`> }	模式
`mode.default`	`string`	-
`mode.type`	`PropType`<`ActionMode`>	-
`size`	{ `default`: `string` ; `type`: `PropType`<`BaseSize`> }	尺寸
`size.default`	`string`	-
`size.type`	`PropType`<`BaseSize`>	-
`tooltip`	{ `type`: `PropType`<`Partial`<`ElTooltipProps`>> }	tooltip 配置
`tooltip.type`	`PropType`<`Partial`<`ElTooltipProps`>>	-
`type`	{ `default`: `string` ; `type`: `PropType`<`BaseType`> }	颜色类型
`type.default`	`string`	-
`type.type`	`PropType`<`BaseType`>	-

Defined in

packages/ui/types/components/action-bar/types.d.ts:12

actionProps

• Const actionProps: Object

Type declaration

Name	Type	Description
`background`	{ `default`: `string` ; `type`: `PropType`<`"hover"` \| `"always"` \| `"none"`> }	icon 背景设置，当 mode为 icon 时有效
`background.default`	`string`	-
`background.type`	`PropType`<`"hover"` \| `"always"` \| `"none"`>	-
`badge`	{ `type`: `PropType`<`string` \| `number` \| `Partial`<`BadgeProps`>> }	Badge 配置
`badge.type`	`PropType`<`string` \| `number` \| `Partial`<`BadgeProps`>>	-
`button`	{ `type`: `PropType`<`Partial`<`ButtonProps`>> }	ElButton 组件配置，mode为button时有效
`button.type`	`PropType`<`Partial`<`ButtonProps`>>	-
`circle`	{ `type`: `BooleanConstructor` }	icon 背景样式圆形，当 mode为 icon 时有效
`circle.type`	`BooleanConstructor`	-
`disabled`	{ `type`: `PropType`<`boolean` \| () => `boolean`> }	禁用
`disabled.type`	`PropType`<`boolean` \| () => `boolean`>	-
`draggable`	{ `type`: `BooleanConstructor` }	-
`draggable.type`	`BooleanConstructor`	-
`dropdown`	{ `type`: `PropType`<`Partial`<`ExtractPropTypes`<{ `buttonProps`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`ButtonProps`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `disabled`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `false`, `boolean`> ; `effect`: { `__epPropKey`: `true` ; `default`: `"light"` ; `required`: `false` ; `type`: `PropType`<`string`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `hideOnClick`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `hideTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `id`: `StringConstructor` ; `loop`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `maxHeight`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `""`, `boolean`> ; `placement`: `IconAccessdeclined`<(...`args`: ...[]) => `any` \| () => `Placement` \| (... \| ...)[], `unknown`, `unknown`, `"bottom"`, `boolean`> ; `popperClass`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `popperOptions`: `IconAccessdeclined`<(...`args`: ...[]) => `Options` \| () => `Options` \| (... \| ...)[], `unknown`, `unknown`, () => {}, `boolean`> ; `role`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `"menu"`, `boolean`> ; `showTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `size`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `splitButton`: `BooleanConstructor` ; `tabindex`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `0`, `boolean`> ; `teleported`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `trigger`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| ... \| ... \| ... \| () => `IconAccessdeclined`<...> \| (... \| ...)[], `unknown`, `unknown`, `"hover"`, `boolean`> ; `type`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`IconAccessdeclined`<... \| ... \| ...[], `unknown`, `unknown`>> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } }>>> }	ElDropdown 组件配置
`dropdown.type`	`PropType`<`Partial`<`ExtractPropTypes`<{ `buttonProps`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`ButtonProps`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `disabled`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `false`, `boolean`> ; `effect`: { `__epPropKey`: `true` ; `default`: `"light"` ; `required`: `false` ; `type`: `PropType`<`string`> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } ; `hideOnClick`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `hideTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `id`: `StringConstructor` ; `loop`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `maxHeight`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `""`, `boolean`> ; `placement`: `IconAccessdeclined`<(...`args`: ...[]) => `any` \| () => `Placement` \| (... \| ...)[], `unknown`, `unknown`, `"bottom"`, `boolean`> ; `popperClass`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `popperOptions`: `IconAccessdeclined`<(...`args`: ...[]) => `Options` \| () => `Options` \| (... \| ...)[], `unknown`, `unknown`, () => {}, `boolean`> ; `role`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `"menu"`, `boolean`> ; `showTimeout`: `IconAccessdeclined`<`NumberConstructor`, `unknown`, `unknown`, `150`, `boolean`> ; `size`: `IconAccessdeclined`<`StringConstructor`, `unknown`, `unknown`, `""`, `boolean`> ; `splitButton`: `BooleanConstructor` ; `tabindex`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| () => ... \| ... \| (... \| ...)[], `unknown`, `unknown`, `0`, `boolean`> ; `teleported`: `IconAccessdeclined`<`BooleanConstructor`, `unknown`, `unknown`, `true`, `boolean`> ; `trigger`: `IconAccessdeclined`<(...`args`: ...[]) => ... \| ... \| ... \| ... \| ... \| () => `IconAccessdeclined`<...> \| (... \| ...)[], `unknown`, `unknown`, `"hover"`, `boolean`> ; `type`: { `__epPropKey`: `true` ; `required`: `false` ; `type`: `PropType`<`IconAccessdeclined`<... \| ... \| ...[], `unknown`, `unknown`>> ; `validator`: (`val`: `unknown`) => `boolean` \| `undefined` } }>>>	-
`icon`	{ `type`: `PropType`<`IconParam`> }	图标配置
`icon.type`	`PropType`<`IconParam`>	-
`label`	{ `type`: `StringConstructor` }	动作标题文本
`label.type`	`StringConstructor`	-
`menus`	{ `type`: `PropType`<`ActionMenuItem`[]> }	下拉菜单配置
`menus.type`	`PropType`<`ActionMenuItem`[]>	-
`mode`	{ `default`: `string` ; `type`: `PropType`<`ActionMode`> }	模式
`mode.default`	`string`	-
`mode.type`	`PropType`<`ActionMode`>	-
`name`	{ `type`: `StringConstructor` }	动作名称标识
`name.type`	`StringConstructor`	-
`size`	{ `default`: `string` ; `type`: `PropType`<`BaseSize`> }	尺寸
`size.default`	`string`	-
`size.type`	`PropType`<`BaseSize`>	-
`tooltip`	{ `type`: `PropType`<`string` \| `Partial`<`ElTooltipProps`>> }	tooltip 配置
`tooltip.type`	`PropType`<`string` \| `Partial`<`ElTooltipProps`>>	-
`type`	{ `default`: `string` ; `type`: `PropType`<`BaseType`> }	颜色类型
`type.default`	`string`	-
`type.type`	`PropType`<`BaseType`>	-
`value`	{ `type`: `PropType`<`unknown`> }	动作值，用来传输数据
`value.type`	`PropType`<`unknown`>	-

Defined in

packages/ui/types/components/action/types.d.ts:18

builtinFieldEditors

• Const builtinFieldEditors: Record<BuiltinFieldEditorType, BuiltinFieldEditor>

Defined in

packages/ui/types/components/field/builtin.d.ts:7

containerProps

• Const containerProps: Object

Type declaration

Name	Type	Description
`align`	{ `default`: `string` ; `type`: `PropType`<`ContainerAlignItems`> }	交叉轴上对齐方式
`align.default`	`string`	-
`align.type`	`PropType`<`ContainerAlignItems`>	-
`alignContent`	{ `default`: `string` ; `type`: `PropType`<`ContainerAlignContent`> }	多根轴线的对齐方式。如果项目只有一根轴线，该属性不起作用
`alignContent.default`	`string`	-
`alignContent.type`	`PropType`<`ContainerAlignContent`>	-
`alignSelf`	{ `default`: `string` ; `type`: `PropType`<`ContainerAlignItems` \| `"auto"`> }	单个项目有与其他项目不一样的对齐方式。可覆盖容器的align-items属性
`alignSelf.default`	`string`	-
`alignSelf.type`	`PropType`<`ContainerAlignItems` \| `"auto"`>	-
`autoPointer`	{ `type`: `BooleanConstructor` }	-
`autoPointer.type`	`BooleanConstructor`	-
`direction`	{ `default`: `string` ; `type`: `PropType`<`ContainerDirection`> }	flex主轴方向
`direction.default`	`string`	-
`direction.type`	`PropType`<`ContainerDirection`>	-
`fit`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	宽高自适应
`fit.default`	`boolean`	-
`fit.type`	`BooleanConstructor`	-
`flex`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	开启flex布局
`flex.default`	`boolean`	-
`flex.type`	`BooleanConstructor`	-
`gap`	{ `type`: `BooleanConstructor` }	-
`gap.type`	`BooleanConstructor`	-
`grow`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	放大
`grow.default`	`boolean`	-
`grow.type`	`BooleanConstructor`	-
`height`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }	指定高度，fit 为true失效
`height.type`	(`StringConstructor` \| `NumberConstructor`)[]	-
`inline`	{ `type`: `BooleanConstructor` }	inline-flex
`inline.type`	`BooleanConstructor`	-
`justify`	{ `default`: `string` ; `type`: `PropType`<`ContainerJustifyContent`> }	主轴上的对齐方式。
`justify.default`	`string`	-
`justify.type`	`PropType`<`ContainerJustifyContent`>	-
`overflow`	{ `type`: `PropType`<`"hidden"` \| `"visible"` \| `"auto"`> }	css overflow
`overflow.type`	`PropType`<`"hidden"` \| `"visible"` \| `"auto"`>	-
`padding`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	内边距
`padding.default`	`boolean`	-
`padding.type`	`BooleanConstructor`	-
`shrink`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	缩小
`shrink.default`	`boolean`	-
`shrink.type`	`BooleanConstructor`	-
`tag`	{ `default`: `string` ; `type`: `StringConstructor` }	组件渲染html标签
`tag.default`	`string`	-
`tag.type`	`StringConstructor`	-
`width`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }	指定高度，fit 为true 失效
`width.type`	(`StringConstructor` \| `NumberConstructor`)[]	-
`wrap`	{ `default`: `string` ; `type`: `PropType`<`ContainerWrap`> }	换行
`wrap.default`	`string`	-
`wrap.type`	`PropType`<`ContainerWrap`>	-

Defined in

packages/ui/types/components/container/types.d.ts:10

dataItemProps

• Const dataItemProps: Object

Type declaration

Name	Type
`actionBarProps`	{ `type`: `PropType`<`ActionBarProps`> }
`actionBarProps.type`	`PropType`<`ActionBarProps`>
`actions`	{ `type`: `PropType`<`ActionBarItems`> }
`actions.type`	`PropType`<`ActionBarItems`>
`description`	{ `type`: `StringConstructor` }
`description.type`	`StringConstructor`
`direction`	{ `default`: `string` ; `type`: `PropType`<`"row"` \| `"column"`> }
`direction.default`	`string`
`direction.type`	`PropType`<`"row"` \| `"column"`>
`icon`	{ `type`: `PropType`<`IconParam`> }
`icon.type`	`PropType`<`IconParam`>
`imageHeight`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`imageHeight.type`	(`StringConstructor` \| `NumberConstructor`)[]
`imageSrc`	{ `type`: `StringConstructor` }
`imageSrc.type`	`StringConstructor`
`imageWidth`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`imageWidth.type`	(`StringConstructor` \| `NumberConstructor`)[]
`onImageClick`	{ `type`: `FunctionConstructor` }
`onImageClick.type`	`FunctionConstructor`
`onTitleClick`	{ `type`: `FunctionConstructor` }
`onTitleClick.type`	`FunctionConstructor`
`split`	{ `type`: `BooleanConstructor` }
`split.type`	`BooleanConstructor`
`title`	{ `type`: `StringConstructor` }
`title.type`	`StringConstructor`

Defined in

packages/ui/types/components/data-item/types.d.ts:5

dialogFormProps

• Const dialogFormProps: Object

Type declaration

Name	Type	Description
`cancel`	{ `default`: `string` ; `type`: (`BooleanConstructor` \| `StringConstructor`)[] }	-
`cancel.default`	`string`	-
`cancel.type`	(`BooleanConstructor` \| `StringConstructor`)[]	-
`formProps`	{ `type`: `PropType`<`Record`<`string`, `any`>> }	-
`formProps.type`	`PropType`<`Record`<`string`, `any`>>	-
`model`	{ `type`: `PropType`<`Record`<`string`, `any`>> ; `default`: () => `any` }	表单模型
`model.type`	`PropType`<`Record`<`string`, `any`>>	-
`model.default`	[object Object]	-
`modelValue`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	-
`modelValue.default`	`boolean`	-
`modelValue.type`	`BooleanConstructor`	-
`rules`	{ `type`: `PropType`<`Partial`<`Record`<`string`, `IconAccessdeclined`<`FormItemRule`>>>> }	-
`rules.type`	`PropType`<`Partial`<`Record`<`string`, `IconAccessdeclined`<`FormItemRule`>>>>	-
`size`	{ `type`: `PropType`<`BaseSize`> }	-
`size.type`	`PropType`<`BaseSize`>	-
`submit`	{ `default`: `string` ; `type`: (`BooleanConstructor` \| `StringConstructor`)[] }	-
`submit.default`	`string`	-
`submit.type`	(`BooleanConstructor` \| `StringConstructor`)[]	-
`submitMethod`	{ `type`: `PropType`<(`model`: `Record`<`string`, `any`>) => `Promise`<`boolean`>> }	表单提交处理方法, return true 关闭弹窗
`submitMethod.type`	`PropType`<(`model`: `Record`<`string`, `any`>) => `Promise`<`boolean`>>	-

Defined in

packages/ui/types/components/dialog-form/types.d.ts:6

dialogProps

• Const dialogProps: Object

Type declaration

Name	Type
`beforeClose`	{ `type`: `PropType`<() => `boolean` \| `Promise`<`boolean`>> }
`beforeClose.type`	`PropType`<() => `boolean` \| `Promise`<`boolean`>>
`bodyPadding`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`bodyPadding.default`	`boolean`
`bodyPadding.type`	`BooleanConstructor`
`cancel`	{ `type`: (`BooleanConstructor` \| `StringConstructor`)[] }
`cancel.type`	(`BooleanConstructor` \| `StringConstructor`)[]
`closable`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`closable.default`	`boolean`
`closable.type`	`BooleanConstructor`
`componentInstance`	{ `type`: `PropType`<`Record`<`string`, `any`> \| `null`> }
`componentInstance.type`	`PropType`<`Record`<`string`, `any`> \| `null`>
`content`	{ `type`: `PropType`<`Record`<`string`, `any`> \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }> \| `DefineComponent`<`any`, `any`, `any`, `any`>> }
`content.type`	`PropType`<`Record`<`string`, `any`> \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }> \| `DefineComponent`<`any`, `any`, `any`, `any`>>
`draggable`	{ `default`: `boolean` ; `type`: `PropType`<`boolean` \| `DraggableOptions`> }
`draggable.default`	`boolean`
`draggable.type`	`PropType`<`boolean` \| `DraggableOptions`>
`height`	{ `default`: `string` ; `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`height.default`	`string`
`height.type`	(`StringConstructor` \| `NumberConstructor`)[]
`icon`	{ `type`: `PropType`<`IconParam`> }
`icon.type`	`PropType`<`IconParam`>
`left`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`left.type`	(`StringConstructor` \| `NumberConstructor`)[]
`maximizable`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`maximizable.default`	`boolean`
`maximizable.type`	`BooleanConstructor`
`minimizable`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`minimizable.default`	`boolean`
`minimizable.type`	`BooleanConstructor`
`modal`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`modal.default`	`boolean`
`modal.type`	`BooleanConstructor`
`mode`	{ `default`: `string` ; `type`: `PropType`<`DialogMode`> }
`mode.default`	`string`
`mode.type`	`PropType`<`DialogMode`>
`modelValue`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`modelValue.default`	`boolean`
`modelValue.type`	`BooleanConstructor`
`primary`	{ `type`: `BooleanConstructor` }
`primary.type`	`BooleanConstructor`
`resizable`	{ `type`: `PropType`<`boolean` \| `ResizableOptions`> }
`resizable.type`	`PropType`<`boolean` \| `ResizableOptions`>
`size`	{ `default`: `string` ; `type`: `PropType`<`BaseSize`> }
`size.default`	`string`
`size.type`	`PropType`<`BaseSize`>
`src`	{ `type`: `StringConstructor` }
`src.type`	`StringConstructor`
`submit`	{ `type`: (`BooleanConstructor` \| `StringConstructor`)[] }
`submit.type`	(`BooleanConstructor` \| `StringConstructor`)[]
`subtitle`	{ `type`: `StringConstructor` }
`subtitle.type`	`StringConstructor`
`title`	{ `type`: `StringConstructor` }
`title.type`	`StringConstructor`
`top`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`top.type`	(`StringConstructor` \| `NumberConstructor`)[]
`width`	{ `default`: `string` ; `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`width.default`	`string`
`width.type`	(`StringConstructor` \| `NumberConstructor`)[]

Defined in

packages/ui/types/components/dialog/types.d.ts:8

fieldProps

• Const fieldProps: Object

Type declaration

Name	Type	Description
`cascader`	{ `type`: `PropType`<`string` \| `string`[]> }	级联字段，根据字段值变化刷新options
`cascader.type`	`PropType`<`string` \| `string`[]>	-
`disabled`	{ `type`: `PropType`<`boolean`> }	禁用
`disabled.type`	`PropType`<`boolean`>	-
`editor`	{ `default`: `string` ; `type`: `PropType`<`Record`<`string`, `any`> \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }> \| `BuiltinFieldEditorType`> }	编辑器组件
`editor.default`	`string`	-
`editor.type`	`PropType`<`Record`<`string`, `any`> \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }> \| `BuiltinFieldEditorType`>	-
`error`	{ `type`: `StringConstructor` }	校验错误信息
`error.type`	`StringConstructor`	-
`inline`	{ `type`: `BooleanConstructor` }	表单项内容采用inline布局
`inline.type`	`BooleanConstructor`	-
`label`	{ `type`: `StringConstructor` }	字段标题文本
`label.type`	`StringConstructor`	-
`modelValue`	{ `type`: `PropType`<`any`> ; `default`: (`context`: `any`) => `any` }	字段值
`modelValue.type`	`PropType`<`any`>	-
`modelValue.default`	[object Object]	-
`name`	{ `type`: `StringConstructor` }	字段名称
`name.type`	`StringConstructor`	-
`options`	{ `type`: `PropType`<`FieldOption`[] \| `FieldOptionsLoader`> }	选项数据
`options.type`	`PropType`<`FieldOption`[] \| `FieldOptionsLoader`>	-
`placeholder`	{ `type`: `PropType`<`string` \| `null`> }	null 不显示 placeholder
`placeholder.type`	`PropType`<`string` \| `null`>	-
`props`	{ `type`: `PropType`<`Record`<`string`, `any`>> }	编辑器组件参数
`props.type`	`PropType`<`Record`<`string`, `any`>>	-
`readonly`	{ `type`: `PropType`<`boolean`> }	只读
`readonly.type`	`PropType`<`boolean`>	-
`size`	{ `type`: `PropType`<`BaseSize`> }	输入框尺寸
`size.type`	`PropType`<`BaseSize`>	-
`tip`	{ `type`: `StringConstructor` }	提示文本
`tip.type`	`StringConstructor`	-
`tooltipMessage`	{ `default`: `boolean` ; `type`: `PropType`<`boolean` \| `Partial`<`ElTooltipProps`>> }	是否在tooltip显示校验信息
`tooltipMessage.default`	`boolean`	-
`tooltipMessage.type`	`PropType`<`boolean` \| `Partial`<`ElTooltipProps`>>	-
`tooltipPosition`	{ `default`: `string` ; `type`: `PropType`<`number` \| `"inner"` \| `"outer"`> }	tooltip信息显示相对输入框的位置
`tooltipPosition.default`	`string`	-
`tooltipPosition.type`	`PropType`<`number` \| `"inner"` \| `"outer"`>	-
`visible`	{ `default`: `boolean` ; `type`: (`BooleanConstructor` \| `ObjectConstructor` \| `FunctionConstructor`)[] }	是否显示控制
`visible.default`	`boolean`	-
`visible.type`	(`BooleanConstructor` \| `ObjectConstructor` \| `FunctionConstructor`)[]	-
`width`	{ `type`: `PropType`<`string` \| `number`> }	-
`width.type`	`PropType`<`string` \| `number`>	-

Defined in

packages/ui/types/components/field/types.d.ts:28

formInstanceKey

• Const formInstanceKey: InjectionKey<ComponentInternalInstance | null>

Defined in

packages/ui/types/components/form/types.d.ts:68

formModelKey

• Const formModelKey: InjectionKey<FormModel | null>

Defined in

packages/ui/types/components/form/types.d.ts:70

formProps

• Const formProps: Object

Type declaration

Name	Type	Description
`footer`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	显示底部操作按钮
`footer.default`	`boolean`	-
`footer.type`	`BooleanConstructor`	-
`inline`	{ `type`: `BooleanConstructor` }	inline模式
`inline.type`	`BooleanConstructor`	-
`inlineColumns`	{ `type`: `NumberConstructor` }	inline模式显示列数
`inlineColumns.type`	`NumberConstructor`	-
`model`	{ `type`: `PropType`<`Record`<`string`, `any`>> ; `default`: () => `any` }	表单模型
`model.type`	`PropType`<`Record`<`string`, `any`>>	-
`model.default`	[object Object]	-
`resetText`	{ `default`: `string` ; `type`: `StringConstructor` }	重置按钮文本
`resetText.default`	`string`	-
`resetText.type`	`StringConstructor`	-
`submitMethod`	{ `type`: `PropType`<(`model`: `FormModel`) => `Promise`<`any`>> }	表单提交处理方法
`submitMethod.type`	`PropType`<(`model`: `FormModel`) => `Promise`<`any`>>	-
`submitText`	{ `default`: `string` ; `type`: `StringConstructor` }	提交按钮文本
`submitText.default`	`string`	-
`submitText.type`	`StringConstructor`	-
`tooltipMessage`	{ `default`: `undefined` ; `type`: `PropType`<`boolean` \| `Partial`<`ElTooltipProps`>> }	是否在tooltip显示校验信息
`tooltipMessage.default`	`undefined`	-
`tooltipMessage.type`	`PropType`<`boolean` \| `Partial`<`ElTooltipProps`>>	-

Defined in

packages/ui/types/components/form/types.d.ts:6

headerProps

• Const headerProps: Object

Type declaration

Name	Type
`border`	{ `type`: `BooleanConstructor` }
`border.type`	`BooleanConstructor`
`content`	{ `default`: `string` ; `type`: `StringConstructor` }
`content.default`	`string`
`content.type`	`StringConstructor`
`icon`	{ `type`: `PropType`<`IconParam`> }
`icon.type`	`PropType`<`IconParam`>
`more`	{ `type`: `BooleanConstructor` }
`more.type`	`BooleanConstructor`
`size`	{ `default`: `string` ; `type`: `PropType`<`BaseSize`> }
`size.default`	`string`
`size.type`	`PropType`<`BaseSize`>
`subtitle`	{ `type`: `StringConstructor` }
`subtitle.type`	`StringConstructor`

Defined in

packages/ui/types/components/header/types.d.ts:5

iconProps

• Const iconProps: Object

Type declaration

Name	Type
`background`	{ `type`: `StringConstructor` }
`background.type`	`StringConstructor`
`color`	{ `type`: `StringConstructor` }
`color.type`	`StringConstructor`
`icon`	{ `type`: `PropType`<`string` \| `object` \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }>> }
`icon.type`	`PropType`<`string` \| `object` \| `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }>>
`padding`	{ `type`: `NumberConstructor` }
`padding.type`	`NumberConstructor`
`radius`	{ `type`: `NumberConstructor` }
`radius.type`	`NumberConstructor`
`size`	{ `default`: `string` ; `type`: `PropType`<`IconSize`> }
`size.default`	`string`
`size.type`	`PropType`<`IconSize`>
`src`	{ `type`: `StringConstructor` }
`src.type`	`StringConstructor`

Defined in

packages/ui/types/components/icon/types.d.ts:11

iconSizeMap

• Const iconSizeMap: Object

Type declaration

Name	Type
`default`	`number`
`large`	`number`
`small`	`number`

Defined in

packages/ui/types/components/icon/types.d.ts:5

imageCodeInputProps

• Const imageCodeInputProps: Object

Type declaration

Name	Type	Description
`image`	{ `type`: `PropType`<() => `Promise`<`string`>> }	image
`image.type`	`PropType`<() => `Promise`<`string`>>	-
`maxLength`	{ `default`: `number` ; `type`: `NumberConstructor` }	maxLength
`maxLength.default`	`number`	-
`maxLength.type`	`NumberConstructor`	-
`placeholder`	{ `default`: `string` ; `type`: `StringConstructor` }	placeholder
`placeholder.default`	`string`	-
`placeholder.type`	`StringConstructor`	-
`validate`	{ `type`: `PropType`<(`value`: `string`) => `Promise`<`boolean`>> }	validate 校验
`validate.type`	`PropType`<(`value`: `string`) => `Promise`<`boolean`>>	-

Defined in

packages/ui/types/components/image-code-input/types.d.ts:4

inputUnitProps

• Const inputUnitProps: Object

Type declaration

Name	Type
`appendWidth`	{ `default`: `number` ; `type`: `NumberConstructor` }
`appendWidth.default`	`number`
`appendWidth.type`	`NumberConstructor`
`format`	{ `type`: `StringConstructor` }
`format.type`	`StringConstructor`
`modelValue`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }
`modelValue.type`	(`StringConstructor` \| `NumberConstructor`)[]
`selectProps`	{ `type`: `PropType`<`Record`<`string`, `any`>> }
`selectProps.type`	`PropType`<`Record`<`string`, `any`>>
`unit`	{ `type`: `StringConstructor` }
`unit.type`	`StringConstructor`
`units`	{ `type`: `PropType`<(`string` \| `InputUnitOption`)[]> }
`units.type`	`PropType`<(`string` \| `InputUnitOption`)[]>
`withUnit`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }
`withUnit.default`	`boolean`
`withUnit.type`	`BooleanConstructor`

Defined in

packages/ui/types/components/input-unit/types.d.ts:8

listProps

• Const listProps: Object

Type declaration

Name	Type	Description
`data`	{ `type`: `PropType`<`DataLoader`<`ListData`, `ListState`>> ; `default`: () => `never`[] }	-
`data.type`	`PropType`<`DataLoader`<`ListData`, `ListState`>>	-
`data.default`	[object Object]	-
`dataKey`	{ `type`: `StringConstructor` }	-
`dataKey.type`	`StringConstructor`	-
`height`	{ `default`: `string` ; `type`: (`StringConstructor` \| `NumberConstructor`)[] }	-
`height.default`	`string`	-
`height.type`	(`StringConstructor` \| `NumberConstructor`)[]	-
`infiniteScroll`	{ `type`: `PropType`<`boolean` \| `ListInfiniteScroll`> }	-
`infiniteScroll.type`	`PropType`<`boolean` \| `ListInfiniteScroll`>	-
`itemHeight`	{ `type`: `PropType`<`number` \| (`index`: `number`) => `number`> }	设置 itemHeight 即自动开启虚拟滚动
`itemHeight.type`	`PropType`<`number` \| (`index`: `number`) => `number`>	-
`page`	{ `default`: `number` ; `type`: `NumberConstructor` }	-
`page.default`	`number`	-
`page.type`	`NumberConstructor`	-
`pageSize`	{ `default`: `number` ; `type`: `NumberConstructor` }	-
`pageSize.default`	`number`	-
`pageSize.type`	`NumberConstructor`	-
`pager`	{ `type`: `PropType`<`boolean` \| `Partial`<`PaginationProps`>> }	-
`pager.type`	`PropType`<`boolean` \| `Partial`<`PaginationProps`>>	-
`width`	{ `default`: `string` ; `type`: (`StringConstructor` \| `NumberConstructor`)[] }	-
`width.default`	`string`	-
`width.type`	(`StringConstructor` \| `NumberConstructor`)[]	-

Defined in

packages/ui/types/components/list/types.d.ts:19

maskProps

• Const maskProps: Object

Type declaration

Name	Type	Description
`actions`	{ `type`: `PropType`<`ActionBarItems`> }	右上角工具条配置
`actions.type`	`PropType`<`ActionBarItems`>	-
`addFavorite`	{ `type`: `PropType`<(`menu`: `MenuDataItem`) => `void`> }	-
`addFavorite.type`	`PropType`<(`menu`: `MenuDataItem`) => `void`>	-
`avatar`	{ `type`: `StringConstructor` }	用户头像图片url
`avatar.type`	`StringConstructor`	-
`disabled`	{ `type`: `BooleanConstructor` }	禁用框架容器
`disabled.type`	`BooleanConstructor`	-
`favorites`	{ `type`: `PropType`<`MenuDataItem`[] \| () => `Promise`<`MenuDataItem`[]> \| `MenuDataItem`[]> ; `default`: () => `never`[] }	收藏菜单项
`favorites.type`	`PropType`<`MenuDataItem`[] \| () => `Promise`<`MenuDataItem`[]> \| `MenuDataItem`[]>	-
`favorites.default`	[object Object]	-
`home`	{ `default`: `string` ; `type`: `PropType`<`string` \| `MaskTab`> }	主页Tab配置
`home.default`	`string`	-
`home.type`	`PropType`<`string` \| `MaskTab`>	-
`logo`	{ `default`: `string` ; `type`: `StringConstructor` }	系统logo
`logo.default`	`string`	-
`logo.type`	`StringConstructor`	-
`menuAdapter`	{ `type`: `PropType`<(`menu`: `MenuDataItem`) => `MenuDataItem`> }	菜单项数据适配函数，用作转换菜单项数据
`menuAdapter.type`	`PropType`<(`menu`: `MenuDataItem`) => `MenuDataItem`>	-
`menus`	{ `type`: `PropType`<`MenuDataItem`[] \| () => `Promise`<`MenuDataItem`[]> \| `MenuDataItem`[]> ; `default`: () => `never`[] }	菜单项数据
`menus.type`	`PropType`<`MenuDataItem`[] \| () => `Promise`<`MenuDataItem`[]> \| `MenuDataItem`[]>	-
`menus.default`	[object Object]	-
`removeFavorite`	{ `type`: `PropType`<(`menu`: `MenuDataItem`) => `void`> }	-
`removeFavorite.type`	`PropType`<(`menu`: `MenuDataItem`) => `void`>	-
`tabs`	{ `default`: `number` ; `type`: `NumberConstructor` }	最大tabs数量
`tabs.default`	`number`	-
`tabs.type`	`NumberConstructor`	-
`theme`	{ `type`: `BooleanConstructor` }	开启主题切换
`theme.type`	`BooleanConstructor`	-
`title`	{ `default`: `string` ; `type`: `StringConstructor` }	系统标题
`title.default`	`string`	-
`title.type`	`StringConstructor`	-

Defined in

packages/ui/types/components/mask/types.d.ts:7

panelProps

• Const panelProps: Object

Type declaration

Name	Type	Description
`body`	{ `type`: `PropType`<`Readonly`<`Partial`<`ExtractPropTypes`<{ `align`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems`> } ; `alignContent`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignContent`> } ; `alignSelf`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems` \| `"auto"`> } ; `autoPointer`: { `type`: `BooleanConstructor` } ; `direction`: { `default`: `string` ; `type`: `PropType`<`ContainerDirection`> } ; `fit`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `flex`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `gap`: { `type`: `BooleanConstructor` } ; `grow`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `height`: { `type`: (... \| ...)[] } ; `inline`: { `type`: `BooleanConstructor` } ; `justify`: { `default`: `string` ; `type`: `PropType`<`ContainerJustifyContent`> } ; `overflow`: { `type`: `PropType`<`"hidden"` \| `"visible"` \| `"auto"`> } ; `padding`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `shrink`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `tag`: { `default`: `string` ; `type`: `StringConstructor` } ; `width`: { `type`: (... \| ...)[] } ; `wrap`: { `default`: `string` ; `type`: `PropType`<`ContainerWrap`> } }>>>> }	-
`body.type`	`PropType`<`Readonly`<`Partial`<`ExtractPropTypes`<{ `align`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems`> } ; `alignContent`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignContent`> } ; `alignSelf`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems` \| `"auto"`> } ; `autoPointer`: { `type`: `BooleanConstructor` } ; `direction`: { `default`: `string` ; `type`: `PropType`<`ContainerDirection`> } ; `fit`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `flex`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `gap`: { `type`: `BooleanConstructor` } ; `grow`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `height`: { `type`: (... \| ...)[] } ; `inline`: { `type`: `BooleanConstructor` } ; `justify`: { `default`: `string` ; `type`: `PropType`<`ContainerJustifyContent`> } ; `overflow`: { `type`: `PropType`<`"hidden"` \| `"visible"` \| `"auto"`> } ; `padding`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `shrink`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `tag`: { `default`: `string` ; `type`: `StringConstructor` } ; `width`: { `type`: (... \| ...)[] } ; `wrap`: { `default`: `string` ; `type`: `PropType`<`ContainerWrap`> } }>>>>	-
`border`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	显示边框
`border.default`	`boolean`	-
`border.type`	`BooleanConstructor`	-
`card`	{ `type`: `BooleanConstructor` }	卡片模式
`card.type`	`BooleanConstructor`	-
`fit`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	宽高自适应
`fit.default`	`boolean`	-
`fit.type`	`BooleanConstructor`	-
`footer`	{ `type`: `PropType`<`Readonly`<`Partial`<`ExtractPropTypes`<{ `align`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems`> } ; `alignContent`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignContent`> } ; `alignSelf`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems` \| `"auto"`> } ; `autoPointer`: { `type`: `BooleanConstructor` } ; `direction`: { `default`: `string` ; `type`: `PropType`<`ContainerDirection`> } ; `fit`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `flex`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `gap`: { `type`: `BooleanConstructor` } ; `grow`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `height`: { `type`: (... \| ...)[] } ; `inline`: { `type`: `BooleanConstructor` } ; `justify`: { `default`: `string` ; `type`: `PropType`<`ContainerJustifyContent`> } ; `overflow`: { `type`: `PropType`<`"hidden"` \| `"visible"` \| `"auto"`> } ; `padding`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `shrink`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `tag`: { `default`: `string` ; `type`: `StringConstructor` } ; `width`: { `type`: (... \| ...)[] } ; `wrap`: { `default`: `string` ; `type`: `PropType`<`ContainerWrap`> } }>>>> }	-
`footer.type`	`PropType`<`Readonly`<`Partial`<`ExtractPropTypes`<{ `align`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems`> } ; `alignContent`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignContent`> } ; `alignSelf`: { `default`: `string` ; `type`: `PropType`<`ContainerAlignItems` \| `"auto"`> } ; `autoPointer`: { `type`: `BooleanConstructor` } ; `direction`: { `default`: `string` ; `type`: `PropType`<`ContainerDirection`> } ; `fit`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `flex`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `gap`: { `type`: `BooleanConstructor` } ; `grow`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `height`: { `type`: (... \| ...)[] } ; `inline`: { `type`: `BooleanConstructor` } ; `justify`: { `default`: `string` ; `type`: `PropType`<`ContainerJustifyContent`> } ; `overflow`: { `type`: `PropType`<`"hidden"` \| `"visible"` \| `"auto"`> } ; `padding`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `shrink`: { `default`: `boolean` ; `type`: `BooleanConstructor` } ; `tag`: { `default`: `string` ; `type`: `StringConstructor` } ; `width`: { `type`: (... \| ...)[] } ; `wrap`: { `default`: `string` ; `type`: `PropType`<`ContainerWrap`> } }>>>>	-
`header`	{ `type`: `PropType`<`string` \| `Readonly`<`Partial`<`ExtractPropTypes`<{ `border`: { `type`: `BooleanConstructor` } ; `content`: { `default`: `string` ; `type`: `StringConstructor` } ; `icon`: { `type`: `PropType`<`IconParam`> } ; `more`: { `type`: `BooleanConstructor` } ; `size`: { `default`: `string` ; `type`: `PropType`<`BaseSize`> } ; `subtitle`: { `type`: `StringConstructor` } }>>> \| `null`> }	头部设置
`header.type`	`PropType`<`string` \| `Readonly`<`Partial`<`ExtractPropTypes`<{ `border`: { `type`: `BooleanConstructor` } ; `content`: { `default`: `string` ; `type`: `StringConstructor` } ; `icon`: { `type`: `PropType`<`IconParam`> } ; `more`: { `type`: `BooleanConstructor` } ; `size`: { `default`: `string` ; `type`: `PropType`<`BaseSize`> } ; `subtitle`: { `type`: `StringConstructor` } }>>> \| `null`>	-
`height`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }	指定高度，fit 为true失效
`height.type`	(`StringConstructor` \| `NumberConstructor`)[]	-
`radius`	{ `default`: `boolean` ; `type`: `BooleanConstructor` }	圆角
`radius.default`	`boolean`	-
`radius.type`	`BooleanConstructor`	-
`shadow`	{ `type`: `PropType`<`"hover"` \| `"always"` \| `"none"`> }	阴影设置
`shadow.type`	`PropType`<`"hover"` \| `"always"` \| `"none"`>	-
`size`	{ `type`: `PropType`<`BaseSize`> }	尺寸
`size.type`	`PropType`<`BaseSize`>	-
`width`	{ `type`: (`StringConstructor` \| `NumberConstructor`)[] }	指定高度，fit 为true 失效
`width.type`	(`StringConstructor` \| `NumberConstructor`)[]	-

Defined in

packages/ui/types/components/panel/types.d.ts:5

qrcodeProps

• Const qrcodeProps: Object

Type declaration

Name	Type	Description
`color`	{ `type`: `ObjectConstructor` }	-
`color.type`	`ObjectConstructor`	-
`darkColor`	{ `default`: `string` ; `type`: `StringConstructor` }	dark color
`darkColor.default`	`string`	-
`darkColor.type`	`StringConstructor`	-
`lightColor`	{ `default`: `string` ; `type`: `StringConstructor` }	dark color
`lightColor.default`	`string`	-
`lightColor.type`	`StringConstructor`	-
`margin`	{ `type`: `NumberConstructor` }	外边距 margin
`margin.type`	`NumberConstructor`	-
`quality`	{ `default`: `number` ; `type`: `NumberConstructor` }	-
`quality.default`	`number`	-
`quality.type`	`NumberConstructor`	-
`scale`	{ `type`: `NumberConstructor` }	规模 scale
`scale.type`	`NumberConstructor`	-
`timeout`	{ `default`: `number` ; `type`: `NumberConstructor` }	-
`timeout.default`	`number`	-
`timeout.type`	`NumberConstructor`	-
`tip`	{ `default`: `string` ; `type`: `StringConstructor` }	-
`tip.default`	`string`	-
`tip.type`	`StringConstructor`	-
`value`	{ `default`: `string` ; `type`: `PropType`<`QRCodeValue`> }	-
`value.default`	`string`	-
`value.type`	`PropType`<`QRCodeValue`>	-
`width`	{ `default`: `number` ; `type`: `NumberConstructor` }	宽度 width
`width.default`	`number`	-
`width.type`	`NumberConstructor`	-

Defined in

packages/ui/types/components/qrcode/types.d.ts:11

startupProps

• Const startupProps: Object

Type declaration

Name	Type
`actionLink`	{ `default`: `string` ; `type`: `StringConstructor` }
`actionLink.default`	`string`
`actionLink.type`	`StringConstructor`
`actionText`	{ `default`: `string` ; `type`: `StringConstructor` }
`actionText.default`	`string`
`actionText.type`	`StringConstructor`
`name`	{ `default`: `string` ; `type`: `StringConstructor` }
`name.default`	`string`
`name.type`	`StringConstructor`
`tagline`	{ `default`: `string` ; `type`: `StringConstructor` }
`tagline.default`	`string`
`tagline.type`	`StringConstructor`

Defined in

packages/ui/types/components/startup/types.d.ts:3

tabsProps

• Const tabsProps: Object

Type declaration

Name	Type
`align`	{ `type`: `PropType`<`"center"` \| `"left"` \| `"right"`> }
`align.type`	`PropType`<`"center"` \| `"left"` \| `"right"`>
`border`	{ `type`: `BooleanConstructor` }
`border.type`	`BooleanConstructor`
`fit`	{ `type`: `BooleanConstructor` }
`fit.type`	`BooleanConstructor`
`items`	{ `type`: `PropType`<`TabsItem`[]> ; `default`: () => `never`[] }
`items.type`	`PropType`<`TabsItem`[]>
`items.default`	[object Object]

Defined in

packages/ui/types/components/tabs/types.d.ts:17

testProps

• Const testProps: Object

Type declaration

Name	Type
`arrayProp`	{ `type`: `ArrayConstructor` }
`arrayProp.type`	`ArrayConstructor`
`booleanProp`	{ `type`: `BooleanConstructor` }
`booleanProp.type`	`BooleanConstructor`
`colorProp`	{ `type`: `StringConstructor` }
`colorProp.type`	`StringConstructor`
`iconProp`	{ `type`: `StringConstructor` }
`iconProp.type`	`StringConstructor`
`modelValue`	{ `type`: `StringConstructor` }
`modelValue.type`	`StringConstructor`
`numberProp`	{ `type`: `NumberConstructor` }
`numberProp.type`	`NumberConstructor`
`objectProp`	{ `type`: `ObjectConstructor` }
`objectProp.type`	`ObjectConstructor`
`selectProp`	{ `type`: `StringConstructor` }
`selectProp.type`	`StringConstructor`
`stringProp`	{ `type`: `StringConstructor` }
`stringProp.type`	`StringConstructor`
`syncProp`	{ `type`: `StringConstructor` }
`syncProp.type`	`StringConstructor`

Defined in

packages/ui/types/components/test/types.d.ts:3

vDraggable

• Const vDraggable: Directive<HTMLElement, DraggableOptions>

Defined in

packages/ui/types/directives/vDraggable.d.ts:46

vResizable

• Const vResizable: Directive<HTMLElement, ResizableOptions>

Defined in

packages/ui/types/directives/vResizable.d.ts:38

Functions

createDialog

▸ createDialog(props, context?): Object

Parameters

Name	Type
`props`	`CreateDialogProps`
`context?`	`null` \| `AppContext`

Returns

Object

Name	Type
`destroy`	() => `void`
`vnode`	`VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`; }>

Defined in

packages/ui/types/components/dialog/create.d.ts:7

defineTab

▸ defineTab(options?): Object

Parameters

Name	Type
`options?`	`TabCreator` \| `Partial`<`MaskTab`>

Returns

Object

Name	Type
`mask`	`any`
`tab`	`ComputedRef`<`MaskTab` \| `null`>

Defined in

packages/ui/types/components/mask/defineTab.d.ts:4

getSizeValue

▸ getSizeValue(value): string

Parameters

Name	Type
`value`	`string` \| `number`

Returns

string

Defined in

packages/ui/types/utils/util.d.ts:1

makeInstaller

▸ makeInstaller(components?): Object

Parameters

Name	Type
`components?`	`any`[]

Returns

Object

Name	Type
`install`	(`app`: `App`<`any`>, `options?`: `InstallerOptions`) => `void`

Defined in

packages/ui/types/utils/install.d.ts:7

parseSize

▸ parseSize(size, max): number

Parameters

Name	Type
`size`	`undefined` \| `string` \| `number`
`max`	`number`

Returns

number

Defined in

packages/ui/types/utils/util.d.ts:2

toObjectProps

▸ toObjectProps<T>(value?, defaultValue?): T

Type parameters

Name	Type
`T`	extends `Record`<`string`, `any`>

Parameters

Name	Type
`value?`	`boolean` \| `T`
`defaultValue?`	`T`

Returns

T

Defined in

packages/ui/types/utils/util.d.ts:3

useAdapter

▸ useAdapter(): Adapter

Returns

Adapter

Defined in

packages/ui/types/adapter.d.ts:10

useDisabled

▸ useDisabled(disabled, params?): ComputedRef<boolean>

Parameters

Name	Type
`disabled`	`IUseDisabled`
`params?`	`any`

Returns

ComputedRef<boolean>

Defined in

packages/ui/types/hooks/useDisabled.d.ts:4

useIcon

▸ useIcon(icon): Record<string, any> | undefined

Parameters

Name	Type
`icon`	`MaybeRef`<`undefined` \| `IconParam`>

Returns

Record<string, any> | undefined

Defined in

packages/ui/types/hooks/useIcon.d.ts:5

useIconProps

▸ useIconProps(iconRef): ComputedRef<IconProps | null>

Parameters

Name	Type
`iconRef`	`MaybeRef`<`undefined` \| `IconParam`>

Returns

ComputedRef<IconProps | null>

Defined in

packages/ui/types/hooks/useIcon.d.ts:4

useLoader

▸ useLoader<T, P>(loaderRef, defaultValue, params?): UseLoaderResult<T>

Type parameters

Name	Type
`T`	`any`
`P`	`any`

Parameters

Name	Type
`loaderRef`	`MaybeRef`<`T` \| (`params?`: `P`) => `T` \| `Promise`<`T`>>
`defaultValue`	`T`
`params?`	`P`

Returns

UseLoaderResult<T>

Defined in

packages/ui/types/hooks/useLoader.d.ts:8

Module: ui ​

Table of contents ​

Classes ​

Interfaces ​

Type Aliases ​

Variables ​

Functions ​

Type Aliases ​

ActionBarEmits ​

Type declaration ​

Defined in ​

ActionBarItem ​

Defined in ​

ActionBarItems ​

Defined in ​

ActionBarProps ​

Defined in ​

ActionDropdown ​

Defined in ​

ActionEmits ​

Type declaration ​

Defined in ​

ActionMode ​

Defined in ​

ActionProps ​

Defined in ​

AttachmentEmits ​

Type declaration ​

Defined in ​

AttachmentFileType ​

Defined in ​

AttachmentProps ​

Defined in ​

AttachmentThumbnail ​

Type declaration ​

Parameters ​

Returns ​

Defined in ​

AttachmentUploader ​

Type declaration ​

Parameters ​

Returns ​

Defined in ​

BaseSize ​

Defined in ​

BaseType ​

Defined in ​

BuiltinFieldEditorType ​

Defined in ​

ComponentPropsType ​

Type parameters ​

Defined in ​

ContainerAlignContent ​

Defined in ​

ContainerAlignItems ​

Defined in ​

ContainerDirection ​

Defined in ​

ContainerInstance ​

Defined in ​

ContainerJustifyContent ​

Defined in ​

ContainerProps ​

Defined in ​

ContainerWrap ​

Defined in ​

CreateDialogProps ​

Defined in ​

DataItemEmits ​

Type declaration ​

Defined in ​

DataItemProps ​

Defined in ​

DataLoader ​

Type parameters ​

Defined in ​

DialogEmits ​

Type declaration ​

Defined in ​

DialogFormEmits ​

Module: ui

Table of contents

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ActionBarEmits

Type declaration

Defined in

ActionBarItem

Defined in

ActionBarItems

Defined in

ActionBarProps

Defined in

ActionDropdown

Defined in

ActionEmits

Type declaration

Defined in

ActionMode

Defined in

ActionProps

Defined in

AttachmentEmits

Type declaration

Defined in

AttachmentFileType

Defined in

AttachmentProps

Defined in

AttachmentThumbnail

Type declaration

Parameters

Returns

Defined in

AttachmentUploader

Type declaration

Parameters

Returns

Defined in

BaseSize

Defined in

BaseType

Defined in

BuiltinFieldEditorType

Defined in

ComponentPropsType

Type parameters

Defined in

ContainerAlignContent

Defined in

ContainerAlignItems

Defined in

ContainerDirection

Defined in

ContainerInstance

Defined in

ContainerJustifyContent

Defined in

ContainerProps

Defined in

ContainerWrap

Defined in

CreateDialogProps

Defined in

DataItemEmits

Type declaration

Defined in

DataItemProps

Defined in

DataLoader

Type parameters

Defined in

DialogEmits

Type declaration

Defined in

DialogFormEmits