{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"name": "antdv-next",
"version": "1.2.2",
"js-types-syntax": "typescript",
"description-markup": "markdown",
"framework": "vue",
"contributions": {
"html": {
"elements": [
{
"name": "a-affix",
"description": "(ZH) 将页面元素钉在可视范围。\n\n(EN) Stick an element to the viewport.",
"attributes": [
{
"name": "offset-top",
"description": "Offset from the top of the viewport (in pixels)",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "offset-bottom",
"description": "Offset from the bottom of the viewport (in pixels)",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "target",
"description": "Specifies the scrollable area DOM node",
"default": "() => window",
"value": {
"kind": "expression",
"type": "() => Window | HTMLElement | null"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 固定状态改变时触发的回调函数\n\n(EN) Callback for when Affix state is changed",
"arguments": [
{
"name": "payload",
"type": "(affixed?: boolean) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-alert",
"description": "(ZH) 警告提示，展现需要关注的信息。\n\n(EN) Display warning messages that require attention.",
"attributes": [
{
"name": "type",
"description": "Type of Alert styles, options: success, info, warning, error",
"default": "info, in banner mode default is warning",
"value": {
"kind": "expression",
"type": "'success' | 'info' | 'warning' | 'error'"
}
},
{
"name": "closable",
"description": "The config of closable, >=5.15.0: support aria-*",
"default": "false",
"value": {
"kind": "expression",
"type": "ClosableType"
}
},
{
"name": "title",
"description": "Content of Alert",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "message",
"description": "Content of Alert, please use title instead",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "description",
"description": "Additional content of Alert",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "after-close",
"description": "Called when close animation is finished, please use closable.afterClose instead",
"value": {
"kind": "expression",
"type": "() => void"
}
},
{
"name": "show-icon",
"description": "Whether to show icon",
"default": "false, in banner mode default is true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "role",
"description": "https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#aria-role-attribute",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "AlertClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "AlertStylesType"
}
},
{
"name": "banner",
"description": "Whether to show as banner",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "Custom icon, effective when showIcon is true",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "close-icon",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "action",
"description": "The action of Alert",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "id",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": [
{
"name": "close",
"description": "(ZH) Callback when close Alert\n\n(EN) Callback when close Alert",
"arguments": [
{
"name": "payload",
"type": "(e: any) => any"
}
]
},
{
"name": "mouseenter",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: any) => any"
}
]
},
{
"name": "mouseleave",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: any) => any"
}
]
},
{
"name": "click",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: any) => any"
}
]
}
]
},
"slots": [
{
"name": "message",
"description": "(ZH) 警告提示内容，请使用 title 替换\n\n(EN) Content of Alert, please use title instead"
},
{
"name": "title",
"description": "(ZH) 警告提示内容\n\n(EN) Content of Alert"
},
{
"name": "description",
"description": "(ZH) 警告提示的辅助性文字介绍\n\n(EN) Additional content of Alert"
},
{
"name": "icon",
"description": "(ZH) 自定义图标，showIcon 为 true 时有效\n\n(EN) Custom icon, effective when showIcon is true"
},
{
"name": "closeIcon",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "action",
"description": "(ZH) 自定义操作项\n\n(EN) The action of Alert"
}
]
},
{
"name": "a-anchor",
"description": "(ZH) 用于跳转到页面指定位置。\n\n(EN) Hyperlinks to scroll on one page.",
"attributes": [
{
"name": "affix",
"description": "Fixed mode of Anchor",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | Omit"
}
},
{
"name": "bounds",
"description": "Bounding distance of anchor area",
"default": "5",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "get-container",
"description": "Scrolling container",
"default": "() => window",
"value": {
"kind": "expression",
"type": "() => HTMLElement"
}
},
{
"name": "get-current-anchor",
"description": "Customize the anchor highlight",
"value": {
"kind": "expression",
"type": "(activeLink: string) => string"
}
},
{
"name": "offset-top",
"description": "Pixels to offset from top when calculating position of scroll",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "show-ink-in-fixed",
"description": "Whether show ink-square when affix={false}",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "target-offset",
"description": "Anchor scroll offset, default as offsetTop, example",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "items",
"description": "Data configuration option content, support nesting through children",
"value": {
"kind": "expression",
"type": "{ key, href, title, target, children }\\[] see"
}
},
{
"name": "direction",
"description": "Set Anchor direction",
"default": "vertical",
"value": {
"kind": "expression",
"type": "vertical | horizontal"
}
},
{
"name": "replace",
"description": "Replace items' href in browser history instead of pushing it",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) click 事件的 handler\n\n(EN) Set the handler to handle click event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent, link: { title: VueNode, href: string }) => void"
}
]
},
{
"name": "change",
"description": "(ZH) 监听锚点链接改变\n\n(EN) Listening for anchor link change",
"arguments": [
{
"name": "payload",
"type": "(currentActiveLink: string) => void"
}
]
}
]
},
"slots": [
{
"name": "item",
"description": "(ZH) 自定义锚点项的渲染\n\n(EN) Customize anchor item rendering"
}
]
},
{
"name": "a-avatar",
"description": "(ZH) 用来代表用户或事物，支持图片、图标或字符展示。\n\n(EN) Used to represent users or things, supporting the display of images, icons, or characters.",
"attributes": [
{
"name": "shape",
"description": "The shape of avatar",
"default": "circle",
"value": {
"kind": "expression",
"type": "circle | square"
}
},
{
"name": "size",
"description": "The size of the avatar",
"default": "medium",
"value": {
"kind": "expression",
"type": "number | large | medium | small | { xs: number, sm: number, ... }"
}
},
{
"name": "gap",
"description": "Letter type unit distance between left and right sides",
"default": "4",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "src",
"description": "The address of the image for an image avatar or image element",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "src-set",
"description": "A list of sources to use for different screen resolutions",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "draggable",
"description": "Whether the picture is allowed to be dragged",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | 'true' | 'false'"
}
},
{
"name": "icon",
"description": "Custom icon type for an icon avatar",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "alt",
"description": "This attribute defines the alternative text describing the image",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "cross-origin",
"description": "CORS settings attributes",
"value": {
"kind": "expression",
"type": "'' | 'anonymous' | 'use-credentials'"
}
},
{
"name": "on-error",
"description": "Handler when img load error, return false to prevent default fallback behavior",
"value": {
"kind": "expression",
"type": "() => boolean"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "icon",
"description": "(ZH) 设置头像的自定义图标\n\n(EN) Custom icon type for an icon avatar"
},
{
"name": "src",
"description": "(ZH) 图片类头像的资源地址或者图片元素\n\n(EN) The address of the image for an image avatar or image element"
}
]
},
{
"name": "a-avatar-group",
"description": "(ZH) 用来代表用户或事物，支持图片、图标或字符展示。\n\n(EN) Used to represent users or things, supporting the display of images, icons, or characters.",
"attributes": [
{
"name": "prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "max",
"description": "-",
"value": {
"kind": "expression",
"type": "{ count?: number style?: CSSProperties popover?: PopoverProps }"
}
},
{
"name": "size",
"description": "The size of the avatar",
"default": "default",
"value": {
"kind": "expression",
"type": "AvatarSize"
}
},
{
"name": "shape",
"description": "The shape of avatar",
"default": "circle",
"value": {
"kind": "expression",
"type": "'circle' | 'square'"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-auto-complete",
"description": "(ZH) 输入框自动完成功能。\n\n(EN) Autocomplete function of input field.",
"attributes": [
{
"name": "allow-clear",
"description": "Show clear button",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { clearIcon?: VueNode }"
}
},
{
"name": "backfill",
"description": "If backfill selected item the input when using keyboard",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "default-active-first-option",
"description": "Whether active first option by default",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Whether disabled select",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "get-popup-container",
"description": "Parent node of the dropdown. Default to body, if you encountered positioning problems during scroll, try changing to the scrollable area and position relative to it",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "label-render",
"description": "Customize selected label render",
"value": {
"kind": "expression",
"type": "(props: LabelInValueType) => VueNode"
}
},
{
"name": "not-found-content",
"description": "Specify content to show when no result matches",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "open",
"description": "Controlled open state of dropdown",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "options",
"description": "Select options. Will get better perf than jsx definition",
"value": {
"kind": "expression",
"type": "{ label: VueNode; value: string }[]"
}
},
{
"name": "option-render",
"description": "Customize the rendering dropdown options",
"value": {
"kind": "expression",
"type": "(option: FlattenOptionData, info: { index: number }) => VueNode"
}
},
{
"name": "placeholder",
"description": "The placeholder of input",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "popup-match-select-width",
"description": "Determine whether the dropdown menu and the select input are the same width. Default set min-width same as input. Will ignore when value less than select width. false will disable virtual scroll",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | number"
}
},
{
"name": "popup-render",
"description": "Customize dropdown content",
"value": {
"kind": "expression",
"type": "(menu: VueNode) => VueNode"
}
},
{
"name": "show-search",
"description": "Search configuration",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | SearchConfig"
}
},
{
"name": "size",
"description": "The size of the input box",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "error | warning"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "value",
"description": "Selected option, support v-model:value",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "variant",
"description": "Variants of input",
"default": "outlined",
"value": {
"kind": "expression",
"type": "outlined | borderless | filled | underlined"
}
},
{
"name": "virtual",
"description": "Disable virtual scroll when set to false",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "blur",
"description": "(ZH) 失去焦点时的回调\n\n(EN) Called when blur",
"arguments": [
{
"name": "payload",
"type": "(e: FocusEvent) => void"
}
]
},
{
"name": "change",
"description": "(ZH) 选中 option，或 input 的 value 变化时，调用此函数\n\n(EN) Called when selecting an option or changing input value",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
},
{
"name": "clear",
"description": "(ZH) 清除内容时的回调\n\n(EN) Called when clear",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "focus",
"description": "(ZH) 获得焦点时的回调\n\n(EN) Called when focus",
"arguments": [
{
"name": "payload",
"type": "(e: FocusEvent) => void"
}
]
},
{
"name": "inputKeydown",
"description": "(ZH) 按键按下时回调\n\n(EN) Called when key pressed",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) 展开下拉菜单的回调\n\n(EN) Called when dropdown open",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "popupScroll",
"description": "(ZH) 下拉列表滚动时的回调\n\n(EN) Called when dropdown scrolls",
"arguments": [
{
"name": "payload",
"type": "(e: UIEvent) => void"
}
]
},
{
"name": "search",
"description": "(ZH) 搜索补全项的时候调用\n\n(EN) Called when searching items",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
},
{
"name": "select",
"description": "(ZH) 被选中时调用，参数为选中项的 value 值\n\n(EN) Called when an option is selected, the params are option's value (or key) and option instance",
"arguments": [
{
"name": "payload",
"type": "(value: string, option: Option) => void"
}
]
}
]
},
"slots": [
{
"name": "default",
"description": "(ZH) 自定义输入组件，或传入 AutoComplete.Option 子节点\n\n(EN) Customize input element, or provide AutoComplete.Option children"
},
{
"name": "labelRender",
"description": "(ZH) 自定义当前选中的 label 内容 render\n\n(EN) Customize selected label render"
},
{
"name": "notFoundContent",
"description": "(ZH) 当下拉列表为空时显示的内容\n\n(EN) Specify content to show when no result matches"
},
{
"name": "optionRender",
"description": "(ZH) 自定义下拉选项渲染\n\n(EN) Customize the rendering dropdown options"
},
{
"name": "popupRender",
"description": "(ZH) 自定义下拉框内容\n\n(EN) Customize dropdown content"
},
{
"name": "prefix",
"description": "(ZH) 自定义前缀\n\n(EN) The custom prefix"
},
{
"name": "suffixIcon",
"description": "(ZH) 自定义后缀图标\n\n(EN) The custom suffix icon"
}
]
},
{
"name": "a-breadcrumb",
"description": "(ZH) 显示当前页面在系统层级结构中的位置，并能向上返回。\n\n(EN) Display the current location within a hierarchy. And allow going back to states higher up in the hierarchy.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "dropdown-icon",
"description": "Custom dropdown icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "item-render",
"description": "Custom item renderer, work with vue-router",
"value": {
"kind": "expression",
"type": "(route, params, routes, paths) => VueNode"
}
},
{
"name": "params",
"description": "Routing parameters",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "items",
"description": "The routing stack information of router",
"value": {
"kind": "expression",
"type": "[ItemType\\[\\]](#itemtype)"
}
},
{
"name": "separator",
"description": "Custom separator",
"default": "/",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
}
],
"js": {
"events": [
{
"name": "clickItem",
"description": "(ZH) 点击面包屑项目时触发\n\n(EN) Triggered when clicking a breadcrumb item",
"arguments": [
{
"name": "payload",
"type": "(item: ItemType, event: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "itemRender",
"description": "(ZH) 自定义链接函数，和 vue-router 配置使用\n\n(EN) Custom item renderer, work with vue-router"
},
{
"name": "titleRender",
"description": "(ZH) 自定义标题渲染\n\n(EN) Custom title renderer"
},
{
"name": "separator",
"description": "(ZH) 分隔符自定义\n\n(EN) Custom separator"
},
{
"name": "menuLabelRender",
"description": "(ZH) 自定义菜单标签渲染\n\n(EN) Custom menu label renderer"
},
{
"name": "menuExtraRender",
"description": "(ZH) 自定义菜单额外内容渲染\n\n(EN) Custom menu extra content renderer"
}
]
},
{
"name": "a-button",
"description": "(ZH) 按钮用于开始一个即时操作。\n\n(EN) To trigger an operation.",
"attributes": [
{
"name": "auto-insert-space",
"description": "We add a space between two Chinese characters by default. Set autoInsertSpace to false to disable.",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "block",
"description": "Option to fit button width to its parent width",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "color",
"description": "Set button color",
"value": {
"kind": "expression",
"type": "default | primary | danger | PresetColors"
}
},
{
"name": "danger",
"description": "Syntactic sugar. Set the danger status of button. Will follow color if provided",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disabled state of button",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "ghost",
"description": "Make background transparent and invert text and border colors",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "href",
"description": "Redirect url of link button",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "html-type",
"description": "Set the original html type of button, see: HTML Standard",
"default": "button",
"value": {
"kind": "expression",
"type": "submit | reset | button"
}
},
{
"name": "icon-placement",
"description": "Set the icon position of button",
"default": "start",
"value": {
"kind": "expression",
"type": "start | end"
}
},
{
"name": "loading",
"description": "Set the loading status of button",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { delay: number, icon: VueNode }"
}
},
{
"name": "shape",
"description": "Can be used to set button shape",
"default": "default",
"value": {
"kind": "expression",
"type": "default | circle | round"
}
},
{
"name": "size",
"description": "Set the size of button",
"default": "middle",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "target",
"description": "Same as target attribute of a, works when href is specified",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "type",
"description": "Syntactic sugar. Set button type. Will follow variant & color if provided",
"default": "default",
"value": {
"kind": "expression",
"type": "primary | dashed | link | text | default"
}
},
{
"name": "variant",
"description": "Set button variant",
"value": {
"kind": "expression",
"type": "outlined | dashed | solid | filled | text | link"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击按钮时的回调\n\n(EN) Callback executed when button is clicked",
"arguments": [
{
"name": "payload",
"type": "(event: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "icon",
"description": "(ZH) 设置按钮的图标组件\n\n(EN) Set the icon component of button"
},
{
"name": "loadingIcon",
"description": "(ZH) 设置按钮载入的图标组件\n\n(EN) Set the loading icon component of button"
}
]
},
{
"name": "a-calendar",
"description": "(ZH) 按照日历形式展示数据的容器。\n\n(EN) A container that displays data in calendar form.",
"attributes": [
{
"name": "prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "root-class",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CalendarClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CalendarStylesType"
}
},
{
"name": "locale",
"description": "The calendar's locale",
"default": "(default)",
"value": {
"kind": "expression",
"type": "typeof enUS"
}
},
{
"name": "valid-range",
"description": "To set valid range",
"value": {
"kind": "expression",
"type": "[DateType, DateType]"
}
},
{
"name": "disabled-date",
"description": "Function that specifies the dates that cannot be selected, currentDate is same dayjs object as value prop which you shouldn't mutate it",
"value": {
"kind": "expression",
"type": "(date: DateType) => boolean"
}
},
{
"name": "date-full-cell-render",
"description": "Customize the display of the date cell, the returned content will override the cell",
"value": {
"kind": "expression",
"type": "(date: DateType) => VueNode"
}
},
{
"name": "date-cell-render",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "(date: DateType) => VueNode"
}
},
{
"name": "month-full-cell-render",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "(date: DateType) => VueNode"
}
},
{
"name": "month-cell-render",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "(date: DateType) => VueNode"
}
},
{
"name": "cell-render",
"description": "Customize cell content",
"value": {
"kind": "expression",
"type": "(date: DateType, info: any) => VueNode"
}
},
{
"name": "full-cell-render",
"description": "Customize cell content",
"value": {
"kind": "expression",
"type": "(date: DateType, info: any) => VueNode"
}
},
{
"name": "header-render",
"description": "Render custom header in panel",
"value": {
"kind": "expression",
"type": "HeaderRender"
}
},
{
"name": "value",
"description": "The current selected date, support v-model:value",
"value": {
"kind": "expression",
"type": "DateType"
}
},
{
"name": "default-value",
"description": "The date selected by default",
"value": {
"kind": "expression",
"type": "DateType"
}
},
{
"name": "mode",
"description": "The display mode of the calendar",
"default": "month",
"value": {
"kind": "expression",
"type": "CalendarMode"
}
},
{
"name": "fullscreen",
"description": "Whether to display in full-screen",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "show-week",
"description": "Whether to display week number",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 日期变化回调\n\n(EN) Callback for when date changes",
"arguments": [
{
"name": "payload",
"type": "(date: DateType) => void"
}
]
},
{
"name": "update:value",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(date: DateType) => void"
}
]
},
{
"name": "panelChange",
"description": "(ZH) 日期面板变化回调\n\n(EN) Callback for when panel changes",
"arguments": [
{
"name": "payload",
"type": "(date: DateType, mode: CalendarMode) => void"
}
]
},
{
"name": "select",
"description": "(ZH) 选择日期回调，包含来源信息\n\n(EN) Callback for when a date is selected, include source info",
"arguments": [
{
"name": "payload",
"type": "(date: DateType, selectInfo: SelectInfo) => void"
}
]
}
]
},
"slots": [
{
"name": "dateFullCellRender",
"description": "(ZH) 自定义渲染日期单元格，返回内容覆盖单元格，>= 5.4.0 请用 fullCellRender\n\n(EN) Customize the display of the date cell, the returned content will override the cell"
},
{
"name": "dateCellRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "monthFullCellRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "monthCellRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "cellRender",
"description": "(ZH) 自定义单元格的内容\n\n(EN) Customize cell content"
},
{
"name": "fullCellRender",
"description": "(ZH) 自定义单元格的内容\n\n(EN) Customize cell content"
},
{
"name": "headerRender",
"description": "(ZH) 自定义头部内容\n\n(EN) Render custom header in panel"
}
]
},
{
"name": "a-card",
"description": "(ZH) 通用卡片容器。\n\n(EN) A container for displaying information.",
"attributes": [
{
"name": "title",
"description": "Card title",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "extra",
"description": "Content to render in the top-right corner of the card",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "bordered",
"description": "Toggles rendering of the border around the card, please use variant instead",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "head-style",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "body-style",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "loading",
"description": "Shows a loading indicator while the contents of the card are being fetched",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "hoverable",
"description": "Lift up when hovering card",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "id",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "size",
"description": "Size of card",
"default": "default",
"value": {
"kind": "expression",
"type": "CardSize"
}
},
{
"name": "type",
"description": "Card style type, can be set to inner or not set",
"value": {
"kind": "expression",
"type": "CardType"
}
},
{
"name": "cover",
"description": "Card cover",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "actions",
"description": "The action list, shows at the bottom of the Card",
"value": {
"kind": "expression",
"type": "VueNode[]"
}
},
{
"name": "tab-list",
"description": "List of TabPane's head",
"value": {
"kind": "expression",
"type": "CardTabListType[]"
}
},
{
"name": "tab-bar-extra-content",
"description": "Extra content in tab bar",
"value": {
"kind": "expression",
"type": "VueNode | { [key: string]: VueNode }"
}
},
{
"name": "active-tab-key",
"description": "Current TabPane's key",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "default-active-tab-key",
"description": "Initial active TabPane's key, if activeTabKey is not set",
"default": "The key of first tab",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "tab-props",
"description": "Tabs",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CardClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CardStylesType"
}
},
{
"name": "variant",
"description": "Variants of Card",
"default": "outlined",
"value": {
"kind": "expression",
"type": "'borderless' | 'outlined'"
}
}
],
"js": {
"events": [
{
"name": "tabChange",
"description": "(ZH) 页签切换的回调\n\n(EN) Callback when tab is switched",
"arguments": [
{
"name": "payload",
"type": "(key: string) => void"
}
]
},
{
"name": "update:activeTabKey",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(key: string) => void"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 卡片标题\n\n(EN) Card title"
},
{
"name": "extra",
"description": "(ZH) 卡片右上角的操作区域\n\n(EN) Content to render in the top-right corner of the card"
},
{
"name": "cover",
"description": "(ZH) 卡片封面\n\n(EN) Card cover"
},
{
"name": "actions",
"description": "(ZH) 卡片操作组，位置在卡片底部\n\n(EN) The action list, shows at the bottom of the Card"
},
{
"name": "tabContentRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "tabLabelRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "tabBarExtraContent",
"description": "(ZH) tab bar 上额外的元素\n\n(EN) Extra content in tab bar"
}
]
},
{
"name": "a-card-grid",
"description": "(ZH) 通用卡片容器。\n\n(EN) A container for displaying information.",
"attributes": [
{
"name": "prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "hoverable",
"description": "Lift up when hovering card",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-card-meta",
"description": "(ZH) 通用卡片容器。\n\n(EN) A container for displaying information.",
"attributes": [
{
"name": "prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "avatar",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title",
"description": "Card title",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "description",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CardMetaClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CardMetaStylesType"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "avatar",
"description": "(ZH) 头像\n\n(EN) Avatar"
},
{
"name": "title",
"description": "(ZH) 标题\n\n(EN) Title"
},
{
"name": "description",
"description": "(ZH) 描述\n\n(EN) Description"
}
]
},
{
"name": "a-badge",
"description": "(ZH) 图标右上角的圆形徽标数字。\n\n(EN) Small numerical value or status descriptor for UI elements.",
"attributes": [
{
"name": "count",
"description": "Number to show in badge",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "show-zero",
"description": "Whether to show badge when count is zero",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "overflow-count",
"description": "Max count to show",
"default": "99",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "dot",
"description": "Whether to display a red dot instead of count",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "scroll-number-prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "status",
"description": "Set Badge as a status dot",
"value": {
"kind": "expression",
"type": "PresetStatusColorType"
}
},
{
"name": "color",
"description": "Customize Badge dot color",
"value": {
"kind": "expression",
"type": "LiteralUnion"
}
},
{
"name": "text",
"description": "If status is set, text sets the display text of the status dot",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "size",
"description": "If count is set, size sets the size of badge",
"value": {
"kind": "expression",
"type": "'default' | 'small'"
}
},
{
"name": "offset",
"description": "Set offset of the badge dot",
"value": {
"kind": "expression",
"type": "[number | string, number | string]"
}
},
{
"name": "title",
"description": "Text to show when hovering over the badge",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "BadgeClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "BadgeStylesType"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "count",
"description": "(ZH) 展示的数字，大于 overflowCount 时显示为 ${overflowCount}+，为 0 时隐藏\n\n(EN) Number to show in badge"
},
{
"name": "text",
"description": "(ZH) 在设置了 status 的前提下有效，设置状态点的文本\n\n(EN) If status is set, text sets the display text of the status dot"
}
]
},
{
"name": "a-carousel",
"description": "(ZH) 一组轮播的区域。\n\n(EN) A set of carousel areas.",
"attributes": [
{
"name": "effect",
"description": "Transition effect",
"default": "scrollx",
"value": {
"kind": "expression",
"type": "CarouselEffect"
}
},
{
"name": "id",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "slick-go-to",
"description": "-",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "dot-position",
"description": "The position of the dots, which can be one of top bottom left right start end, Please use dotPlacement instead",
"default": "bottom",
"value": {
"kind": "expression",
"type": "DotPlacement | 'left' | 'right'"
}
},
{
"name": "dot-placement",
"description": "The position of the dots, which can be one of top bottom start end",
"default": "bottom",
"value": {
"kind": "expression",
"type": "DotPlacement"
}
},
{
"name": "dots",
"description": "Whether to show the dots at the bottom of the gallery, object for dotsClass",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | { class?: string }"
}
},
{
"name": "wait-for-animate",
"description": "Whether to wait for the animation when switching",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "autoplay",
"description": "Whether to scroll automatically, you can specify autoplay={{ dotDuration: true }} to display the progress bar",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { dotDuration?: boolean }"
}
},
{
"name": "prev-arrow",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "next-arrow",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": [
{
"name": "init",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "reInit",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "edge",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "swipe",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "lazyLoad",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "lazyLoadError",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
}
]
},
"slots": [
{
"name": "prevArrow",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "nextArrow",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-app",
"description": "(ZH) 提供重置样式和提供消费上下文的默认环境。\n\n(EN) Application wrapper for some global usages.",
"attributes": [
{
"name": "message",
"description": "Global config for Message",
"value": {
"kind": "expression",
"type": "MessageConfig"
}
},
{
"name": "notification",
"description": "Global config for Notification",
"value": {
"kind": "expression",
"type": "NotificationConfig"
}
},
{
"name": "component",
"description": "Config render element, iffalse will not create DOM node",
"default": "div",
"value": {
"kind": "expression",
"type": "any"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-cascader",
"description": "(ZH) 级联选择框。\n\n(EN) Cascade selection box.",
"attributes": [
{
"name": "allow-clear",
"description": "Show clear button",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | \\{ clearIcon?: VueNode \\}"
}
},
{
"name": "change-on-select",
"description": "Change value on each selection if set to true (always works when multiple is true)",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "disabled",
"description": "Whether disabled select",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "expand-trigger",
"description": "expand current item when click or hover, one of click hover",
"default": "click",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "field-names",
"description": "Custom field name for label and value and children",
"default": "\\{ label: label, value: value, children: children \\}",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "get-popup-container",
"description": "Parent Node which the selector should be rendered to. Default to body. When position issues happen, try to modify it into scrollable content and position it relative. example",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "function(triggerNode)"
}
},
{
"name": "load-data",
"description": "To load option lazily, and it cannot work with showSearch",
"value": {
"kind": "expression",
"type": "(selectedOptions) => void"
}
},
{
"name": "max-tag-count",
"description": "Max tag count to show. responsive will cost render performance",
"value": {
"kind": "expression",
"type": "number | responsive"
}
},
{
"name": "max-tag-placeholder",
"description": "Placeholder for not showing tags",
"value": {
"kind": "expression",
"type": "VueNode | function(omittedValues)"
}
},
{
"name": "max-tag-text-length",
"description": "Max tag text length to show",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "multiple",
"description": "Support multiple or not",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "open",
"description": "Set visible of cascader popup",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "options",
"description": "The data options of cascade",
"value": {
"kind": "expression",
"type": "Option\\[]"
}
},
{
"name": "placeholder",
"description": "The input placeholder",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "placement",
"description": "Use preset popup align config from builtinPlacements",
"default": "bottomLeft",
"value": {
"kind": "expression",
"type": "bottomLeft bottomRight topLeft topRight"
}
},
{
"name": "popup-menu-column-style",
"description": "The style of the drop-down menu column",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "show-checked-strategy",
"description": "The way to show selected items in the box (only effective when multiple is true). Cascader.SHOW_CHILD: just show child treeNode. Cascader.SHOW_PARENT: just show parent treeNode (when all child treeNode under the parent treeNode are checked)",
"default": "Cascader.SHOW_PARENT",
"value": {
"kind": "expression",
"type": "Cascader.SHOW_PARENT | Cascader.SHOW_CHILD"
}
},
{
"name": "show-search",
"description": "Whether show search input in single mode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | Object"
}
},
{
"name": "~~search-value~~",
"description": "Set search value, Need work with showSearch",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "size",
"description": "The input size",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "'error' | 'warning'"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "value",
"description": "The selected value, support v-model:value",
"value": {
"kind": "expression",
"type": "string\\[] | number\\[]"
}
},
{
"name": "variant",
"description": "Variants of selector",
"default": "outlined",
"value": {
"kind": "expression",
"type": "outlined | borderless | filled | underlined"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 选择完成后的回调\n\n(EN) Callback when finishing cascader select",
"arguments": [
{
"name": "payload",
"type": "(value, selectedOptions) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) 显示/隐藏浮层的回调\n\n(EN) Callback when popup shown or hidden",
"arguments": [
{
"name": "payload",
"type": "(value) => void"
}
]
}
]
},
"slots": [
{
"name": "displayRender",
"description": "(ZH) 选择后展示的渲染函数\n\n(EN) The render function of displaying selected options"
},
{
"name": "expandIcon",
"description": "(ZH) 自定义次级菜单展开图标\n\n(EN) Customize the current item expand icon"
},
{
"name": "loadingIcon",
"description": "(ZH) 延迟加载的外观（现已无用）\n\n(EN) The appearance of lazy loading (now is useless)"
},
{
"name": "notFoundContent",
"description": "(ZH) 当下拉列表为空时显示的内容\n\n(EN) Specify content to show when no result matches"
},
{
"name": "optionRender",
"description": "(ZH) 自定义渲染下拉选项\n\n(EN) Customize the rendering dropdown options"
},
{
"name": "popupRender",
"description": "(ZH) 自定义下拉框内容\n\n(EN) Customize dropdown content"
},
{
"name": "prefix",
"description": "(ZH) 自定义前缀\n\n(EN) The custom prefix"
},
{
"name": "removeIcon",
"description": "(ZH) 自定义的多选框清除图标\n\n(EN) The custom remove icon"
},
{
"name": "suffixIcon",
"description": "(ZH) 自定义的选择框后缀图标\n\n(EN) The custom suffix icon"
},
{
"name": "tagRender",
"description": "(ZH) 自定义 tag 内容 render，仅在多选时生效\n\n(EN) Custom render function for tags in multiple mode"
}
]
},
{
"name": "a-collapse",
"description": "(ZH) 可以折叠/展开的内容区域。\n\n(EN) A content area which can be collapsed and expanded.",
"attributes": [
{
"name": "active-key",
"description": "Key of the active panel",
"default": "No default value. In accordion mode, it's the key of the first panel",
"value": {
"kind": "expression",
"type": "Array | string | number"
}
},
{
"name": "default-active-key",
"description": "Key of the initial active panel",
"value": {
"kind": "expression",
"type": "Array | string | number"
}
},
{
"name": "accordion",
"description": "If true, Collapse renders as Accordion",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "destroy-on-hidden",
"description": "Destroy Inactive Panel",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "bordered",
"description": "Toggles rendering of the border around the collapse block",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "expand-icon",
"description": "Allow to customize collapse icon",
"value": {
"kind": "expression",
"type": "(panelProps: PanelProps) => any"
}
},
{
"name": "expand-icon-placement",
"description": "Set expand icon placement",
"default": "start",
"value": {
"kind": "expression",
"type": "ExpandIconPlacement"
}
},
{
"name": "ghost",
"description": "Make the collapse borderless and its background transparent",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "Set the size of collapse",
"default": "middle",
"value": {
"kind": "expression",
"type": "SizeType"
}
},
{
"name": "collapsible",
"description": "Specify how to trigger Collapse. Either by clicking icon or by clicking any area in header or disable collapse functionality itself",
"value": {
"kind": "expression",
"type": "CollapsibleType"
}
},
{
"name": "label-render",
"description": "Custom render label",
"value": {
"kind": "expression",
"type": "(params: { item: CollapseItemType, index: number }) => any"
}
},
{
"name": "content-render",
"description": "Custom render content",
"value": {
"kind": "expression",
"type": "(params: { item: CollapseItemType, index: number }) => any"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CollapseClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "CollapseStylesType"
}
},
{
"name": "items",
"description": "Collapse items content",
"value": {
"kind": "expression",
"type": "CollapseItemType[]"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 切换面板的回调\n\n(EN) Callback function executed when active panel is changed",
"arguments": [
{
"name": "payload",
"type": "(key: string[]) => void"
}
]
}
]
},
"slots": [
{
"name": "expandIcon",
"description": "(ZH) 自定义切换图标\n\n(EN) Allow to customize collapse icon"
},
{
"name": "labelRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "contentRender",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-collapse-panel",
"description": "(ZH) 可以折叠/展开的内容区域。\n\n(EN) A content area which can be collapsed and expanded.",
"attributes": [
{
"name": "header",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "show-arrow",
"description": "-",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "extra",
"description": "-",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "collapsible",
"description": "Specify how to trigger Collapse. Either by clicking icon or by clicking any area in header or disable collapse functionality itself",
"value": {
"kind": "expression",
"type": "CollapsibleType"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "header",
"description": "面板标题"
},
{
"name": "extra",
"description": "自定义渲染每个面板右上角的内容"
}
]
},
{
"name": "a-config-provider",
"description": "(ZH) 为组件提供统一的全局化配置。\n\n(EN) Provide a uniform configuration support for components.",
"attributes": [
{
"name": "component-disabled",
"description": "Config antd component disabled",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "component-size",
"description": "Config antd component size",
"value": {
"kind": "expression",
"type": "small | middle | large"
}
},
{
"name": "csp",
"description": "Set Content Security Policy config",
"value": {
"kind": "expression",
"type": "CSPConfig"
}
},
{
"name": "direction",
"description": "Set direction of layout. See demo",
"default": "ltr",
"value": {
"kind": "expression",
"type": "ltr | rtl"
}
},
{
"name": "get-popup-container",
"description": "To set the container of the popup element. The default is to create a div element in body",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(trigger?: HTMLElement) => HTMLElement | ShadowRoot"
}
},
{
"name": "get-target-container",
"description": "Config Affix, Anchor scroll target container",
"default": "() => window",
"value": {
"kind": "expression",
"type": "() => HTMLElement | Window | ShadowRoot"
}
},
{
"name": "icon-prefix-cls",
"description": "Set icon prefix className",
"default": "anticon",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "locale",
"description": "Language package setting, you can find the packages in antd/locale",
"value": {
"kind": "expression",
"type": "Locale"
}
},
{
"name": "popup-match-select-width",
"description": "Determine whether the dropdown menu and the select input are the same width. Default set min-width same as input. Will ignore when value less than select width. false will disable virtual scroll",
"value": {
"kind": "expression",
"type": "boolean | number"
}
},
{
"name": "popup-overflow",
"description": "Select like component popup logic. Can set to show in viewport or follow window scroll",
"default": "viewport",
"value": {
"kind": "expression",
"type": "viewport | scroll"
}
},
{
"name": "prefix-cls",
"description": "Set prefix className",
"default": "ant",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "render-empty",
"description": "Set empty content of components. Ref Empty",
"value": {
"kind": "expression",
"type": "(componentName?: string) => VueNode"
}
},
{
"name": "theme",
"description": "Set theme, ref Customize Theme",
"value": {
"kind": "expression",
"type": "ThemeConfig"
}
},
{
"name": "variant",
"description": "Set variant of data entry components",
"value": {
"kind": "expression",
"type": "outlined | filled | borderless | underlined"
}
},
{
"name": "virtual",
"description": "Disable virtual scroll when set to false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "warning",
"description": "Config warning level, when strict is false, it will aggregate deprecated information into a single message",
"value": {
"kind": "expression",
"type": "WarningContextProps"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "renderEmpty",
"description": "(ZH) 自定义组件空状态。参考 空状态\n\n(EN) Set empty content of components. Ref Empty"
}
]
},
{
"name": "a-color-picker",
"description": "(ZH) 用于选择颜色。\n\n(EN) Used for color selection.",
"attributes": [
{
"name": "allow-clear",
"description": "Allow clearing color selected",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "arrow",
"description": "Configuration for popup arrow",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | { pointAtCenter: boolean }"
}
},
{
"name": "auto-adjust-overflow",
"description": "Auto adjust placement when popup is invisible",
"value": {
"kind": "expression",
"type": "boolean | AdjustOverflow"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ColorPickerClassNamesType"
}
},
{
"name": "default-format",
"description": "Default format of color",
"default": "hex",
"value": {
"kind": "expression",
"type": "ColorFormatType"
}
},
{
"name": "default-value",
"description": "Default value of color",
"value": {
"kind": "expression",
"type": "ColorValueType"
}
},
{
"name": "destroy-on-hidden",
"description": "Whether destroy dom when close",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disable ColorPicker",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled-alpha",
"description": "Disable Alpha",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled-format",
"description": "Disable format of color",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "format",
"description": "Format of color, support v-model:format",
"value": {
"kind": "expression",
"type": "ColorFormatType"
}
},
{
"name": "get-popup-container",
"description": "Specify container for popup",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "mode",
"description": "Configure single or gradient color",
"default": "single",
"value": {
"kind": "expression",
"type": "ModeType | ModeType[]"
}
},
{
"name": "open",
"description": "Whether to show popup, support v-model:open",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "placement",
"description": "Placement of popup",
"default": "bottomLeft",
"value": {
"kind": "expression",
"type": "TriggerPlacement"
}
},
{
"name": "presets",
"description": "Preset colors",
"value": {
"kind": "expression",
"type": "PresetsItem[]"
}
},
{
"name": "panel-render",
"description": "Custom Render Panel",
"value": {
"kind": "expression",
"type": "(params: { panel: any, extra: { components: { Picker: any, Presets: any } } }) => any"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "show-text",
"description": "Show color text",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | ((params: { color: Color }) => any)"
}
},
{
"name": "size",
"description": "Setting the trigger size",
"default": "middle",
"value": {
"kind": "expression",
"type": "SizeType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ColorPickerStylesType"
}
},
{
"name": "trigger",
"description": "ColorPicker trigger mode",
"default": "click",
"value": {
"kind": "expression",
"type": "TriggerType"
}
},
{
"name": "value-format",
"description": "Set the output format of color value, supporting hex, rgb, and hsb. After setting, v-model:value returns strings in the selected format. Demo: Value Format",
"value": {
"kind": "expression",
"type": "ColorFormatType"
}
},
{
"name": "value",
"description": "Value of color, support v-model:value",
"value": {
"kind": "expression",
"type": "ColorValueType"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 颜色变化的回调\n\n(EN) Callback when value is changed",
"arguments": [
{
"name": "payload",
"type": "(value: Color, css: string) => void"
}
]
},
{
"name": "clear",
"description": "(ZH) 清除的回调\n\n(EN) Called when clear",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "changeComplete",
"description": "(ZH) 颜色选择完成的回调\n\n(EN) Called when color pick ends",
"arguments": [
{
"name": "payload",
"type": "(value: Color) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) 当 open 被改变时的回调\n\n(EN) Callback when open is changed",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "formatChange",
"description": "(ZH) 颜色格式变化的回调\n\n(EN) Callback when format is changed",
"arguments": [
{
"name": "payload",
"type": "(format?: ColorFormatType) => void"
}
]
}
]
},
"slots": [
{
"name": "default",
"description": "(ZH) 触发器内容\n\n(EN) Trigger content"
},
{
"name": "panelRender",
"description": "(ZH) 自定义渲染面板\n\n(EN) Custom Render Panel"
},
{
"name": "showText",
"description": "(ZH) 自定义文字渲染\n\n(EN) Custom text rendering"
}
]
},
{
"name": "a-checkbox",
"description": "(ZH) 收集用户的多项选择。\n\n(EN) Collect user's choices.",
"attributes": [
{
"name": "checked",
"description": "Specifies whether the checkbox is selected, support v-model:checked",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "checked-value",
"description": "The value when checked",
"default": "true",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "default-checked",
"description": "Whether to set the initial state",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "disabled",
"description": "If disable checkbox",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "indeterminate",
"description": "The indeterminate checked state of checkbox",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "un-checked-value",
"description": "The value when unchecked",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 变化时的回调函数\n\n(EN) The callback function that is triggered when the state changes",
"arguments": [
{
"name": "payload",
"type": "(e: CheckboxChangeEvent) => void"
}
]
},
{
"name": "focus",
"description": "(ZH) 获得焦点时的回调\n\n(EN) Called when entering the component",
"arguments": [
{
"name": "payload",
"type": "function()"
}
]
},
{
"name": "blur",
"description": "(ZH) 失去焦点时的回调\n\n(EN) Called when leaving the component",
"arguments": [
{
"name": "payload",
"type": "function()"
}
]
}
]
},
"slots": []
},
{
"name": "a-checkbox-group",
"description": "(ZH) 收集用户的多项选择。\n\n(EN) Collect user's choices.",
"attributes": [
{
"name": "options",
"description": "Specifies options",
"default": "\\[]",
"value": {
"kind": "expression",
"type": "string\\[] | number\\[] | Option\\[]"
}
},
{
"name": "disabled",
"description": "If disable all checkboxes",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "name",
"description": "The name property of all input[type=\"checkbox\"] children",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "value",
"description": "Used for setting the currently selected value, support v-model:value",
"default": "\\[]",
"value": {
"kind": "expression",
"type": "(string | number | boolean)\\[]"
}
},
{
"name": "label-render",
"description": "-",
"value": {
"kind": "expression",
"type": "(params: { item: CheckboxOptionType, index: number }) => any"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 变化时的回调函数\n\n(EN) The callback function that is triggered when the state changes",
"arguments": [
{
"name": "payload",
"type": "(checkedValue: T[]) => void"
}
]
}
]
},
"slots": [
{
"name": "labelRender",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-localization",
"description": "To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-common-api",
"description": "To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-common-methods",
"description": "To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-date-picker",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-date-picker[picker=year]",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-date-picker[picker=quarter]",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-date-picker[picker=month]",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-date-picker[picker=week]",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-range-picker",
"description": "(ZH) 输入或选择日期的控件。\n\n(EN) To select or input a date.",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 时间发生变化的回调\n\n(EN) Callback function, can be executed when the selected time is changing",
"arguments": [
{
"name": "payload",
"type": "(date: Dayjs | Dayjs[] | null, dateString: string | string[] | null) => void"
}
]
},
{
"name": "update:value",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(date: Dayjs | Dayjs[] | null) => void"
}
]
},
{
"name": "calendarChange",
"description": "(ZH) 待选日期发生变化的回调。info 参数自 4.4.0 添加\n\n(EN) Callback function, can be executed when the start time or the end time of the range is changing. info argument is added in 4.4.0",
"arguments": [
{
"name": "payload",
"type": "(dates: [Dayjs, Dayjs], dateStrings: [string, string], info: { range: 'start' | 'end' }) => void"
}
]
},
{
"name": "panelChange",
"description": "(ZH) 日历面板切换的回调\n\n(EN) Callback when picker panel mode is changed",
"arguments": [
{
"name": "payload",
"type": "(value: Dayjs, mode: PickerMode) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) 弹出日历和关闭日历的回调\n\n(EN) Callback function, can be executed whether the popup calendar is popped up or closed",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "ok",
"description": "(ZH) 点击确定按钮的回调\n\n(EN) Callback when click ok button",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "select",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(date: Dayjs) => void"
}
]
},
{
"name": "focus",
"description": "(ZH) 聚焦时回调\n\n(EN) Trigger when get focus",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent, info: { range: 'start' | 'end' }) => void"
}
]
},
{
"name": "blur",
"description": "(ZH) 失焦时回调\n\n(EN) Trigger when lose focus",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent, info: { range: 'start' | 'end' }) => void"
}
]
},
{
"name": "keydown",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(event: KeyboardEvent, preventDefault: VoidFunction) => void"
}
]
}
]
},
"slots": [
{
"name": "suffixIcon",
"description": "(ZH) 自定义的选择框后缀图标\n\n(EN) The custom suffix icon"
},
{
"name": "renderExtraFooter",
"description": "(ZH) 在面板中添加额外的页脚\n\n(EN) Render extra footer in panel"
},
{
"name": "panelRender",
"description": "(ZH) 自定义渲染面板\n\n(EN) Customize panel render"
},
{
"name": "inputRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "cellRender",
"description": "(ZH) 自定义单元格的内容\n\n(EN) Custom rendering function for picker cells"
},
{
"name": "dateRender",
"description": "(ZH) 自定义日期单元格的内容，>= 5.4.0 起用 cellRender 代替\n\n(EN) Custom rendering function for date cells, >= 5.4.0 use cellRender instead."
},
{
"name": "monthCellRender",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-国际化配置",
"description": "输入或选择日期的控件。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-共同的-api",
"description": "输入或选择日期的控件。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-共同的方法",
"description": "输入或选择日期的控件。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-divider",
"description": "(ZH) 区隔内容的分割线。\n\n(EN) A divider line separates different content.",
"attributes": [
{
"name": "dashed",
"description": "Whether line is dashed",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "orientation",
"description": "Whether line is horizontal or vertical",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "plain",
"description": "Divider text show as plain style",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "The size of divider. Only valid for horizontal layout",
"value": {
"kind": "expression",
"type": "small | middle | large"
}
},
{
"name": "title-placement",
"description": "The position of title inside divider",
"default": "center",
"value": {
"kind": "expression",
"type": "start | end | center"
}
},
{
"name": "variant",
"description": "Whether line is dashed, dotted or solid",
"default": "solid",
"value": {
"kind": "expression",
"type": "dashed | dotted | solid"
}
},
{
"name": "vertical",
"description": "Orientation, Simultaneously configure with orientation and prioritize orientation",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-descriptions",
"description": "(ZH) 展示多个只读字段的组合。\n\n(EN) Display multiple read-only fields in a group.",
"attributes": [
{
"name": "bordered",
"description": "Whether to display the border",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "Set the size of the list. Can be set to middle,small, or not filled",
"value": {
"kind": "expression",
"type": "'middle' | 'small' | 'default'"
}
},
{
"name": "title",
"description": "The title of the description list, placed at the top",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "extra",
"description": "The action area of the description list, placed at the top-right",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "label-render",
"description": "-",
"value": {
"kind": "expression",
"type": "RenderDescriptionsItem"
}
},
{
"name": "content-render",
"description": "-",
"value": {
"kind": "expression",
"type": "RenderDescriptionsItem"
}
},
{
"name": "column",
"description": "The number of DescriptionItems in a row, could be a number or a responsive object like { xs: 8, sm: 16, md: 24}",
"default": "{xxxl: 4,xxl: 3,xl: 3,lg: 3,md: 3,sm: 2,xs: 1}",
"value": {
"kind": "expression",
"type": "number | Partial>"
}
},
{
"name": "layout",
"description": "Define description layout",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "'horizontal' | 'vertical'"
}
},
{
"name": "colon",
"description": "Change default props colon value of Descriptions.Item. Indicates whether the colon after the label is displayed",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "DescriptionsStylesType"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "DescriptionsClassNamesType"
}
},
{
"name": "items",
"description": "Describe the contents of the list item",
"value": {
"kind": "expression",
"type": "DescriptionsItemType[]"
}
},
{
"name": "id",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "title",
"description": "(ZH) 描述列表的标题，显示在最顶部\n\n(EN) The title of the description list, placed at the top"
},
{
"name": "extra",
"description": "(ZH) 描述列表的操作区域，显示在右上方\n\n(EN) The action area of the description list, placed at the top-right"
},
{
"name": "labelRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "contentRender",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-dropdown",
"description": "(ZH) 向下弹出的列表。\n\n(EN) A dropdown list.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the Dropdown component. Supports object or function",
"value": {
"kind": "expression",
"type": "DropdownClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the Dropdown component. Supports object or function",
"value": {
"kind": "expression",
"type": "DropdownStylesType"
}
},
{
"name": "menu",
"description": "The menu props",
"value": {
"kind": "expression",
"type": "MenuProps & { activeKey?: VcMenuProps['activeKey'], onClick?: MenuEmits['click'] }"
}
},
{
"name": "auto-focus",
"description": "Focus the first menu item when opened",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "arrow",
"description": "Whether the dropdown arrow should be visible. Supports pointAtCenter",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | DropdownArrowOptions"
}
},
{
"name": "trigger",
"description": "The trigger mode which executes the dropdown action. Note that hover can't be used on touchscreens",
"default": "['hover']",
"value": {
"kind": "expression",
"type": "('click' | 'hover' | 'contextmenu')[]"
}
},
{
"name": "popup-render",
"description": "Customize popup content",
"value": {
"kind": "expression",
"type": "(menu: VueNode) => VueNode"
}
},
{
"name": "open",
"description": "Whether the dropdown menu is currently open",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Whether the dropdown menu is disabled",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "destroy-on-hidden",
"description": "Whether destroy dropdown when hidden",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "align",
"description": "Popup align config",
"value": {
"kind": "expression",
"type": "AlignType"
}
},
{
"name": "get-popup-container",
"description": "To set the container of the dropdown menu. The default is to create a div element in body, but you can reset it to the scrolling area and make a relative reposition. Example on CodePen",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "prefix-cls",
"description": "Customize prefix class name",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "transition-name",
"description": "Motion name of dropdown",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "placement",
"description": "Placement of popup menu: bottom bottomLeft bottomRight top topLeft topRight",
"default": "bottomLeft",
"value": {
"kind": "expression",
"type": "Placement"
}
},
{
"name": "force-render",
"description": "Force render dropdown overlay",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mouse-enter-delay",
"description": "Delay in seconds before showing dropdown",
"default": "0.15",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "mouse-leave-delay",
"description": "Delay in seconds before hiding dropdown",
"default": "0.1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "open-class-name",
"description": "Class added to trigger when dropdown is open",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "auto-adjust-overflow",
"description": "Whether to adjust dropdown placement automatically when dropdown is off screen",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | AdjustOverflow"
}
}
],
"js": {
"events": [
{
"name": "openChange",
"description": "(ZH) 菜单显示状态改变时调用，点击菜单按钮导致的消失不会触发\n\n(EN) Called when the open state is changed. Not trigger when hidden by click item",
"arguments": [
{
"name": "payload",
"type": "(open: boolean, info: { source: 'trigger' | 'menu' }) => void"
}
]
},
{
"name": "menuClick",
"description": "(ZH) 点击菜单项的回调\n\n(EN) Callback when menu item clicked",
"arguments": [
{
"name": "payload",
"type": "MenuEmits['click']"
}
]
}
]
},
"slots": [
{
"name": "popupRender",
"description": "(ZH) 自定义弹出框内容\n\n(EN) Customize popup content"
},
{
"name": "labelRender",
"description": "(ZH) 自定义label内容\n\n(EN) Customize label content"
}
]
},
{
"name": "a-empty",
"description": "(ZH) 空状态时的展示占位图。\n\n(EN) Empty state placeholder.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "EmptyClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "EmptyStylesType"
}
},
{
"name": "image",
"description": "Customize image. Will treat as image url when string provided",
"default": "Empty.PRESENTED_IMAGE_DEFAULT",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "description",
"description": "Customize description",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "prefix-cls",
"description": "Prefix class name",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "image",
"description": "(ZH) 设置显示图片，为 string 时表示自定义图片地址。\n\n(EN) Customize image. Will treat as image url when string provided"
},
{
"name": "description",
"description": "(ZH) 自定义描述内容\n\n(EN) Customize description"
},
{
"name": "default",
"description": "(ZH) 底部操作区域内容\n\n(EN) Footer content"
}
]
},
{
"name": "a-flex",
"description": "用于对齐的弹性布局容器。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-drawer",
"description": "(ZH) 屏幕边缘滑出的浮层面板。\n\n(EN) A panel that slides out from the edge of the screen.",
"attributes": [
{
"name": "after-open-change",
"description": "Callback after the animation ends when switching drawers",
"value": {
"kind": "expression",
"type": "(open: boolean) => void"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the Drawer component. Supports object or function.",
"value": {
"kind": "expression",
"type": "DrawerClassNamesType"
}
},
{
"name": "closable",
"description": "Whether to show a close button. The position can be configured with placement",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | \\{ closeIcon?: VueNode, disabled?: boolean, placement?: 'start' | 'end' \\}"
}
},
{
"name": "close-icon",
"description": "Custom close icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "~~destroy-on-close~~",
"description": "Whether to unmount child components on closing drawer or not",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "destroy-on-hidden",
"description": "Whether to unmount child components on closing drawer or not",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "extra",
"description": "Extra actions area at corner",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "footer",
"description": "The footer for Drawer",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "force-render",
"description": "Pre-render Drawer component forcibly",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "get-container",
"description": "Mounted node and display window for Drawer",
"default": "document.body",
"value": {
"kind": "expression",
"type": "string | HTMLElement | (() => HTMLElement) | false"
}
},
{
"name": "keyboard",
"description": "Whether support press esc to close",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "loading",
"description": "Show the Skeleton",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mask",
"description": "Mask effect",
"default": "true",
"value": {
"kind": "expression",
"type": "MaskType"
}
},
{
"name": "mask-closable",
"description": "Clicking on the mask (area outside the Drawer) to close the Drawer or not",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "placement",
"description": "The placement of the Drawer",
"default": "right",
"value": {
"kind": "expression",
"type": "top | right | bottom | left"
}
},
{
"name": "push",
"description": "Nested drawers push behavior",
"default": "\\{ distance: 180 \\}",
"value": {
"kind": "expression",
"type": "boolean | \\{ distance: string | number \\}"
}
},
{
"name": "resizable",
"description": "Enable resizable by dragging",
"value": {
"kind": "expression",
"type": "boolean | ResizableConfig"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "root-style",
"description": "Style of wrapper element which contains mask",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "size",
"description": "Preset size of drawer, default 378px and large 736px, or a custom number",
"default": "'default'",
"value": {
"kind": "expression",
"type": "'default' | 'large' | number"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the Drawer component. Supports object or function.",
"value": {
"kind": "expression",
"type": "DrawerStylesType"
}
},
{
"name": "title",
"description": "The title for Drawer",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "open",
"description": "Whether the Drawer dialog is visible or not, support v-model:open",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "z-index",
"description": "The z-index of the Drawer",
"default": "1000",
"value": {
"kind": "expression",
"type": "number"
}
}
],
"js": {
"events": [
{
"name": "afterOpenChange",
"description": "(ZH) 切换抽屉时动画结束后的回调\n\n(EN) Callback after the animation ends when switching drawers",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "close",
"description": "(ZH) 抽屉关闭回调\n\n(EN) Callback when drawer is closed",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent | KeyboardEvent) => void"
}
]
},
{
"name": "keydown",
"description": "(ZH) 键盘按下回调\n\n(EN) Keyboard keydown event",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "keyup",
"description": "(ZH) 键盘抬起回调\n\n(EN) Keyboard keyup event",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "mouseenter",
"description": "(ZH) 鼠标移入回调\n\n(EN) Mouse enter event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseleave",
"description": "(ZH) 鼠标移出回调\n\n(EN) Mouse leave event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseover",
"description": "(ZH) 鼠标移入回调\n\n(EN) Mouse over event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "click",
"description": "(ZH) 点击回调\n\n(EN) Click event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 标题\n\n(EN) Title"
},
{
"name": "footer",
"description": "(ZH) 底部\n\n(EN) Footer"
},
{
"name": "extra",
"description": "(ZH) 右上角额外操作\n\n(EN) Extra actions"
},
{
"name": "closeIcon",
"description": "(ZH) 自定义关闭图标\n\n(EN) Custom close icon"
},
{
"name": "default",
"description": "(ZH) 抽屉内容\n\n(EN) Drawer content"
}
]
},
{
"name": "a-form",
"description": "(ZH) 高性能表单控件，自带数据域管理。包含数据录入、校验以及对应样式。\n\n(EN) High-performance form component with data domain management. Includes data entry, validation, and corresponding styles.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "FormClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "FormStylesType"
}
},
{
"name": "colon",
"description": "Configure the default value of colon for Form.Item. Indicates whether the colon after the label is displayed (only effective when prop layout is horizontal)",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "name",
"description": "Form name. Will be the prefix of Field id",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "layout",
"description": "Form layout",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "FormLayout"
}
},
{
"name": "label-align",
"description": "The text align of label of all items",
"default": "right",
"value": {
"kind": "expression",
"type": "FormLabelAlign"
}
},
{
"name": "label-wrap",
"description": "whether label can be wrap",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "label-col",
"description": "Label layout, like Col component. Set span offset value like {span: 3, offset: 12} or sm: {span: 3, offset: 12}",
"value": {
"kind": "expression",
"type": "ColProps"
}
},
{
"name": "wrapper-col",
"description": "The layout for input controls, same as labelCol",
"value": {
"kind": "expression",
"type": "ColProps"
}
},
{
"name": "feedback-icons",
"description": "Can be passed custom icons while Form.Item element has hasFeedback",
"value": {
"kind": "expression",
"type": "FeedbackIcons"
}
},
{
"name": "size",
"description": "Set field component size (antd components only)",
"value": {
"kind": "expression",
"type": "SizeType"
}
},
{
"name": "disabled",
"description": "Set form component disable, only available for antd components",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "scroll-to-first-error",
"description": "Auto scroll to first failed field when submit",
"default": "false",
"value": {
"kind": "expression",
"type": "ScrollFocusOptions | boolean"
}
},
{
"name": "required-mark",
"description": "Required mark style. Can use required mark or optional mark. You can not config to single Form.Item since this is a Form level config",
"default": "true",
"value": {
"kind": "expression",
"type": "RequiredMark"
}
},
{
"name": "variant",
"description": "Variant of components inside form",
"default": "outlined",
"value": {
"kind": "expression",
"type": "Variant"
}
},
{
"name": "validate-messages",
"description": "Validation prompt template, description see below",
"value": {
"kind": "expression",
"type": "ValidateMessages"
}
},
{
"name": "model",
"description": "Form model",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "rules",
"description": "Form rules",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "validate-trigger",
"description": "Config field validate trigger. When set to false, all interaction-driven validation is disabled even if a rule declares trigger or validateTrigger; validateFields and submit validation still run",
"default": "change",
"value": {
"kind": "expression",
"type": "string | string[] | false"
}
},
{
"name": "preserve",
"description": "Keep field value even when field removed. You can get the preserve field value by getFieldsValue(true)",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "clear-on-destroy",
"description": "Clear form values when the form is uninstalled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "validate-on-rule-change",
"description": "Automatically revalidates the form when Form.rules changes",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "prefix-cls",
"description": "Prefix class name",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": [
{
"name": "finish",
"description": "(ZH) 提交表单且数据验证成功后回调事件\n\n(EN) Trigger after submitting the form and verifying data successfully",
"arguments": [
{
"name": "payload",
"type": "(values: Record) => void"
}
]
},
{
"name": "finishFailed",
"description": "(ZH) 提交表单且数据验证失败后回调事件\n\n(EN) Trigger after submitting the form and verifying data failed",
"arguments": [
{
"name": "payload",
"type": "(errorInfo: ValidateErrorEntity) => void"
}
]
},
{
"name": "submit",
"description": "(ZH) 原生表单提交时触发，在内部校验开始前执行\n\n(EN) Triggered on native form submit before internal validation starts",
"arguments": [
{
"name": "payload",
"type": "(e: Event) => void"
}
]
},
{
"name": "reset",
"description": "(ZH) 原生表单重置时触发\n\n(EN) Triggered on native form reset",
"arguments": [
{
"name": "payload",
"type": "(e: Event) => void"
}
]
},
{
"name": "validate",
"description": "(ZH) 单个字段校验完成时触发，返回字段路径、是否通过以及错误信息\n\n(EN) Triggered when a single field finishes validation. Returns the field path, pass status, and error messages",
"arguments": [
{
"name": "payload",
"type": "(name: InternalNamePath, status: boolean, errors: any[] | null) => void"
}
]
},
{
"name": "valuesChange",
"description": "(ZH) 字段值更新时触发回调事件\n\n(EN) Trigger when value updated",
"arguments": [
{
"name": "payload",
"type": "(changedValues: Record, values: Record) => void"
}
]
},
{
"name": "fieldsChange",
"description": "(ZH) 字段更新时触发回调事件\n\n(EN) Trigger when field updated",
"arguments": [
{
"name": "payload",
"type": "(changedFields: FieldData[], allFields: FieldData[]) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-form-item",
"description": "(ZH) 高性能表单控件，自带数据域管理。包含数据录入、校验以及对应样式。\n\n(EN) High-performance form component with data domain management. Includes data entry, validation, and corresponding styles.",
"attributes": [
{
"name": "name",
"description": "Field name",
"value": {
"kind": "expression",
"type": "NamePath"
}
},
{
"name": "label",
"description": "Label text",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "label-align",
"description": "The text align of label",
"default": "right",
"value": {
"kind": "expression",
"type": "FormLabelAlign"
}
},
{
"name": "label-col",
"description": "The layout of label. If both Form and Form.Item exists, use Item first",
"value": {
"kind": "expression",
"type": "ColProps"
}
},
{
"name": "wrapper-col",
"description": "The layout for input controls, same as labelCol",
"value": {
"kind": "expression",
"type": "ColProps"
}
},
{
"name": "colon",
"description": "Used with label, whether to display : after label text",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "extra",
"description": "The extra prompt message",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "help",
"description": "The prompt message. If not provided, the prompt message will be generated by the validation rule",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "has-feedback",
"description": "Display validation status icon",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | \\{ icons: FeedbackIcons \\}"
}
},
{
"name": "validate-status",
"description": "The validation status",
"value": {
"kind": "expression",
"type": "ValidateStatus"
}
},
{
"name": "required",
"description": "Display required style. It will be generated by the validation rule",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "rules",
"description": "Rules for field validation",
"value": {
"kind": "expression",
"type": "Rule[]"
}
},
{
"name": "validate-trigger",
"description": "When to validate the value of children node. When set to false, all interaction-driven validation for the field is disabled even if a rule declares trigger or validateTrigger; explicit validateFields and submit validation still run",
"default": "change",
"value": {
"kind": "expression",
"type": "string | string[] | false"
}
},
{
"name": "validate-debounce",
"description": "Delay milliseconds to start validation",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "validate-first",
"description": "Whether stop validate on first rule of error for this field. Will parallel validate when parallel configured",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | parallel"
}
},
{
"name": "no-style",
"description": "No style for true, used as a pure field control",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "id",
"description": "Set sub label htmlFor",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "hidden",
"description": "Whether to hide Form.Item (still collect and validate value)",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "message-variables",
"description": "The default validate field info",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "tooltip",
"description": "Config tooltip info",
"value": {
"kind": "expression",
"type": "VueNode | TooltipProps & \\{ icon: VueNode \\}"
}
},
{
"name": "layout",
"description": "Form item layout",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "prefix-cls",
"description": "Prefix class name",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "default",
"description": "(ZH) 表单控件内容\n\n(EN) Form control content"
},
{
"name": "label",
"description": "(ZH) 自定义标签内容（优先于 label 属性）\n\n(EN) Custom label content (higher priority than label prop)"
},
{
"name": "tooltip",
"description": "(ZH) 自定义标签提示内容。插槽参数为当前 tooltip 配置；当 tooltip 为对象配置时，插槽返回对象会与原配置合并\n\n(EN) Custom label tooltip content. The slot arg is the current tooltip config; when tooltip is an options object, returning an object from slot will be merged into it"
},
{
"name": "extra",
"description": "(ZH) 自定义额外提示信息（优先于 extra 属性）\n\n(EN) Custom extra message (higher priority than extra prop)"
},
{
"name": "help",
"description": "(ZH) 自定义帮助/错误提示（优先于 help 属性）\n\n(EN) Custom help/error message (higher priority than help prop)"
}
]
},
{
"name": "a-类型",
"description": "高性能表单控件，自带数据域管理。包含数据录入、校验以及对应样式。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-float-button-group",
"description": "(ZH) 悬浮于页面上方的按钮。\n\n(EN) A button that floats at the top of the page.",
"attributes": [
{
"name": "shape",
"description": "Setting button shape of children",
"default": "circle",
"value": {
"kind": "expression",
"type": "circle | square"
}
},
{
"name": "trigger",
"description": "Which action can trigger menu open/close",
"value": {
"kind": "expression",
"type": "click | hover"
}
},
{
"name": "open",
"description": "Whether the menu is visible or not, use it with trigger",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "close-icon",
"description": "Customize close button icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "placement",
"description": "Customize menu animation placement",
"default": "top",
"value": {
"kind": "expression",
"type": "top | left | right | bottom"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
}
],
"js": {
"events": [
{
"name": "update:open",
"description": "(ZH) 展开收起时的回调，需配合 trigger 一起使用\n\n(EN) Callback executed when active menu is changed, use it with trigger",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "click",
"description": "(ZH) 点击按钮时的回调（仅在菜单模式中有效）\n\n(EN) Set the handler to handle click event (only work in Menu mode)",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "default",
"description": "(ZH) 子按钮内容\n\n(EN) Children buttons content"
},
{
"name": "icon",
"description": "(ZH) 触发按钮的图标\n\n(EN) Icon of trigger button"
},
{
"name": "closeIcon",
"description": "(ZH) 自定义关闭按钮\n\n(EN) Customize close button icon"
}
]
},
{
"name": "a-float-button",
"description": "(ZH) 悬浮于页面上方的按钮。\n\n(EN) A button that floats at the top of the page.",
"attributes": [
{
"name": "icon",
"description": "Set the icon component of button",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "content",
"description": "Text and other",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "~~description~~",
"description": "Please use content instead",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "tooltip",
"description": "The text shown in the tooltip",
"value": {
"kind": "expression",
"type": "VueNode | TooltipProps"
}
},
{
"name": "type",
"description": "Setting button type",
"default": "default",
"value": {
"kind": "expression",
"type": "default | primary"
}
},
{
"name": "shape",
"description": "Setting button shape",
"default": "circle",
"value": {
"kind": "expression",
"type": "circle | square"
}
},
{
"name": "href",
"description": "The target of hyperlink",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "target",
"description": "Specifies where to display the linked URL",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "html-type",
"description": "Set the original html type of button, see: MDN",
"default": "button",
"value": {
"kind": "expression",
"type": "submit | reset | button"
}
},
{
"name": "badge",
"description": "Attach Badge to FloatButton. status and other props related are not supported.",
"value": {
"kind": "expression",
"type": "BadgeProps"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击按钮时的回调\n\n(EN) Set the handler to handle click event",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "default",
"description": "(ZH) 按钮内容\n\n(EN) Button content"
},
{
"name": "icon",
"description": "(ZH) 自定义图标\n\n(EN) Set the icon component of button"
},
{
"name": "tooltip",
"description": "(ZH) 气泡卡片的内容\n\n(EN) The text shown in the tooltip"
}
]
},
{
"name": "a-float-back-top",
"description": "(ZH) 悬浮于页面上方的按钮。\n\n(EN) A button that floats at the top of the page.",
"attributes": [
{
"name": "duration",
"description": "Time to return to top（ms）",
"default": "450",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "target",
"description": "Specifies where to display the linked URL",
"value": {
"kind": "expression",
"type": "'_self' | '_blank' | '_parent' | '_top' | string"
}
},
{
"name": "visibility-height",
"description": "The BackTop button will not show until the scroll height reaches this value",
"default": "400",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "badge",
"description": "Attach Badge to FloatButton. status and other props related are not supported.",
"value": {
"kind": "expression",
"type": "FloatButtonBadgeProps & { class?: string }"
}
},
{
"name": "html-type",
"description": "Set the original html type of button, see: MDN",
"default": "button",
"value": {
"kind": "expression",
"type": "ButtonHTMLType"
}
},
{
"name": "aria-label",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "style",
"description": "-",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "FloatButtonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "FloatButtonStylesType"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击按钮的回调函数\n\n(EN) A callback function, which can be executed when you click the button",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-row",
"description": "(ZH) 24 栅格系统。\n\n(EN) 24 Grids System.",
"attributes": [
{
"name": "align",
"description": "Vertical alignment",
"default": "top",
"value": {
"kind": "expression",
"type": "top | middle | bottom | stretch | {[key in 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl']: 'top' | 'middle' | 'bottom' | 'stretch'}"
}
},
{
"name": "gutter",
"description": "Spacing between grids, could be a string CSS units or a object like { xs: 8, sm: 16, md: 24}. Or you can use array to make horizontal and vertical spacing work at the same time [horizontal, vertical]",
"default": "0",
"value": {
"kind": "expression",
"type": "number | string | object | array"
}
},
{
"name": "justify",
"description": "Horizontal arrangement",
"default": "start",
"value": {
"kind": "expression",
"type": "start | end | center | space-around | space-between | space-evenly | {[key in 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl']: 'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly'}"
}
},
{
"name": "wrap",
"description": "Auto wrap line",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-col",
"description": "(ZH) 24 栅格系统。\n\n(EN) 24 Grids System.",
"attributes": [
{
"name": "flex",
"description": "Flex layout style",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "offset",
"description": "The number of cells to offset Col from the left",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "order",
"description": "Raster order",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "pull",
"description": "The number of cells that raster is moved to the left",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "push",
"description": "The number of cells that raster is moved to the right",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "span",
"description": "Raster number of cells to occupy, 0 corresponds to display: none",
"default": "none",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "xs",
"description": "screen < 576px and also default setting, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "sm",
"description": "screen ≥ 576px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "md",
"description": "screen ≥ 768px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "lg",
"description": "screen ≥ 992px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "xl",
"description": "screen ≥ 1200px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "xxl",
"description": "screen ≥ 1600px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
},
{
"name": "xxxl",
"description": "screen ≥ 1920px, could be a span value or an object containing above props",
"value": {
"kind": "expression",
"type": "number | object"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-image",
"description": "(ZH) 可预览的图片。\n\n(EN) Preview-able image.",
"attributes": [
{
"name": "preview",
"description": "Preview configuration; set to false to disable",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | PreviewConfig"
}
},
{
"name": "wrapper-style",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ImageClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ImageStylesType"
}
},
{
"name": "root-class",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "alt",
"description": "Image description",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "height",
"description": "Image height",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "src",
"description": "Image URL",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "width",
"description": "Image width",
"value": {
"kind": "expression",
"type": "string | number"
}
}
],
"js": {
"events": [
{
"name": "error",
"description": "(ZH) 加载错误回调\n\n(EN) Callback when loading error occurs",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
},
{
"name": "click",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
}
]
},
"slots": [
{
"name": "fallback",
"description": "(ZH) 加载失败容错地址\n\n(EN) Fallback URL when load fails"
},
{
"name": "placeholder",
"description": "(ZH) 加载占位，为 true 时使用默认占位\n\n(EN) Loading placeholder; if true, uses default placeholder"
}
]
},
{
"name": "a-common-icon",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-custom-icon",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-about-svg-icons",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-set-two-tone-color",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-custom-font-icon",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-custom-svg-icon",
"description": "Semantic vector graphics.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-通用图标",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-自定义-icon",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-关于-svg-图标",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-双色图标主色",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-自定义-font-图标",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-自定义-svg-图标",
"description": "语义化的矢量图形。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-input",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [
{
"name": "allow-clear",
"description": "If allow to remove input content with clear icon",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { clearIcon: VueNode }"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "count",
"description": "Character count config",
"value": {
"kind": "expression",
"type": "CountConfig"
}
},
{
"name": "default-value",
"description": "The initial input content",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "disabled",
"description": "Whether the input is disabled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "id",
"description": "The ID for input",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "maxlength",
"description": "The maximum number of characters in Input",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "prefix",
"description": "The prefix icon for the Input",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "show-count",
"description": "Whether to show character count",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { formatter: (info: { value: string, count: number, maxLength?: number }) => VueNode }"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "'error' | 'warning'"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "size",
"description": "The size of the input box. Note: in the context of a form, the middle size is used",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "suffix",
"description": "The suffix icon for the Input",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "type",
"description": "The type of input, see: MDN( use Input.TextArea instead of type=\"textarea\")",
"default": "text",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "value",
"description": "The input content value, support v-model:value",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "variant",
"description": "Variants of Input",
"default": "outlined",
"value": {
"kind": "expression",
"type": "outlined | borderless | filled | underlined"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 输入框内容变化时的回调\n\n(EN) Callback when user input",
"arguments": [
{
"name": "payload",
"type": "function(e)"
}
]
},
{
"name": "pressEnter",
"description": "(ZH) 按下回车的回调\n\n(EN) The callback function that is triggered when Enter key is pressed",
"arguments": [
{
"name": "payload",
"type": "function(e)"
}
]
},
{
"name": "clear",
"description": "(ZH) 按下清除按钮的回调\n\n(EN) Callback when click the clear button",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": [
{
"name": "prefix",
"description": "(ZH) 自定义前缀图标\n\n(EN) Customize prefix icon"
},
{
"name": "suffix",
"description": "(ZH) 自定义后缀图标\n\n(EN) Customize suffix icon"
},
{
"name": "clearIcon",
"description": "(ZH) 自定义清除图标（需搭配allowClear属性使用）\n\n(EN) Customize clear icon (to be used with allowClear attribute)"
}
]
},
{
"name": "a-text-area",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [
{
"name": "auto-size",
"description": "Height auto size feature, can be set to true | false or an object { minRows: 2, maxRows: 6 }",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | object"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-input-search",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "enter-button",
"description": "false displays the default button color, true uses the primary color, or you can provide a custom button. Conflicts with addonAfter.",
"default": "false",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "loading",
"description": "Search box with loading",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
}
],
"js": {
"events": [
{
"name": "search",
"description": "(ZH) 点击搜索图标、清除图标，或按下回车键时的回调\n\n(EN) The callback function triggered when you click on the search-icon, the clear-icon or press the Enter key",
"arguments": [
{
"name": "payload",
"type": "function(value, event, { source: \"input\" | \"clear\" })"
}
]
}
]
},
"slots": []
},
{
"name": "a-input-password",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [
{
"name": "classes",
"description": "Semantic DOM class",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "icon-render",
"description": "Custom toggle button",
"default": "(visible) => (visible ? : )",
"value": {
"kind": "expression",
"type": "(visible) => VueNode"
}
},
{
"name": "styles",
"description": "Semantic DOM style",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "visibility-toggle",
"description": "Whether show toggle button or control password visible",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | VisibilityToggle"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-input-otp",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "default-value",
"description": "Default value",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "disabled",
"description": "Whether the input is disabled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "formatter",
"description": "Format display, blank fields will be filled with",
"value": {
"kind": "expression",
"type": "(value: string) => string"
}
},
{
"name": "separator",
"description": "render the separator after the input box of the specified index",
"value": {
"kind": "expression",
"type": "VueNode | ((i: number) => VueNode)"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "mask",
"description": "Custom display, the original value will not be modified",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | string"
}
},
{
"name": "length",
"description": "The number of input elements",
"default": "6",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "'error' | 'warning'"
}
},
{
"name": "size",
"description": "The size of the input box",
"default": "middle",
"value": {
"kind": "expression",
"type": "small | middle | large"
}
},
{
"name": "variant",
"description": "Variants of Input",
"default": "outlined",
"value": {
"kind": "expression",
"type": "outlined | borderless | filled | underlined"
}
},
{
"name": "value",
"description": "The input content value",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 当输入框内容全部填充时触发回调\n\n(EN) Trigger when all the fields are filled",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
},
{
"name": "input",
"description": "(ZH) 输入值变化时触发的回调\n\n(EN) Trigger when the input value changes",
"arguments": [
{
"name": "payload",
"type": "(value: string[]) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-types",
"description": "(ZH) 通过鼠标或键盘输入内容，是最基础的表单域的包装。\n\n(EN) Through mouse or keyboard input content, it is the most basic form field wrapper.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-input-number",
"description": "(ZH) 通过鼠标或键盘，输入范围内的数值。\n\n(EN) Enter a number within certain range with the mouse or keyboard.",
"attributes": [
{
"name": "size",
"description": "The height of input box",
"value": {
"kind": "expression",
"type": "SizeType"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "InputStatus"
}
},
{
"name": "disabled",
"description": "If the input is disabled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "addon-before",
"description": "The label text displayed before (on the left side of) the input field, please use Space.Compact instead",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "addon-after",
"description": "The label text displayed after (on the right side of) the input field, please use Space.Compact instead",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "prefix",
"description": "The prefix icon for the Input",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "suffix",
"description": "The suffix icon for the Input",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "bordered",
"description": "Deprecated.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "variant",
"description": "Variants of Input",
"default": "outlined",
"value": {
"kind": "expression",
"type": "Variant"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "InputNumberClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "InputNumberStylesType"
}
},
{
"name": "controls",
"description": "Whether to show +- controls, or set custom arrow icons",
"value": {
"kind": "expression",
"type": "boolean | { upIcon?: VueNode, downIcon?: VueNode }"
}
},
{
"name": "type",
"description": "-",
"value": {
"kind": "expression",
"type": "'number' | 'text'"
}
},
{
"name": "max",
"description": "The max value",
"default": "Number.MAX_SAFE_INTEGER",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "min",
"description": "The min value",
"default": "Number.MIN_SAFE_INTEGER",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "step",
"description": "The number to which the current value is increased or decreased. It can be an integer or decimal",
"default": "1",
"value": {
"kind": "expression",
"type": "'number' | 'string'"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 变化回调\n\n(EN) The callback triggered when the value is changed",
"arguments": [
{
"name": "payload",
"type": "(value: any) => void"
}
]
},
{
"name": "update:value",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(value: any) => void"
}
]
},
{
"name": "input",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(text: string) => void"
}
]
},
{
"name": "pressEnter",
"description": "(ZH) 按下回车的回调\n\n(EN) The callback function that is triggered when Enter key is pressed",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "step",
"description": "(ZH) @step点击上下箭头、键盘、滚轮的回调\n\n(EN) @stepThe callback function that is triggered when click up or down buttons / Keyboard / Wheel",
"arguments": [
{
"name": "payload",
"type": "(value: any, info: InputNumberStepContext) => void"
}
]
},
{
"name": "mousedown",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "click",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseup",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseleave",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mousemove",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseenter",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "mouseout",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "focus",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: FocusEvent) => void"
}
]
},
{
"name": "blur",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: FocusEvent) => void"
}
]
},
{
"name": "keydown",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "keyup",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "compositionstart",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: CompositionEvent) => void"
}
]
},
{
"name": "compositionend",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: CompositionEvent) => void"
}
]
},
{
"name": "beforeinput",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(e: InputEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "prefix",
"description": "(ZH) 带有前缀图标的 input\n\n(EN) The prefix icon for the Input"
},
{
"name": "suffix",
"description": "(ZH) 带有后缀图标的 input\n\n(EN) The suffix icon for the Input"
},
{
"name": "addonBefore",
"description": "(ZH) 带标签的 input，设置前置标签，请使用 Space.Compact 替换\n\n(EN) The label text displayed before (on the left side of) the input field, please use Space.Compact instead"
},
{
"name": "addonAfter",
"description": "(ZH) 带标签的 input，设置后置标签，请使用 Space.Compact 替换\n\n(EN) The label text displayed after (on the right side of) the input field, please use Space.Compact instead"
}
]
},
{
"name": "a-layout",
"description": "(ZH) 协助进行页面级整体布局。\n\n(EN) Handling the overall layout of a page.",
"attributes": [
{
"name": "has-sider",
"description": "Whether contain Sider in children, don't have to assign it normally. Useful in ssr avoid style flickering",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-layout-sider",
"description": "(ZH) 协助进行页面级整体布局。\n\n(EN) Handling the overall layout of a page.",
"attributes": [
{
"name": "breakpoint",
"description": "Breakpoints of the responsive layout",
"value": {
"kind": "expression",
"type": "xs | sm | md | lg | xl | xxl | xxxl"
}
},
{
"name": "collapsed",
"description": "To set the current status",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "collapsed-width",
"description": "Width of the collapsed sidebar, by setting to 0 a special trigger will appear",
"default": "80",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "collapsible",
"description": "Whether can be collapsed",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "reverse-arrow",
"description": "Reverse direction of arrow, for a sider that expands from the right",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "theme",
"description": "Color theme of the sidebar",
"default": "dark",
"value": {
"kind": "expression",
"type": "light | dark"
}
},
{
"name": "trigger",
"description": "Specify the customized trigger, set to null to hide the trigger",
"value": {
"kind": "expression",
"type": "ReactNode"
}
},
{
"name": "width",
"description": "Width of the sidebar",
"default": "200",
"value": {
"kind": "expression",
"type": "number | string"
}
},
{
"name": "zero-width-trigger-style",
"description": "To customize the styles of the special trigger that appears when collapsedWidth is 0",
"value": {
"kind": "expression",
"type": "object"
}
}
],
"js": {
"events": [
{
"name": "breakpoint",
"description": "The callback function, executed when breakpoints changed",
"arguments": [
{
"name": "payload",
"type": "(broken: boolean) => void"
}
]
},
{
"name": "collapse",
"description": "The callback function, executed by clicking the trigger or activating the responsive layout",
"arguments": [
{
"name": "payload",
"type": "(collapsed: boolean, type: string) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-menu",
"description": "(ZH) 为页面和功能提供导航的菜单列表。\n\n(EN) A versatile menu for navigation.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "MenuClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "MenuStylesType"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "default-open-keys",
"description": "Array with the keys of default opened sub menus",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "default-selected-keys",
"description": "Array with the keys of default selected menu items",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "expand-icon",
"description": "Custom expand icon of submenu",
"value": {
"kind": "expression",
"type": "VueNode | ((props: SubMenuProps & { isSubMenu: boolean }) => VueNode)"
}
},
{
"name": "force-sub-menu-render",
"description": "Render submenu into DOM before it becomes visible",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "inline-collapsed",
"description": "Specifies the collapsed status when menu is inline mode",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "inline-indent",
"description": "Indent (in pixels) of inline menu items on each level",
"default": "24",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "items",
"description": "Menu item content",
"value": {
"kind": "expression",
"type": "ItemType[]"
}
},
{
"name": "mode",
"description": "Type of menu",
"default": "vertical",
"value": {
"kind": "expression",
"type": "vertical | horizontal | inline"
}
},
{
"name": "multiple",
"description": "Allows selection of multiple items",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "open-keys",
"description": "Array with the keys of currently opened sub-menus",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "overflowed-indicator",
"description": "Customized the ellipsis icon when menu is collapsed horizontally",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "selectable",
"description": "Allows selecting menu items",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "selected-keys",
"description": "Array with the keys of currently selected menu items",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "sub-menu-close-delay",
"description": "Delay time to hide submenu when mouse leaves (in seconds)",
"default": "0.1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "sub-menu-open-delay",
"description": "Delay time to show submenu when mouse enters, (in seconds)",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "theme",
"description": "Color theme of the menu",
"default": "light",
"value": {
"kind": "expression",
"type": "light | dark"
}
},
{
"name": "trigger-sub-menu-action",
"description": "Which action can trigger submenu open/close",
"default": "hover",
"value": {
"kind": "expression",
"type": "hover | click"
}
},
{
"name": "get-popup-container",
"description": "To set the container of the submenu popup. The default is to create a div element in body, but you can reset it to the scrolling area and make a relative reposition",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "item-icon",
"description": "Custom menu item icon render",
"value": {
"kind": "expression",
"type": "(props: MenuItemProps & RenderIconInfo) => any"
}
},
{
"name": "label-render",
"description": "Custom label render",
"value": {
"kind": "expression",
"type": "(item: RenderItem) => any"
}
},
{
"name": "icon-render",
"description": "Custom icon render (items mode)",
"value": {
"kind": "expression",
"type": "(item: RenderItem) => any"
}
},
{
"name": "extra-render",
"description": "Custom extra render",
"value": {
"kind": "expression",
"type": "(item: RenderItem) => any"
}
},
{
"name": "popup-render",
"description": "Custom popup renderer for submenu",
"value": {
"kind": "expression",
"type": "(node: VueNode, info: { item: SubMenuProps; keys: string[] }) => VueNode"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击 MenuItem 调用此函数\n\n(EN) Called when a menu item is clicked",
"arguments": [
{
"name": "payload",
"type": "(info: MenuInfo) => void"
}
]
},
{
"name": "select",
"description": "(ZH) 被选中时调用\n\n(EN) Called when a menu item is selected",
"arguments": [
{
"name": "payload",
"type": "(info: SelectInfo) => void"
}
]
},
{
"name": "deselect",
"description": "(ZH) 取消选中时调用，仅在 multiple 生效\n\n(EN) Called when a menu item is deselected (multiple mode only)",
"arguments": [
{
"name": "payload",
"type": "(info: SelectInfo) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) SubMenu 展开/关闭的回调\n\n(EN) Called when sub-menus are opened or closed",
"arguments": [
{
"name": "payload",
"type": "(openKeys: string[]) => void"
}
]
}
]
},
"slots": [
{
"name": "expandIcon",
"description": "(ZH) 自定义展开图标\n\n(EN) Custom expand icon"
},
{
"name": "labelRender",
"description": "(ZH) 自定义菜单项标签\n\n(EN) Customize label content"
},
{
"name": "iconRender",
"description": "(ZH) 自定义菜单项图标（items 模式）\n\n(EN) Customize item icon (items mode)"
},
{
"name": "extraRender",
"description": "(ZH) 自定义菜单项额外内容\n\n(EN) Customize extra content"
},
{
"name": "itemIcon",
"description": "(ZH) 自定义菜单项图标\n\n(EN) Custom item icon"
}
]
},
{
"name": "a-static-methods",
"description": "Prompt notification message globally.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-arguments",
"description": "Display global messages as feedback in response to user operations.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-config",
"description": "(ZH) 全局展示操作反馈信息。\n\n(EN) Display global messages as feedback in response to user operations.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-global-configuration",
"description": "Prompt notification message globally.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-静态方法",
"description": "全局展示通知提醒信息。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-参数",
"description": "全局展示操作反馈信息。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-全局配置",
"description": "全局展示通知提醒信息。",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-mentions",
"description": "(ZH) 用于在输入中提及某人或某事。\n\n(EN) Used to mention someone or something in an input.",
"attributes": [
{
"name": "loading",
"description": "-",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "InputStatus"
}
},
{
"name": "options",
"description": "Option Configuration",
"default": "\\[]",
"value": {
"kind": "expression",
"type": "MentionsOptionProps[]"
}
},
{
"name": "popup-class-name",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "variant",
"description": "Variants of Input",
"default": "outlined",
"value": {
"kind": "expression",
"type": "Variant"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "MentionsClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "MentionsStylesType"
}
},
{
"name": "size",
"description": "-",
"value": {
"kind": "expression",
"type": "SizeType"
}
},
{
"name": "label-render",
"description": "-",
"value": {
"kind": "expression",
"type": "(ctx: { option: MentionsOptionProps, index: number }) => any"
}
},
{
"name": "allow-clear",
"description": "If allow to remove mentions content with clear icon",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { clearIcon?: VueNode }"
}
},
{
"name": "disabled",
"description": "-",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "focus",
"description": "(ZH) 获得焦点时触发\n\n(EN) Trigger when mentions get focus",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent) => void"
}
]
},
{
"name": "blur",
"description": "(ZH) 失去焦点时触发\n\n(EN) Trigger when mentions lose focus",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent) => void"
}
]
},
{
"name": "change",
"description": "(ZH) 值改变时触发\n\n(EN) Trigger when value changed",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
},
{
"name": "select",
"description": "(ZH) 选择选项时触发\n\n(EN) Trigger when user select the option",
"arguments": [
{
"name": "payload",
"type": "(option: MentionsOptionProps, prefix: string) => void"
}
]
},
{
"name": "popupScroll",
"description": "(ZH) 滚动时触发\n\n(EN) Trigger when mentions scroll",
"arguments": [
{
"name": "payload",
"type": "(event: Event) => void"
}
]
},
{
"name": "search",
"description": "(ZH) 搜索时触发\n\n(EN) Trigger when prefix hit",
"arguments": [
{
"name": "payload",
"type": "(text: string, prefix: string) => void"
}
]
},
{
"name": "update:value",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
}
]
},
"slots": [
{
"name": "suffix",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "labelRender",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-masonry",
"description": "(ZH) 瀑布流\n\n(EN) A masonry layout component for displaying content with different heights.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "columns",
"description": "Number of columns, can be a fixed value or a responsive configuration",
"default": "3",
"value": {
"kind": "expression",
"type": "number | { xs?: number; sm?: number; md?: number; lg?: number; xl?: number; xxl?: number }"
}
},
{
"name": "fresh",
"description": "Whether to continuously monitor the size changes of child items",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "gutter",
"description": "Spacing, can be a fixed value, responsive configuration, or a configuration for horizontal and vertical spacing",
"default": "0",
"value": {
"kind": "expression",
"type": "Gap | [Gap, Gap]"
}
},
{
"name": "items",
"description": "Masonry items",
"value": {
"kind": "expression",
"type": "MasonryItem[]"
}
},
{
"name": "item-render",
"description": "Custom item rendering function",
"value": {
"kind": "expression",
"type": "(item: MasonryItem) => VueNode"
}
}
],
"js": {
"events": [
{
"name": "layoutChange",
"description": "(ZH) 列排序回调\n\n(EN) Callback for column sorting changes",
"arguments": [
{
"name": "payload",
"type": "(sortInfo: { key: Key; column: number }[]) => void"
}
]
}
]
},
"slots": [
{
"name": "itemRender",
"description": "(ZH) 自定义项渲染插槽\n\n(EN) Custom item rendering slot"
}
]
},
{
"name": "a-modal",
"description": "(ZH) 展示一个对话框，提供标题、内容区、操作区。\n\n(EN) Display a modal dialog box, providing a title, content area, and action buttons.",
"attributes": [
{
"name": "after-close",
"description": "Specify a function that will be called when modal is closed completely",
"value": {
"kind": "expression",
"type": "() => void"
}
},
{
"name": "after-open-change",
"description": "Callback when the animation ends when Modal is turned on and off",
"value": {
"kind": "expression",
"type": "(open: boolean) => void"
}
},
{
"name": "cancel-button-props",
"description": "The cancel button props",
"value": {
"kind": "expression",
"type": "ButtonProps"
}
},
{
"name": "cancel-text",
"description": "Text of the Cancel button",
"default": "Cancel",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "centered",
"description": "Centered Modal",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the Modal component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ModalClassNamesType"
}
},
{
"name": "closable",
"description": "Whether a close (x) button is visible on top right or not",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | ClosableType"
}
},
{
"name": "close-icon",
"description": "Custom close icon. Close button will be hidden when setting to null or false",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "confirm-loading",
"description": "Whether to apply loading visual effect for OK button or not",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "destroy-on-hidden",
"description": "Whether to unmount child components on close",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "focus-trigger-after-close",
"description": "Whether need to focus trigger element after dialog is closed",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "footer",
"description": "Footer content, set as footer={null} when you don't need default buttons",
"default": "(OK and Cancel buttons)",
"value": {
"kind": "expression",
"type": "VueNode | (params: { originNode: VueNode, extra: { OkBtn: any, CancelBtn: any } }) => any"
}
},
{
"name": "force-render",
"description": "Force render Modal",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "focusable",
"description": "Configuration for focus management in the Modal",
"value": {
"kind": "expression",
"type": "{ trap?: boolean, focusTriggerAfterClose?: boolean }"
}
},
{
"name": "get-container",
"description": "The mounted node for Modal but still display at fullscreen",
"default": "document.body",
"value": {
"kind": "expression",
"type": "string | HTMLElement | (() => HTMLElement) | false"
}
},
{
"name": "keyboard",
"description": "Whether support press esc to close",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "loading",
"description": "Show the skeleton",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mask",
"description": "Mask effect",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | {enabled?: boolean, blur?: boolean, closable?: boolean}"
}
},
{
"name": "~~mask-closable~~",
"description": "Whether to close the modal dialog when the mask (area outside the modal) is clicked",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "modal-render",
"description": "Custom modal content render",
"value": {
"kind": "expression",
"type": "(node: any) => any"
}
},
{
"name": "mouse-position",
"description": "Set animation start position",
"value": {
"kind": "expression",
"type": "MousePosition"
}
},
{
"name": "ok-button-props",
"description": "The ok button props",
"value": {
"kind": "expression",
"type": "ButtonProps"
}
},
{
"name": "ok-text",
"description": "Text of the OK button",
"default": "OK",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "ok-type",
"description": "Button type of the OK button",
"default": "primary",
"value": {
"kind": "expression",
"type": "LegacyButtonType"
}
},
{
"name": "open",
"description": "Whether the modal dialog is visible or not, support v-model:open",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "root-style",
"description": "Root container style",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the Modal component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ModalStylesType"
}
},
{
"name": "title",
"description": "The modal dialog's title",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "transition-name",
"description": "Transition name of dialog",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "mask-transition-name",
"description": "Transition name of mask",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "width",
"description": "Width of the modal dialog",
"default": "520",
"value": {
"kind": "expression",
"type": "string | number | Partial>"
}
},
{
"name": "wrap-class-name",
"description": "The class name of the container of the modal dialog",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "wrap-props",
"description": "Wrapper element props",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "z-index",
"description": "The z-index of the Modal",
"default": "1000",
"value": {
"kind": "expression",
"type": "number"
}
}
],
"js": {
"events": [
{
"name": "ok",
"description": "(ZH) 点击确定回调\n\n(EN) Callback when the OK button is clicked",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "cancel",
"description": "(ZH) 点击遮罩层或右上角叉或取消按钮的回调\n\n(EN) Callback when the mask, close button or Cancel button is clicked",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
},
{
"name": "update:open",
"description": "对话框显隐变化",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
}
]
},
"slots": [
{
"name": "default",
"description": "(ZH) 内容\n\n(EN) Modal content"
},
{
"name": "title",
"description": "(ZH) 标题\n\n(EN) Title"
},
{
"name": "footer",
"description": "(ZH) 底部内容\n\n(EN) Footer content"
},
{
"name": "okText",
"description": "(ZH) 确认按钮文字\n\n(EN) OK button text"
},
{
"name": "cancelText",
"description": "(ZH) 取消按钮文字\n\n(EN) Cancel button text"
},
{
"name": "closeIcon",
"description": "(ZH) 自定义关闭图标\n\n(EN) Custom close icon"
},
{
"name": "modalRender",
"description": "(ZH) 自定义渲染内容\n\n(EN) Custom modal content render"
}
]
},
{
"name": "a-args-props",
"description": "(ZH) 全局展示通知提醒信息。\n\n(EN) Prompt notification message globally.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-notification-use-notification",
"description": "(ZH) 全局展示通知提醒信息。\n\n(EN) Prompt notification message globally.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-closable-type",
"description": "(ZH) 全局展示通知提醒信息。\n\n(EN) Prompt notification message globally.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-popover",
"description": "(ZH) 点击/鼠标移入元素，弹出气泡式的卡片浮层。\n\n(EN) The floating card pops up when clicking/mouse hovering over an element.",
"attributes": [
{
"name": "title",
"description": "Title of the card",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "content",
"description": "Content of the card",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PopoverClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PopoverStylesType"
}
}
],
"js": {
"events": [
{
"name": "openChange",
"description": "(ZH) 显隐变化时回调\n\n(EN) Callback when popover visibility changes",
"arguments": [
{
"name": "payload",
"type": "(open: boolean, e?: MouseEvent | KeyboardEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 卡片标题\n\n(EN) Title of the card"
},
{
"name": "content",
"description": "(ZH) 卡片内容\n\n(EN) Content of the card"
}
]
},
{
"name": "a-popconfirm",
"description": "(ZH) 点击元素，弹出气泡式的确认框。\n\n(EN) Pop up a bubble confirmation box for an action.",
"attributes": [
{
"name": "cancel-button-props",
"description": "The cancel button props",
"value": {
"kind": "expression",
"type": "ButtonProps"
}
},
{
"name": "cancel-text",
"description": "The text of the Cancel button",
"default": "Cancel",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "disabled",
"description": "Whether to show popconfirm when clicking its children node",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "Customize icon of confirmation",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "ok-button-props",
"description": "The ok button props",
"value": {
"kind": "expression",
"type": "ButtonProps"
}
},
{
"name": "ok-text",
"description": "The text of the Confirm button",
"default": "OK",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "ok-type",
"description": "Button type of the Confirm button",
"default": "primary",
"value": {
"kind": "expression",
"type": "LegacyButtonType"
}
},
{
"name": "show-cancel",
"description": "Show cancel button",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "title",
"description": "The title of the confirmation box",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "description",
"description": "The description of the confirmation box",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PopconfirmClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PopconfirmStylesType"
}
}
],
"js": {
"events": [
{
"name": "openChange",
"description": "(ZH) 显隐变化时回调\n\n(EN) Callback when popconfirm visibility changes",
"arguments": [
{
"name": "payload",
"type": "(open: boolean, e?: MouseEvent | KeyboardEvent) => void"
}
]
},
{
"name": "confirm",
"description": "(ZH) 点击确认的回调\n\n(EN) Callback of confirmation",
"arguments": [
{
"name": "payload",
"type": "(e?: MouseEvent) => void"
}
]
},
{
"name": "cancel",
"description": "(ZH) 点击取消的回调\n\n(EN) Callback of cancel",
"arguments": [
{
"name": "payload",
"type": "(e?: MouseEvent) => void"
}
]
},
{
"name": "popupClick",
"description": "(ZH) 弹出气泡点击事件\n\n(EN) Callback of popup click",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 确认框标题\n\n(EN) The title of the confirmation box"
},
{
"name": "description",
"description": "(ZH) 确认内容的详细描述\n\n(EN) The description of the confirmation box title"
},
{
"name": "icon",
"description": "(ZH) 自定义弹出气泡 Icon 图标\n\n(EN) Customize icon of confirmation"
},
{
"name": "okText",
"description": "(ZH) 确认按钮文字\n\n(EN) The text of the Confirm button"
},
{
"name": "cancelText",
"description": "(ZH) 取消按钮文字\n\n(EN) The text of the Cancel button"
}
]
},
{
"name": "a-progress",
"description": "(ZH) 展示操作的当前进度。\n\n(EN) Display the current progress of the operation.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ProgressClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "ProgressStylesType"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "type",
"description": "To set the type, options: line circle dashboard",
"default": "line",
"value": {
"kind": "expression",
"type": "ProgressType"
}
},
{
"name": "percent",
"description": "To set the completion percentage",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "format",
"description": "The template function of the content",
"default": "(percent) => percent + %",
"value": {
"kind": "expression",
"type": "(percent?: number, successPercent?: number) => any"
}
},
{
"name": "status",
"description": "To set the status of the Progress, options: success exception normal active(line only)",
"value": {
"kind": "expression",
"type": "(typeof ProgressStatuses)[number]"
}
},
{
"name": "show-info",
"description": "Whether to display the progress value and the status icon",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "stroke-width",
"description": "-",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "stroke-linecap",
"description": "To set the style of the progress linecap",
"default": "round",
"value": {
"kind": "expression",
"type": "'butt' | 'square' | 'round'"
}
},
{
"name": "stroke-color",
"description": "The color of progress bar",
"value": {
"kind": "expression",
"type": "string | string[] | ProgressGradient"
}
},
{
"name": "rail-color",
"description": "The color of unfilled part",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "success",
"description": "Configs of successfully progress bar",
"value": {
"kind": "expression",
"type": "SuccessProps"
}
},
{
"name": "trail-color",
"description": "The color of unfilled part. Please use railColor instead",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "width",
"description": "Deprecated. Use size instead",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "size",
"description": "Progress size",
"default": "default",
"value": {
"kind": "expression",
"type": "number | [number | string, number] | ProgressSize | { width?: number, height?: number }"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-qrcode",
"description": "(ZH) 能够将文本转换生成二维码的组件，支持自定义配色和 Logo 配置。\n\n(EN) Components that can convert text into QR codes, and support custom color and logo.",
"attributes": [
{
"name": "value",
"description": "scanned text",
"value": {
"kind": "expression",
"type": "string | string[]"
}
},
{
"name": "type",
"description": "render type",
"default": "canvas",
"value": {
"kind": "expression",
"type": "canvas | svg"
}
},
{
"name": "icon",
"description": "include image url (only image link are supported)",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "size",
"description": "QRCode size",
"default": "160",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "icon-size",
"description": "include image size",
"default": "40",
"value": {
"kind": "expression",
"type": "number | { width: number; height: number }"
}
},
{
"name": "color",
"description": "QRCode Color",
"default": "#000",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "bg-color",
"description": "QRCode Background Color",
"default": "transparent",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "margin-size",
"description": "Quiet zone size (in modules). 0 means no margin",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "bordered",
"description": "Whether has border style",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "error-level",
"description": "Error Code Level",
"default": "'M'",
"value": {
"kind": "expression",
"type": "'L' | 'M' | 'Q' | 'H'"
}
},
{
"name": "boost-level",
"description": "If enabled, the Error Correction Level of the result may be higher than the specified Error Correction Level",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "status",
"description": "QRCode status",
"default": "'active'",
"value": {
"kind": "expression",
"type": "'active' | 'expired' | 'loading' | 'scanned'"
}
},
{
"name": "status-render",
"description": "custom status render",
"value": {
"kind": "expression",
"type": "(info: StatusRenderInfo) => VueNode"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
}
],
"js": {
"events": [
{
"name": "refresh",
"description": "(ZH) 刷新二维码\n\n(EN) Refresh the QR code",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": [
{
"name": "statusRender",
"description": "(ZH) 自定义状态渲染器\n\n(EN) custom status render"
}
]
},
{
"name": "a-pagination",
"description": "(ZH) 分页器用于分隔长列表，每次只加载一个页面。\n\n(EN) A long list can be divided into several pages, and only one page will be loaded at a time.",
"attributes": [
{
"name": "align",
"description": "Alignment of pagination",
"value": {
"kind": "expression",
"type": "start | center | end"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PaginationClassNamesType"
}
},
{
"name": "current",
"description": "Current page number",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "default-current",
"description": "Default initial page number",
"default": "1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "default-page-size",
"description": "Default number of data items per page",
"default": "10",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "disabled",
"description": "Disable pagination",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "hide-on-single-page",
"description": "Whether to hide pager on single page",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "item-render",
"description": "To customize item's innerHTML",
"value": {
"kind": "expression",
"type": "(page: number, type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next', element: VueNode) => VueNode"
}
},
{
"name": "page-size",
"description": "Number of data items per page",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "page-size-options",
"description": "Specify the sizeChanger options",
"default": "['10', '20', '50', '100']",
"value": {
"kind": "expression",
"type": "(string | number)[]"
}
},
{
"name": "responsive",
"description": "If size is not specified, Pagination would resize according to the width of the window",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "show-less-items",
"description": "Show less page items",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "show-quick-jumper",
"description": "Determine whether you can jump to pages directly",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | \\{ goButton?: VueNode \\}"
}
},
{
"name": "show-size-changer",
"description": "Determine whether to show pageSize select",
"value": {
"kind": "expression",
"type": "boolean | SelectProps"
}
},
{
"name": "total-boundary-show-size-changer",
"description": "When total larger than it, showSizeChanger will be true",
"default": "50",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "show-title",
"description": "Show page item's title",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "show-total",
"description": "To display the total number and range",
"value": {
"kind": "expression",
"type": "(total: number, range: [number, number]) => VueNode"
}
},
{
"name": "simple",
"description": "Whether to use simple mode",
"value": {
"kind": "expression",
"type": "boolean | \\{ readOnly?: boolean \\}"
}
},
{
"name": "size",
"description": "Specify the size of Pagination, can be set to small",
"default": "default",
"value": {
"kind": "expression",
"type": "default | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "PaginationStylesType"
}
},
{
"name": "total",
"description": "Total number of data items",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "locale",
"description": "Pagination locale",
"value": {
"kind": "expression",
"type": "PaginationLocale"
}
},
{
"name": "prev-icon",
"description": "Custom previous icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "next-icon",
"description": "Custom next icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "jump-prev-icon",
"description": "Custom jump-prev icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "jump-next-icon",
"description": "Custom jump-next icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "select-component-class",
"description": "Deprecated, not official support",
"value": {
"kind": "expression",
"type": "any"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 页码或 pageSize 改变的回调\n\n(EN) Called when the page number or pageSize is changed",
"arguments": [
{
"name": "payload",
"type": "(page: number, pageSize: number) => void"
}
]
},
{
"name": "showSizeChange",
"description": "(ZH) pageSize 变化的回调\n\n(EN) Called when pageSize is changed",
"arguments": [
{
"name": "payload",
"type": "(current: number, size: number) => void"
}
]
},
{
"name": "update:current",
"description": "(ZH) 更新当前页\n\n(EN) Update current page",
"arguments": [
{
"name": "payload",
"type": "(page: number) => void"
}
]
},
{
"name": "update:pageSize",
"description": "(ZH) 更新每页条数\n\n(EN) Update page size",
"arguments": [
{
"name": "payload",
"type": "(pageSize: number) => void"
}
]
}
]
},
"slots": [
{
"name": "itemRender",
"description": "(ZH) 自定义页码内容\n\n(EN) Customize page item"
},
{
"name": "showTotal",
"description": "(ZH) 自定义总数展示\n\n(EN) Customize total display"
},
{
"name": "prevIcon",
"description": "(ZH) 自定义上一页图标\n\n(EN) Custom previous icon"
},
{
"name": "nextIcon",
"description": "(ZH) 自定义下一页图标\n\n(EN) Custom next icon"
},
{
"name": "jumpPrevIcon",
"description": "(ZH) 自定义向前跳转图标\n\n(EN) Custom jump-prev icon"
},
{
"name": "jumpNextIcon",
"description": "(ZH) 自定义向后跳转图标\n\n(EN) Custom jump-next icon"
}
]
},
{
"name": "a-rate",
"description": "(ZH) 用于对事物进行评分操作。\n\n(EN) Used for rating operation on something.",
"attributes": [
{
"name": "allow-clear",
"description": "Whether to allow clear when click again",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "allow-half",
"description": "Whether to allow semi selection",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "character",
"description": "The custom character of rate",
"value": {
"kind": "expression",
"type": "VueNode | (RateProps) => VueNode"
}
},
{
"name": "class-name",
"description": "The custom class name of rate",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "count",
"description": "Star count",
"default": "5",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "disabled",
"description": "If read only, unable to interact",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "keyboard",
"description": "Support keyboard operation",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "Star size",
"default": "'middle'",
"value": {
"kind": "expression",
"type": "'small' | 'middle' | 'large'"
}
},
{
"name": "style",
"description": "The custom style object of rate",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "tooltips",
"description": "Customize tooltip by each character",
"value": {
"kind": "expression",
"type": "TooltipProps[\\] | string\\[]"
}
},
{
"name": "value",
"description": "The current value, support v-model:value",
"value": {
"kind": "expression",
"type": "number"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 选择时的回调\n\n(EN) Callback when select value",
"arguments": [
{
"name": "payload",
"type": "(value: number) => void"
}
]
},
{
"name": "hoverChange",
"description": "(ZH) 鼠标经过时数值变化的回调\n\n(EN) Callback when hover item",
"arguments": [
{
"name": "payload",
"type": "(value: number) => void"
}
]
},
{
"name": "focus",
"description": "(ZH) 获取焦点时的回调\n\n(EN) Callback when component get focus",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "blur",
"description": "(ZH) 失去焦点时的回调\n\n(EN) Callback when component lose focus",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "keydown",
"description": "(ZH) 按键回调\n\n(EN) Callback when keydown on component",
"arguments": [
{
"name": "payload",
"type": "(e: KeyboardEvent) => void"
}
]
},
{
"name": "mouseleave",
"description": "(ZH) 鼠标离开时的回调\n\n(EN) Callback when mouse leaves the component",
"arguments": [
{
"name": "payload",
"type": "(e: FocusEvent) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-radio/radio-button",
"description": "(ZH) 用于在多个备选项中选中单个状态。\n\n(EN) Used to select a single state from multiple options.",
"attributes": [
{
"name": "checked",
"description": "Specifies whether the radio is selected, support v-model:checked",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "disabled",
"description": "Disable radio",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "value",
"description": "According to value for comparison, to determine whether the selected",
"value": {
"kind": "expression",
"type": "any"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-radio-group",
"description": "(ZH) 用于在多个备选项中选中单个状态。\n\n(EN) Used to select a single state from multiple options.",
"attributes": [
{
"name": "block",
"description": "Option to fit RadioGroup width to its parent width",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "button-style",
"description": "The style type of radio button",
"default": "outline",
"value": {
"kind": "expression",
"type": "outline | solid"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "default-value",
"description": "Default selected value",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "disabled",
"description": "Disable all radio buttons",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "name",
"description": "The name property of all input[type=\"radio\"] children. If not set, it will fallback to a randomly generated name",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "options",
"description": "Set children optional",
"value": {
"kind": "expression",
"type": "string\\[] | number\\[] | Array"
}
},
{
"name": "option-type",
"description": "Set Radio optionType",
"default": "default",
"value": {
"kind": "expression",
"type": "default | button"
}
},
{
"name": "orientation",
"description": "Orientation",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "size",
"description": "The size of radio button style",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "value",
"description": "Used for setting the currently selected value, support v-model:value",
"value": {
"kind": "expression",
"type": "any"
}
},
{
"name": "vertical",
"description": "If true, the Radio group will be vertical. Simultaneously existing with orientation, orientation takes priority",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 选项变化时的回调函数\n\n(EN) The callback function that is triggered when the state changes",
"arguments": [
{
"name": "payload",
"type": "(e: RadioChangeEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "labelRender",
"description": "(ZH) label 渲染插槽\n\n(EN) label render slot"
}
]
},
{
"name": "a-segmented",
"description": "(ZH) 用于展示多个选项并允许用户选择其中单个选项。\n\n(EN) Display multiple options and allow users to select a single option.",
"attributes": [
{
"name": "block",
"description": "Option to fit width to its parent\\'s width",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the Segmented component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "default-value",
"description": "Default selected value",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "disabled",
"description": "Disable all segments",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "options",
"description": "Set children optional",
"default": "[]",
"value": {
"kind": "expression",
"type": "string\\[] | number\\[] | SegmentedItemType\\[]"
}
},
{
"name": "orientation",
"description": "Orientation",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "size",
"description": "The size of the Segmented.",
"default": "middle",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the Segmented component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "vertical",
"description": "Orientation，Simultaneously existing with orientation, orientation takes priority",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "value",
"description": "Currently selected value, support v-model:value",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "shape",
"description": "shape of Segmented",
"default": "default",
"value": {
"kind": "expression",
"type": "default | round"
}
},
{
"name": "name",
"description": "The name property of all input[type=\"radio\"] children. if not set, it will fallback to a randomly generated name",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 选项变化时的回调函数\n\n(EN) The callback function that is triggered when the state changes",
"arguments": [
{
"name": "payload",
"type": "function(value: string | number)"
}
]
}
]
},
"slots": [
{
"name": "iconRender",
"description": "(ZH) icon 渲染插槽\n\n(EN) icon render slot"
},
{
"name": "labelRender",
"description": "(ZH) label 渲染插槽\n\n(EN) label render slot"
}
]
},
{
"name": "a-select",
"description": "(ZH) 下拉选择器。\n\n(EN) A dropdown menu for displaying choices.",
"attributes": [
{
"name": "allow-clear",
"description": "Show clear button",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { clearIcon?: VueNode }"
}
},
{
"name": "auto-clear-search-value",
"description": "Whether the current search will be cleared on selecting an item. Only applies when mode is set to multiple or tags",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "default-active-first-option",
"description": "Whether active first option by default",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Whether disabled select",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "dropdown-class-name",
"description": "The className of dropdown menu, **Deprecated. Use classes.popup.root instead**",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "dropdown-match-select-width",
"description": "Determine whether the dropdown menu and the select input are the same width, **Deprecated. Use popupMatchSelectWidth instead**",
"value": {
"kind": "expression",
"type": "boolean | number"
}
},
{
"name": "dropdown-render",
"description": "Customize dropdown content, **Deprecated. Use popupRender instead**",
"value": {
"kind": "expression",
"type": "(originNode: VueNode) => VueNode"
}
},
{
"name": "dropdown-style",
"description": "The style of dropdown menu, **Deprecated. Use styles.popup.root instead**",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "field-names",
"description": "Customize node label, value, options, groupLabel field name",
"default": "{ label: 'label', value: 'value', options: 'options', groupLabel: 'label' }",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "filter-option",
"description": "If true, filter options by input, if function, filter options against it. The function will receive two arguments, inputValue and option, if the function returns true, the option will be included in the filtered set; Otherwise, it will be excluded",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | (inputValue: string, option?: Option) => boolean"
}
},
{
"name": "filter-sort",
"description": "Sort function for search options sorting, see Array.sort's compareFunction",
"value": {
"kind": "expression",
"type": "(optionA: Option, optionB: Option, info: { searchValue: string }) => number"
}
},
{
"name": "get-popup-container",
"description": "Parent Node which the selector should be rendered to. Default to body. When position issues happen, try to modify it into scrollable content and position it relative",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "label-in-value",
"description": "Whether to embed label in value, turn the format of value from string to { value: string, label: VueNode }",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "list-height",
"description": "Config popup height",
"default": "256",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "loading",
"description": "Indicate loading state",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "max-count",
"description": "The max number of items can be selected, only applies when mode is multiple or tags",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "max-tag-count",
"description": "Max tag count to show. responsive will cost render performance",
"value": {
"kind": "expression",
"type": "number | 'responsive'"
}
},
{
"name": "max-tag-placeholder",
"description": "Placeholder for not showing tags",
"value": {
"kind": "expression",
"type": "VueNode | (omittedValues: LabeledValue[]) => VueNode"
}
},
{
"name": "max-tag-text-length",
"description": "Max tag text length to show",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "menu-item-selected-icon",
"description": "The custom menuItemSelected icon with multiple options",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "mode",
"description": "Set mode of Select",
"value": {
"kind": "expression",
"type": "'multiple' | 'tags'"
}
},
{
"name": "not-found-content",
"description": "Specify content to show when no result matches",
"default": "Not Found",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "open",
"description": "Controlled open state of dropdown",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "option-filter-prop",
"description": "Which prop value of option will be used for filter if filterOption is true. If options is set, it should be set to label. When a string[] is provided, multiple fields are searched using OR matching",
"default": "value",
"value": {
"kind": "expression",
"type": "string | string[]"
}
},
{
"name": "options",
"description": "Select options. Will get better perf than jsx definition",
"value": {
"kind": "expression",
"type": "{ label: VueNode; value: string }[]"
}
},
{
"name": "option-render",
"description": "Customize the rendering dropdown options",
"value": {
"kind": "expression",
"type": "(option: FlattenOptionData, info: { index: number }) => VueNode"
}
},
{
"name": "placeholder",
"description": "The placeholder of select",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "placement",
"description": "The position where the selection box pops up",
"default": "bottomLeft",
"value": {
"kind": "expression",
"type": "bottomLeft bottomRight topLeft topRight"
}
},
{
"name": "popup-class-name",
"description": "The className of dropdown menu, use classes.popup.root instead",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "popup-match-select-width",
"description": "Determine whether the dropdown menu and the select input are the same width. Default set min-width same as input. Will ignore when value less than select width. false will disable virtual scroll",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | number"
}
},
{
"name": "popup-render",
"description": "Customize dropdown content",
"value": {
"kind": "expression",
"type": "(originNode: VueNode) => VueNode"
}
},
{
"name": "prefix",
"description": "The custom prefix",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "remove-icon",
"description": "The custom remove icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "search-value",
"description": "The current input \"search\" text",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "show-search",
"description": "Whether select is searchable",
"default": "single: false, multiple: true",
"value": {
"kind": "expression",
"type": "boolean | Object"
}
},
{
"name": "size",
"description": "Size of Select input",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "'error' | 'warning'"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "suffix-icon",
"description": "The custom suffix icon. Customize icon will not response click open to avoid icon designed to do other interactive. You can use pointer-events: none style to bypass",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "tag-render",
"description": "Customize tag render, only applies when mode is set to multiple or tags",
"value": {
"kind": "expression",
"type": "(props) => VueNode"
}
},
{
"name": "label-render",
"description": "Customize selected label render",
"value": {
"kind": "expression",
"type": "(props: LabelInValueType) => VueNode"
}
},
{
"name": "token-separators",
"description": "Separator used to tokenize, only applies when mode=\"tags\"",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "value",
"description": "Current selected option (considered as a immutable array), support v-model:value",
"value": {
"kind": "expression",
"type": "string | string[] | number | number[]"
}
},
{
"name": "variant",
"description": "Variants of selector",
"default": "outlined",
"value": {
"kind": "expression",
"type": "outlined | borderless | filled | underlined"
}
},
{
"name": "virtual",
"description": "Disable virtual scroll when set to false",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "active",
"description": "(ZH) 键盘和鼠标交互时触发\n\n(EN) Called when keyboard or mouse interaction occurs",
"arguments": [
{
"name": "payload",
"type": "(value: string | number) => void"
}
]
},
{
"name": "blur",
"description": "(ZH) 失去焦点时回调\n\n(EN) Called when blur",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent) => void"
}
]
},
{
"name": "change",
"description": "(ZH) 选中 option，或 input 的 value 变化时，调用此函数\n\n(EN) Called when select an option or input value change",
"arguments": [
{
"name": "payload",
"type": "(value, option: Option | Array) => void"
}
]
},
{
"name": "clear",
"description": "(ZH) 清除内容时回调\n\n(EN) Called when clear",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
},
{
"name": "deselect",
"description": "(ZH) 取消选中时调用，参数为选中项的 value (或 key) 值，仅在 multiple 或 tags 模式下生效\n\n(EN) Called when an option is deselected, param is the selected option's value. Only called for multiple or tags, effective in multiple or tags mode only",
"arguments": [
{
"name": "payload",
"type": "(value: string | number) => void"
}
]
},
{
"name": "dropdownVisibleChange",
"description": "(ZH) 展开下拉菜单的回调，**已废弃，请使用 openChange 替换**\n\n(EN) Called when dropdown open, **Deprecated. Use openChange instead**",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "focus",
"description": "(ZH) 获得焦点时回调\n\n(EN) Called when focus",
"arguments": [
{
"name": "payload",
"type": "(event: FocusEvent) => void"
}
]
},
{
"name": "inputKeydown",
"description": "(ZH) 按键按下时回调\n\n(EN) Called when key pressed",
"arguments": [
{
"name": "payload",
"type": "(event: KeyboardEvent) => void"
}
]
},
{
"name": "openChange",
"description": "(ZH) 下拉框展开或收起时回调\n\n(EN) Called when dropdown open",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "popupScroll",
"description": "(ZH) 下拉列表滚动时的回调\n\n(EN) Called when dropdown scrolls",
"arguments": [
{
"name": "payload",
"type": "(event: UIEvent) => void"
}
]
},
{
"name": "search",
"description": "(ZH) 文本框值变化时回调\n\n(EN) Callback function that is fired when input changed",
"arguments": [
{
"name": "payload",
"type": "(value: string) => void"
}
]
},
{
"name": "select",
"description": "(ZH) 被选中时调用，参数为选中项的 value (或 key) 值\n\n(EN) Called when an option is selected, the params are option's value (or key) and option instance",
"arguments": [
{
"name": "payload",
"type": "(value: string | number, option: Option) => void"
}
]
}
]
},
"slots": [
{
"name": "labelRender",
"description": "(ZH) 自定义当前选中的 label 内容 render\n\n(EN) Customize selected label render"
},
{
"name": "maxTagPlaceholder",
"description": "(ZH) 隐藏 tag 时显示的内容\n\n(EN) Placeholder for not showing tags"
},
{
"name": "menuItemSelectedIcon",
"description": "(ZH) 自定义多选时当前选中的条目图标\n\n(EN) The custom menuItemSelected icon with multiple options"
},
{
"name": "notFoundContent",
"description": "(ZH) 当下拉列表为空时显示的内容\n\n(EN) Specify content to show when no result matches"
},
{
"name": "optionRender",
"description": "(ZH) 自定义渲染下拉选项\n\n(EN) Customize the rendering dropdown options"
},
{
"name": "popupRender",
"description": "(ZH) 自定义下拉框内容\n\n(EN) Customize dropdown content"
},
{
"name": "prefix",
"description": "(ZH) 自定义前缀\n\n(EN) The custom prefix"
},
{
"name": "removeIcon",
"description": "(ZH) 自定义的多选框清除图标\n\n(EN) The custom remove icon"
},
{
"name": "suffixIcon",
"description": "(ZH) 自定义的选择框后缀图标。以防止图标被用于其他交互，替换的图标默认不会响应展开、收缩事件，可以通过添加 pointer-events: none 样式透传\n\n(EN) The custom suffix icon. Customize icon will not response click open to avoid icon designed to do other interactive. You can use pointer-events: none style to bypass"
},
{
"name": "tagRender",
"description": "(ZH) 自定义 tag 内容 render，仅在 mode 为 multiple 或 tags 时生效\n\n(EN) Customize tag render, only applies when mode is set to multiple or tags"
}
]
},
{
"name": "a-space",
"description": "(ZH) 设置组件之间的间距。\n\n(EN) Set components spacing.",
"attributes": [
{
"name": "align",
"description": "Align items",
"value": {
"kind": "expression",
"type": "start | end | center | baseline"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "orientation",
"description": "The space direction",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "vertical | horizontal"
}
},
{
"name": "separator",
"description": "Set separator",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "size",
"description": "The space size",
"default": "small",
"value": {
"kind": "expression",
"type": "Size | [Size, Size]"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "vertical",
"description": "Orientation, Simultaneously configure with orientation and prioritize orientation",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "wrap",
"description": "Auto wrap line, when horizontal effective",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "separator",
"description": "(ZH) 设置分隔符\n\n(EN) Set separator"
}
]
},
{
"name": "a-size",
"description": "(ZH) 设置组件之间的间距。\n\n(EN) Set components spacing.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-space-compact",
"description": "(ZH) 设置组件之间的间距。\n\n(EN) Set components spacing.",
"attributes": [
{
"name": "block",
"description": "Option to fit width to its parent's width",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "orientation",
"description": "Set direction of layout",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "vertical | horizontal"
}
},
{
"name": "size",
"description": "Set child component size",
"default": "middle",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "vertical",
"description": "Orientation, Simultaneously configure with orientation and prioritize orientation",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-slider",
"description": "(ZH) 滑动型输入器，展示当前值和可选范围。\n\n(EN) A Slider component for displaying current value and intervals in range.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "default-value",
"description": "The default value of the slider. When range is false, use number, otherwise, use [number, number]",
"default": "0 | [0, 0]",
"value": {
"kind": "expression",
"type": "number | [number, number]"
}
},
{
"name": "disabled",
"description": "If true, the slider will not be interactive",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "dots",
"description": "Whether the thumb can only be dragged to tick marks",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "included",
"description": "Takes effect when marks is not null. True means containment and false means coordinative",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "keyboard",
"description": "Support using keyboard to move handlers",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "marks",
"description": "Tick marks of Slider. The type of key must be number, and must be in closed interval [min, max]. Each mark can declare its own style",
"default": "{ number: VueNode } | { number: { style: CSSProperties, label: VueNode } }",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "max",
"description": "The maximum value the slider can slide to",
"default": "100",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "min",
"description": "The minimum value the slider can slide to",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "orientation",
"description": "Orientation direction",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "range",
"description": "Enable dual thumb mode for range selection",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | RangeConfig"
}
},
{
"name": "reverse",
"description": "Reverse the component",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "step",
"description": "The granularity the slider can step through values. Must be greater than 0, and be divisible by (max - min). When step is null and marks exist, valid points will only be marks, min and max",
"default": "1",
"value": {
"kind": "expression",
"type": "number | null"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "tooltip",
"description": "The tooltip related props",
"value": {
"kind": "expression",
"type": "TooltipConfig"
}
},
{
"name": "value",
"description": "The value of slider. When range is false, use number, otherwise, use [number, number], support v-model:value",
"value": {
"kind": "expression",
"type": "number | [number, number]"
}
},
{
"name": "vertical",
"description": "If true, the slider will be vertical. Simultaneously existing with orientation, orientation takes priority",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 当 Slider 的值发生改变时，会触发 change 事件，并把改变后的值作为参数传入\n\n(EN) Callback function that is fired when the user changes the slider's value",
"arguments": [
{
"name": "payload",
"type": "(value: number | [number, number]) => void"
}
]
},
{
"name": "changeComplete",
"description": "(ZH) 与 mouseup 和 keyup 触发时机一致，把当前值作为参数传入\n\n(EN) Fire when mouseup or keyup is fired",
"arguments": [
{
"name": "payload",
"type": "(value: number | [number, number]) => void"
}
]
}
]
},
"slots": [
{
"name": "mark",
"description": "(ZH) 自定义刻度内容\n\n(EN) Custom mark content"
}
]
},
{
"name": "a-spin",
"description": "(ZH) 用于页面和区块的加载中状态。\n\n(EN) Used for the loading status of a page or a block.",
"attributes": [
{
"name": "spinning",
"description": "Whether Spin is visible",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "The size of Spin, options: small, default and large",
"default": "default",
"value": {
"kind": "expression",
"type": "SpinSize"
}
},
{
"name": "~~tip~~",
"description": "deprecated, use descriptionCustomize description content when Spin has children",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "description",
"description": "Customize description content",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "delay",
"description": "Specifies a delay in milliseconds for loading state (prevent flush)",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "wrapper-class-name",
"description": "The className of wrapper when Spin has children",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "indicator",
"description": "The node of the spinning indicator",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "fullscreen",
"description": "Display a backdrop with the Spin component",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "percent",
"description": "The progress percentage, when set to auto, it will be an indeterminate progress",
"value": {
"kind": "expression",
"type": "number | 'auto'"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "SpinClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "SpinStylesType"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "default",
"description": "(ZH) 包裹内容\n\n(EN) Content to wrap with Spin"
},
{
"name": "indicator",
"description": "(ZH) 加载指示符\n\n(EN) The node of the spinning indicator"
},
{
"name": "~~tip~~",
"description": "(ZH) 已弃用，请使用description当作为包裹元素时，可以自定义描述文案\n\n(EN) deprecated, use descriptionCustomize description content when Spin has children"
},
{
"name": "description",
"description": "(ZH) 可以自定义描述文案\n\n(EN) Customize description content"
}
]
},
{
"name": "a-splitter",
"description": "(ZH) 分割面板用于隔离内容。\n\n(EN) Split panels to isolate content.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "collapsible-icon",
"description": "Custom collapsible icon",
"value": {
"kind": "expression",
"type": "{ start?: VueNode; end?: VueNode }"
}
},
{
"name": "dragger-icon",
"description": "Custom dragger icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "lazy",
"description": "Lazy rendering mode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "orientation",
"description": "Layout direction",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "vertical | horizontal"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "vertical",
"description": "Orientation, Simultaneously existing with orientation, orientation takes priority",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "collapse",
"description": "(ZH) 展开-收起时回调\n\n(EN) Callback when expanding or collapsing",
"arguments": [
{
"name": "payload",
"type": "(collapsed: boolean[], sizes: number[]) => void"
}
]
},
{
"name": "resize",
"description": "(ZH) 面板大小变化回调\n\n(EN) Panel size change callback",
"arguments": [
{
"name": "payload",
"type": "(sizes: number[]) => void"
}
]
},
{
"name": "resizeEnd",
"description": "(ZH) 拖拽结束回调\n\n(EN) Drag end callback",
"arguments": [
{
"name": "payload",
"type": "(sizes: number[]) => void"
}
]
},
{
"name": "resizeStart",
"description": "(ZH) 开始拖拽之前回调\n\n(EN) Callback before dragging starts",
"arguments": [
{
"name": "payload",
"type": "(sizes: number[]) => void"
}
]
}
]
},
"slots": [
{
"name": "collapsibleIconEnd",
"description": "(ZH) 自定义折叠结束图标\n\n(EN) Custom collapsible end icon"
},
{
"name": "collapsibleIconStart",
"description": "(ZH) 自定义折叠开始图标\n\n(EN) Custom collapsible start icon"
},
{
"name": "draggerIcon",
"description": "(ZH) 自定义拖拽图标\n\n(EN) Custom dragger icon"
}
]
},
{
"name": "a-splitter-panel",
"description": "(ZH) 分割面板用于隔离内容。\n\n(EN) Split panels to isolate content.",
"attributes": [
{
"name": "collapsible",
"description": "Enable collapsible",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { start?: boolean; end?: boolean; showCollapsibleIcon?: boolean | 'auto' }"
}
},
{
"name": "default-size",
"description": "Initial panel size, supports px and percentage",
"value": {
"kind": "expression",
"type": "number | string"
}
},
{
"name": "max",
"description": "Maximum threshold, supports px and percentage",
"value": {
"kind": "expression",
"type": "number | string"
}
},
{
"name": "min",
"description": "Minimum threshold, supports px and percentage",
"value": {
"kind": "expression",
"type": "number | string"
}
},
{
"name": "resizable",
"description": "Whether to enable resize",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "Controlled panel size, supports px and percentage",
"value": {
"kind": "expression",
"type": "number | string"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-statistic",
"description": "(ZH) 展示统计数值。\n\n(EN) Display statistic number.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the Statistic component. Supports object or function",
"value": {
"kind": "expression",
"type": "StatisticClassNamesType"
}
},
{
"name": "decimal-separator",
"description": "The decimal separator",
"default": ".",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "formatter",
"description": "Customize value display logic",
"value": {
"kind": "expression",
"type": "(value: number | string) => VueNode"
}
},
{
"name": "group-separator",
"description": "Group separator",
"default": ",",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "loading",
"description": "Loading status of Statistic",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "precision",
"description": "The precision of input value",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "prefix",
"description": "The prefix node of value",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the Statistic component. Supports object or function",
"value": {
"kind": "expression",
"type": "StatisticStylesType"
}
},
{
"name": "suffix",
"description": "The suffix node of value",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title",
"description": "Display title",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "value",
"description": "Display value",
"value": {
"kind": "expression",
"type": "string | number"
}
},
{
"name": "value-style",
"description": "Set value section style",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "formatter",
"description": "(ZH) 自定义数值展示\n\n(EN) Customize value display logic"
},
{
"name": "prefix",
"description": "(ZH) 设置数值的前缀\n\n(EN) The prefix node of value"
},
{
"name": "suffix",
"description": "(ZH) 设置数值的后缀\n\n(EN) The suffix node of value"
},
{
"name": "title",
"description": "(ZH) 数值的标题\n\n(EN) Display title"
}
]
},
{
"name": "a-statistic-timer",
"description": "(ZH) 展示统计数值。\n\n(EN) Display statistic number.",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 倒计时时间变化时触发\n\n(EN) Trigger when time's changing",
"arguments": [
{
"name": "payload",
"type": "(value: number) => void"
}
]
},
{
"name": "finish",
"description": "(ZH) 倒计时完成时触发，指定为 countup 此属性不生效\n\n(EN) Trigger when time's up, only to be called when type is countdown",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": [
{
"name": "prefix",
"description": "(ZH) 设置数值的前缀\n\n(EN) The prefix node of value"
},
{
"name": "suffix",
"description": "(ZH) 设置数值的后缀\n\n(EN) The suffix node of value"
},
{
"name": "title",
"description": "(ZH) 数值的标题\n\n(EN) Display title"
}
]
},
{
"name": "a-steps",
"description": "(ZH) 引导用户按照流程完成任务的导航条。\n\n(EN) A navigation bar that guides users through the steps of a task.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "StepsClassNamesType"
}
},
{
"name": "current",
"description": "To set the current step, counting from 0. You can overwrite this state by using status of Step, support v-model:current",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "icon-render",
"description": "Custom render icon, please use items.icon first",
"value": {
"kind": "expression",
"type": "(oriNode, info: { index, active, item }) => VueNode"
}
},
{
"name": "initial",
"description": "Set the initial step, counting from 0",
"default": "0",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "items",
"description": "StepItem content",
"default": "[]",
"value": {
"kind": "expression",
"type": "StepItem[]"
}
},
{
"name": "orientation",
"description": "To specify the orientation of the step bar, horizontal or vertical",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "percent",
"description": "Progress circle percentage of current step in process status (only works on basic Steps)",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "progress-dot",
"description": "Steps with progress dot style, customize the progress dot by setting it to a function. titlePlacement will be vertical",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | (iconDot, { index, status, title, content }) => VueNode"
}
},
{
"name": "responsive",
"description": "Change to vertical direction when screen width smaller than 532px",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "To specify the size of the step bar, default and small are currently supported",
"default": "default",
"value": {
"kind": "expression",
"type": "default | small"
}
},
{
"name": "status",
"description": "To specify the status of current step, can be set to one of the following values: wait process finish error",
"default": "process",
"value": {
"kind": "expression",
"type": "wait | process | finish | error"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "StepsStylesType"
}
},
{
"name": "title-placement",
"description": "Place title and content with horizontal or vertical direction",
"default": "horizontal",
"value": {
"kind": "expression",
"type": "horizontal | vertical"
}
},
{
"name": "type",
"description": "Type of steps, can be set to one of the following values: default dot inline navigation panel",
"default": "default",
"value": {
"kind": "expression",
"type": "default | dot | inline | navigation | panel"
}
},
{
"name": "variant",
"description": "Config style variant",
"default": "filled",
"value": {
"kind": "expression",
"type": "filled | outlined"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "Trigger when Step is changed",
"arguments": [
{
"name": "payload",
"type": "(current: number) => void"
}
]
}
]
},
"slots": [
{
"name": "iconRender",
"description": "Custom render icon, please use items.icon first"
},
{
"name": "progressDot",
"description": "Custom progress dot"
}
]
},
{
"name": "a-skeleton",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "avatar",
"description": "Show avatar placeholder",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | SkeletonAvatarProps"
}
},
{
"name": "loading",
"description": "Display the skeleton when true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "paragraph",
"description": "Show paragraph placeholder",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | SkeletonParagraphProps"
}
},
{
"name": "round",
"description": "Show paragraph and title radius when true",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "title",
"description": "Show title placeholder",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | SkeletonTitleProps"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-avatar",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "shape",
"description": "Set the shape of avatar",
"default": "circle",
"value": {
"kind": "expression",
"type": "circle | square"
}
},
{
"name": "size",
"description": "Set the size of avatar",
"default": "medium",
"value": {
"kind": "expression",
"type": "number | large | medium | small"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-title",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "width",
"description": "Set the width of title",
"value": {
"kind": "expression",
"type": "number | string"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-paragraph",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "rows",
"description": "Set the row count of paragraph",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "width",
"description": "Set the width of paragraph. When width is an Array, it can set the width of each row. Otherwise only set the last row width",
"value": {
"kind": "expression",
"type": "number | string | Array"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-button",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "block",
"description": "Option to fit button width to its parent width",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "shape",
"description": "Set the shape of button",
"value": {
"kind": "expression",
"type": "circle | round | square | default"
}
},
{
"name": "size",
"description": "Set the size of button",
"default": "medium",
"value": {
"kind": "expression",
"type": "large | medium | small"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-input",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "Set the size of input",
"default": "medium",
"value": {
"kind": "expression",
"type": "large | medium | small"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-image",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-skeleton-node",
"description": "(ZH) 在需要等待加载内容的位置提供一个占位图形组合。\n\n(EN) Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.",
"attributes": [
{
"name": "active",
"description": "Show animation effect",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component",
"value": {
"kind": "expression",
"type": "SkeletonStylesType"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-switch",
"description": "(ZH) 使用开关切换两种状态之间。\n\n(EN) Used to toggle between two states.",
"attributes": [
{
"name": "auto-focus",
"description": "Auto focus when component mounted",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "checked",
"description": "Determine whether the Switch is checked, support v-model:checked",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "checked-children",
"description": "The content to be shown when the state is checked",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "checked-value",
"description": "The value when checked",
"default": "true",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "SwitchClassNamesType"
}
},
{
"name": "default-checked",
"description": "Whether to set the initial state",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "default-value",
"description": "Alias for defaultChecked",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "disabled",
"description": "Disable switch",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "loading",
"description": "Loading state of switch",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "size",
"description": "The size of the Switch, options: default small",
"default": "default",
"value": {
"kind": "expression",
"type": "default | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "SwitchStylesType"
}
},
{
"name": "un-checked-children",
"description": "The content to be shown when the state is unchecked",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "un-checked-value",
"description": "The value when unchecked",
"default": "false",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
},
{
"name": "value",
"description": "Alias for checked, support v-model:value",
"value": {
"kind": "expression",
"type": "string | number | boolean | object"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 变化时的回调函数\n\n(EN) Trigger when the checked state is changing",
"arguments": [
{
"name": "payload",
"type": "(checked: boolean, event: Event) => void"
}
]
},
{
"name": "click",
"description": "(ZH) 点击时的回调函数\n\n(EN) Trigger when clicked",
"arguments": [
{
"name": "payload",
"type": "(checked: boolean, event: Event) => void"
}
]
}
]
},
"slots": [
{
"name": "checkedChildren",
"description": "(ZH) 选中时的内容\n\n(EN) The content to be shown when the state is checked"
},
{
"name": "unCheckedChildren",
"description": "(ZH) 非选中时的内容\n\n(EN) The content to be shown when the state is unchecked"
}
]
},
{
"name": "a-table",
"description": "(ZH) 展示行列数据。\n\n(EN) A table displays rows of data.",
"attributes": [
{
"name": "bordered",
"description": "Whether to show all table borders",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record\\ | (info: \\{ props \\})=> Record\\"
}
},
{
"name": "columns",
"description": "Columns of table",
"value": {
"kind": "expression",
"type": "ColumnsType\\[\\]"
}
},
{
"name": "data-source",
"description": "Data record array to be displayed",
"value": {
"kind": "expression",
"type": "object[]"
}
},
{
"name": "expandable",
"description": "Config expandable content",
"value": {
"kind": "expression",
"type": "expandable"
}
},
{
"name": "get-popup-container",
"description": "The render container of dropdowns in table",
"default": "() => TableHtmlElement",
"value": {
"kind": "expression",
"type": "(triggerNode) => HTMLElement"
}
},
{
"name": "loading",
"description": "Loading status of table",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | Spin Props"
}
},
{
"name": "locale",
"description": "The i18n text including filter, sort, empty text, etc",
"default": "默认值",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "pagination",
"description": "Config of pagination. You can ref table pagination config or full pagination document, hide it by setting it to false",
"value": {
"kind": "expression",
"type": "false | TablePaginationConfig"
}
},
{
"name": "row-class-name",
"description": "Row's className",
"value": {
"kind": "expression",
"type": "function(record, index): string"
}
},
{
"name": "row-key",
"description": "Row's unique key, could be a string or function that returns a string",
"default": "key",
"value": {
"kind": "expression",
"type": "string | function(record): string"
}
},
{
"name": "row-selection",
"description": "Row selection config",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "row-hoverable",
"description": "Row hover",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "scroll",
"description": "Whether the table can be scrollable, config",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "show-header",
"description": "Whether to show table header",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "show-sorter-tooltip",
"description": "The header show next sorter direction tooltip. It will be set as the property of Tooltip if its type is object",
"default": "\\{ target: 'full-header' \\}",
"value": {
"kind": "expression",
"type": "boolean | Tooltip props & {target?: 'full-header' | 'sorter-icon' }"
}
},
{
"name": "size",
"description": "Size of table",
"default": "large",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "sort-directions",
"description": "Supported sort way, could be ascend, descend",
"default": "\\[ascend, descend]",
"value": {
"kind": "expression",
"type": "Array"
}
},
{
"name": "sticky",
"description": "Set sticky header and scroll bar",
"value": {
"kind": "expression",
"type": "boolean | {offsetHeader?: number, offsetScroll?: number, getContainer?: () => HTMLElement}"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record\\ | (info: \\{ props \\})=> Record\\"
}
},
{
"name": "table-layout",
"description": "The table-layout attribute of table element",
"default": "-fixed when header/columns are fixed, or using column.ellipsis",
"value": {
"kind": "expression",
"type": "- | auto | fixed"
}
},
{
"name": "dropdown-prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "virtual",
"description": "Support virtual list",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 分页、排序、筛选变化时触发\n\n(EN) Callback executed when pagination, filters or sorter is changed",
"arguments": [
{
"name": "payload",
"type": "( pagination: TablePaginationConfig, filters: Record, sorter: SorterResult | SorterResult[], extra: TableCurrentDataSource, ) => void"
}
]
},
{
"name": "update:expandedRowKeys",
"description": "(ZH) -\n\n(EN) -",
"arguments": [
{
"name": "payload",
"type": "(keys: readonly Key[]) => void"
}
]
},
{
"name": "scroll",
"description": "(ZH) 表格是否可滚动，也可以指定滚动区域的宽、高，配置项\n\n(EN) Whether the table can be scrollable, config",
"arguments": [
{
"name": "payload",
"type": "NonNullable"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 表格标题\n\n(EN) Table title renderer"
},
{
"name": "footer",
"description": "(ZH) 表格尾部\n\n(EN) Table footer renderer"
},
{
"name": "summary",
"description": "(ZH) 总结栏\n\n(EN) Summary content"
},
{
"name": "emptyText",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "expandIcon",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "expandedRowRender",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "headerCell",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "bodyCell",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "filterDropdown",
"description": "(ZH) -\n\n(EN) -"
},
{
"name": "filterIcon",
"description": "(ZH) -\n\n(EN) -"
}
]
},
{
"name": "a-tag",
"description": "(ZH) 进行标记和分类的小标签。\n\n(EN) Used for marking and categorization.",
"attributes": [
{
"name": "closable",
"description": "Whether the Tag can be closed",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "close-icon",
"description": "Custom close icon. Setting to null or false hides the close button",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "color",
"description": "Color of the Tag",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TagClassNamesType"
}
},
{
"name": "disabled",
"description": "Whether the tag is disabled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "href",
"description": "The address to jump when clicking, when specified the tag will be rendered as tag",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "icon",
"description": "Set the icon of tag",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TagStylesType"
}
},
{
"name": "target",
"description": "Same as target attribute of , works when href is specified",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "variant",
"description": "Variant of the tag",
"default": "filled",
"value": {
"kind": "expression",
"type": "filled | solid | outlined"
}
}
],
"js": {
"events": [
{
"name": "close",
"description": "(ZH) 关闭时的回调（可通过 e.preventDefault() 来阻止默认行为）\n\n(EN) Callback executed when tag is closed (can be prevented by e.preventDefault())",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "closeIcon",
"description": "(ZH) 自定义关闭按钮。设置为 null 或 false 时隐藏关闭按钮\n\n(EN) Custom close icon. Setting to null or false hides the close button"
},
{
"name": "icon",
"description": "(ZH) 设置图标\n\n(EN) Set the icon of tag"
}
]
},
{
"name": "a-checkable-tag",
"description": "Used for marking and categorization.",
"attributes": [
{
"name": "checked",
"description": "Checked status of Tag. This is a controlled component",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "Set the icon of tag",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "Callback executed when Tag is checked/unchecked",
"arguments": [
{
"name": "payload",
"type": "(checked: boolean) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-checkable-tag-group",
"description": "Used for marking and categorization.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "default-value",
"description": "Initial value",
"value": {
"kind": "expression",
"type": "string | number | Array | null"
}
},
{
"name": "disabled",
"description": "Disable check/uncheck",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "multiple",
"description": "Multiple select mode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "options",
"description": "Option list",
"value": {
"kind": "expression",
"type": "Array"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "value",
"description": "Value of checked tag(s), support v-model:value",
"value": {
"kind": "expression",
"type": "string | number | Array | null"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "Callback when Tag is checked/unchecked",
"arguments": [
{
"name": "payload",
"type": "(value: string | number | Array | null) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-tag-checkable-tag",
"description": "进行标记和分类的小标签。",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "点击标签时触发的回调",
"arguments": [
{
"name": "payload",
"type": "(checked: boolean) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-tag-checkable-tag-group",
"description": "进行标记和分类的小标签。",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "点击标签时触发的回调",
"arguments": [
{
"name": "payload",
"type": "(value: string | number | Array | null) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-time-picker",
"description": "(ZH) 输入或选择时间的控件。\n\n(EN) To select/input a time.",
"attributes": [],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-timeline",
"description": "(ZH) 垂直展示的时间流信息。\n\n(EN) Vertical display timeline.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "items",
"description": "Each node of timeline",
"value": {
"kind": "expression",
"type": "TimelineItemProps[]"
}
},
{
"name": "mode",
"description": "By sending alternate the timeline will distribute the nodes to the left and right",
"value": {
"kind": "expression",
"type": "left | alternate | right"
}
},
{
"name": "pending",
"description": "Set the last ghost node's existence or its content. Use item.loading instead",
"default": "false",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "pending-dot",
"description": "Set the dot of the last ghost node when pending is true. Use item.icon instead",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "reverse",
"description": "Whether reverse nodes or not",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record"
}
},
{
"name": "dot-render",
"description": "Custom rendering function for timeline dot",
"value": {
"kind": "expression",
"type": "(params: { item: TimelineItemProps, index: number }) => VueNode"
}
},
{
"name": "label-render",
"description": "Custom rendering function for timeline label",
"value": {
"kind": "expression",
"type": "(params: { item: TimelineItemProps, index: number }) => VueNode"
}
},
{
"name": "content-render",
"description": "Custom rendering function for timeline content",
"value": {
"kind": "expression",
"type": "(params: { item: TimelineItemProps, index: number }) => VueNode"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "pending",
"description": "(ZH) 指定最后一个幽灵节点是否存在或内容\n\n(EN) Set the last ghost node's existence or its content"
},
{
"name": "pendingDot",
"description": "(ZH) 当最后一个幽灵节点存在时，指定其时间图点\n\n(EN) Set the dot of the last ghost node when pending is true"
},
{
"name": "dotRender",
"description": "(ZH) 自定义时间轴点渲染函数\n\n(EN) Custom rendering function for timeline dot"
},
{
"name": "labelRender",
"description": "(ZH) 自定义时间轴标签渲染函数\n\n(EN) Custom rendering function for timeline label"
},
{
"name": "contentRender",
"description": "(ZH) 自定义时间轴内容渲染函数\n\n(EN) Custom rendering function for timeline content"
}
]
},
{
"name": "a-tooltip",
"description": "(ZH) 简单的文字提示气泡框。\n\n(EN) Simple text popup box.",
"attributes": [
{
"name": "align",
"description": "Popup alignment config",
"value": {
"kind": "expression",
"type": "AlignType"
}
},
{
"name": "arrow",
"description": "Show, hide or keep arrow in the center",
"value": {
"kind": "expression",
"type": "boolean | { pointAtCenter?: boolean }"
}
},
{
"name": "auto-adjust-overflow",
"description": "Auto adjust placement when tooltip is invisible",
"value": {
"kind": "expression",
"type": "boolean | AdjustOverflow"
}
},
{
"name": "color",
"description": "The background color. After using this attribute, the internal text color will adapt automatically",
"value": {
"kind": "expression",
"type": "LiteralUnion"
}
},
{
"name": "open",
"description": "Whether tooltip is visible",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "default-open",
"description": "Initial open state",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "get-popup-container",
"description": "Specify container for tooltip",
"value": {
"kind": "expression",
"type": "(triggerNode: HTMLElement) => HTMLElement"
}
},
{
"name": "destroy-on-hidden",
"description": "Destroy tooltip when hidden",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "z-index",
"description": "Set z-index of tooltip",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "placement",
"description": "Tooltip placement",
"default": "top",
"value": {
"kind": "expression",
"type": "TooltipPlacement"
}
},
{
"name": "trigger",
"description": "Trigger action",
"value": {
"kind": "expression",
"type": "ActionType | ActionType[]"
}
},
{
"name": "fresh",
"description": "Update content even when tooltip is hidden",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mouse-enter-delay",
"description": "Delay in seconds before showing tooltip",
"default": "0.1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "mouse-leave-delay",
"description": "Delay in seconds before hiding tooltip",
"default": "0.1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "classes",
"description": "Semantic DOM class. Supports object or function",
"value": {
"kind": "expression",
"type": "TooltipClassNamesType"
}
},
{
"name": "styles",
"description": "Semantic DOM style. Supports object or function",
"value": {
"kind": "expression",
"type": "TooltipStylesType"
}
},
{
"name": "get-tooltip-container",
"description": "Legacy alias of getPopupContainer",
"value": {
"kind": "expression",
"type": "(node: HTMLElement) => HTMLElement"
}
},
{
"name": "motion",
"description": "Popup motion config",
"value": {
"kind": "expression",
"type": "VcTooltipProps['motion']"
}
},
{
"name": "after-open-change",
"description": "Callback after visibility change",
"value": {
"kind": "expression",
"type": "(open: boolean) => void"
}
},
{
"name": "builtin-placements",
"description": "Built-in placement config",
"value": {
"kind": "expression",
"type": "typeof Placements"
}
},
{
"name": "title",
"description": "The text shown in the tooltip",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "overlay",
"description": "Legacy alias of title",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "open-class",
"description": "Class added to child when tooltip is open",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "unique",
"description": "Enable unique display inside AUniqueProvider/ConfigProvider",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "openChange",
"description": "(ZH) 显隐变化时回调\n\n(EN) Callback when tooltip visibility changes",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "update:open",
"description": "(ZH) 显隐变化时触发\n\n(EN) Emit when tooltip visibility changes",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
}
]
},
"slots": [
{
"name": "title",
"description": "(ZH) 提示文字\n\n(EN) The text shown in the tooltip"
}
]
},
{
"name": "a-tour",
"description": "(ZH) 用于分步引导用户了解产品功能的气泡组件。\n\n(EN) A popup component for guiding users through a product.",
"attributes": [
{
"name": "steps",
"description": "Tour steps",
"value": {
"kind": "expression",
"type": "TourStepItem[\\]"
}
},
{
"name": "open",
"description": "Open tour, support v-model:open",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "current",
"description": "What is the current step",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "arrow",
"description": "Whether to show the arrow, including the configuration whether to point to the center of the element",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | { pointAtCenter: boolean }"
}
},
{
"name": "close-icon",
"description": "Customize close icon",
"default": "true",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "disabled-interaction",
"description": "Disable interaction on highlighted area",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "gap",
"description": "Control the radius of the highlighted area and the offset between highlighted area and the element",
"default": "{ offset: 6, radius: 2 }",
"value": {
"kind": "expression",
"type": "{ offset?: number | [number, number]; radius?: number }"
}
},
{
"name": "placement",
"description": "Position of the guide card relative to the target element",
"default": "bottom",
"value": {
"kind": "expression",
"type": "center left leftTop leftBottom right rightTop rightBottom top topLeft topRight bottom bottomLeft bottomRight"
}
},
{
"name": "mask",
"description": "Whether to enable masking, change mask style and fill color by pass custom props",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | { style?: CSSProperties; color?: string }"
}
},
{
"name": "type",
"description": "Type, affects the background color and text color",
"default": "default",
"value": {
"kind": "expression",
"type": "'default' | 'primary'"
}
},
{
"name": "scroll-into-view-options",
"description": "support pass custom scrollIntoView options",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | ScrollIntoViewOptions"
}
},
{
"name": "indicators-render",
"description": "Custom indicator",
"value": {
"kind": "expression",
"type": "(current: number, total: number) => VueNode"
}
},
{
"name": "actions-render",
"description": "Custom action",
"value": {
"kind": "expression",
"type": "(originNode: VueNode, info: { current: number, total: number }) => VueNode"
}
},
{
"name": "z-index",
"description": "Tour zIndex",
"default": "1001",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "get-popup-container",
"description": "Set the rendering node of Tour floating layer",
"default": "() => document.body",
"value": {
"kind": "expression",
"type": "(node: HTMLElement) => HTMLElement"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TourClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TourStylesType"
}
},
{
"name": "root-class",
"description": "Root container class",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "prefix-cls",
"description": "-",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 步骤改变时的回调，current 为当前的步骤\n\n(EN) Callback when the step changes. Current is the previous step",
"arguments": [
{
"name": "payload",
"type": "(current: number) => void"
}
]
},
{
"name": "close",
"description": "(ZH) 关闭引导时的回调函数\n\n(EN) Callback function on shutdown",
"arguments": [
{
"name": "payload",
"type": "(current: number) => void"
}
]
},
{
"name": "finish",
"description": "(ZH) 引导完成时的回调\n\n(EN) Callback when tour is finished",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": [
{
"name": "actionsRender",
"description": "(ZH) 自定义操作按钮\n\n(EN) Custom action"
},
{
"name": "indicatorsRender",
"description": "(ZH) 自定义指示器\n\n(EN) Custom indicator"
},
{
"name": "nextButton",
"description": "(ZH) 自定义下一步按钮\n\n(EN) Customize next button"
},
{
"name": "prevButton",
"description": "(ZH) 自定义上一步按钮\n\n(EN) Customize previous button"
},
{
"name": "coverRender",
"description": "(ZH) 自定义步骤封面\n\n(EN) Customize step cover"
},
{
"name": "titleRender",
"description": "(ZH) 自定义步骤标题\n\n(EN) Customize step title"
},
{
"name": "descriptionRender",
"description": "(ZH) 自定义步骤描述\n\n(EN) Customize step description"
}
]
},
{
"name": "a-tabs",
"description": "(ZH) 选项卡切换组件。\n\n(EN) Tabs make it easy to explore and switch between different views.",
"attributes": [
{
"name": "active-key",
"description": "Current TabPane's key, support v-model:active-key",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "add-icon",
"description": "Customize add icon, only works with type=\"editable-card\"",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "animated",
"description": "Whether to change tabs with animation",
"default": "\\{ inkBar: true, tabPane: false \\}",
"value": {
"kind": "expression",
"type": "boolean | \\{ inkBar: boolean, tabPane: boolean \\}"
}
},
{
"name": "centered",
"description": "Centers tabs",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TabsClassNamesType"
}
},
{
"name": "default-active-key",
"description": "Initial active TabPane's key, if activeKey is not set",
"default": "The key of first tab",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "hide-add",
"description": "Hide plus icon or not. Only works while type=\"editable-card\"",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "indicator",
"description": "Customize size and align of indicator",
"value": {
"kind": "expression",
"type": "\\{ size?: number | (origin: number) => number; align?: start | center | end \\}"
}
},
{
"name": "items",
"description": "Configure tab content",
"default": "[]",
"value": {
"kind": "expression",
"type": "TabItemType[]"
}
},
{
"name": "more",
"description": "Customize the collapse menu",
"default": "\\{ icon: , trigger: 'hover' \\}",
"value": {
"kind": "expression",
"type": "MoreProps"
}
},
{
"name": "more-icon",
"description": "Custom icon of the collapse menu",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "remove-icon",
"description": "The custom icon of remove, only works with type=\"editable-card\"",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "render-tab-bar",
"description": "Replace the TabBar",
"value": {
"kind": "expression",
"type": "(ctx: \\{ props: any; TabNavListComponent: any \\}) => VueNode"
}
},
{
"name": "size",
"description": "Preset tab bar size",
"default": "middle",
"value": {
"kind": "expression",
"type": "large | middle | small"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TabsStylesType"
}
},
{
"name": "tab-bar-extra-content",
"description": "Extra content in tab bar",
"value": {
"kind": "expression",
"type": "VueNode | \\{ left?: VueNode, right?: VueNode \\}"
}
},
{
"name": "tab-bar-gutter",
"description": "The gap between tabs",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "tab-bar-style",
"description": "Tab bar style object",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "tab-placement",
"description": "Placement of tabs",
"default": "top",
"value": {
"kind": "expression",
"type": "top | end | bottom | start"
}
},
{
"name": "destroy-on-hidden",
"description": "Whether destroy inactive TabPane when change tab",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "type",
"description": "Basic style of tabs",
"default": "line",
"value": {
"kind": "expression",
"type": "line | card | editable-card"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 切换面板的回调\n\n(EN) Callback executed when active tab is changed",
"arguments": [
{
"name": "payload",
"type": "(activeKey: string) => void"
}
]
},
{
"name": "edit",
"description": "(ZH) 新增和删除页签的回调，在 type=\"editable-card\" 时有效\n\n(EN) Callback executed when tab is added or removed. Only works while type=\"editable-card\"",
"arguments": [
{
"name": "payload",
"type": "(e: MouseEvent | KeyboardEvent | string, action: 'add' | 'remove') => void"
}
]
},
{
"name": "tabClick",
"description": "(ZH) tab 被点击的回调\n\n(EN) Callback executed when tab is clicked",
"arguments": [
{
"name": "payload",
"type": "(key: string, event: MouseEvent) => void"
}
]
},
{
"name": "tabScroll",
"description": "(ZH) tab 滚动时触发\n\n(EN) Trigger when tab scroll",
"arguments": [
{
"name": "payload",
"type": "(\\{ direction: left | right | top | bottom \\}) => void"
}
]
}
]
},
"slots": [
{
"name": "addIcon",
"description": "(ZH) 自定义添加按钮，设置 type=\"editable-card\" 时有效\n\n(EN) Customize add icon, only works with type=\"editable-card\""
},
{
"name": "moreIcon",
"description": "(ZH) 自定义折叠图标\n\n(EN) Custom collapse menu icon"
},
{
"name": "removeIcon",
"description": "(ZH) 自定义删除按钮，设置 type=\"editable-card\" 时有效\n\n(EN) The custom icon of remove, only works with type=\"editable-card\""
},
{
"name": "labelRender",
"description": "(ZH) 自定义标签头\n\n(EN) Custom label render"
},
{
"name": "contentRender",
"description": "(ZH) 自定义内容\n\n(EN) Custom content render"
},
{
"name": "renderTabBar",
"description": "(ZH) 替换 TabBar\n\n(EN) Replace the TabBar"
},
{
"name": "rightExtra",
"description": "(ZH) 右侧附加内容\n\n(EN) Extra content on the right"
},
{
"name": "leftExtra",
"description": "(ZH) 左侧附加内容\n\n(EN) Extra content on the left"
}
]
},
{
"name": "a-transfer",
"description": "(ZH) 双栏穿梭选择框。\n\n(EN) Double column transfer choice box.",
"attributes": [
{
"name": "actions",
"description": "A set of operations that are sorted from top to bottom. When an array of strings is provided, default buttons will be used; when an array of VueNode is provided, custom elements will be used",
"default": "[>, <]",
"value": {
"kind": "expression",
"type": "VueNode[]"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TransferClassNamesType"
}
},
{
"name": "data-source",
"description": "Used for setting the source data. The elements that are part of this array will be present the left column. Except the elements whose keys are included in targetKeys prop",
"default": "[]",
"value": {
"kind": "expression",
"type": "TransferItem[]"
}
},
{
"name": "disabled",
"description": "Whether disabled transfer",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "filter-option",
"description": "A function to determine whether an item should show in search result list, only works when searching",
"value": {
"kind": "expression",
"type": "(inputValue: string, option: TransferItem, direction: left | right) => boolean"
}
},
{
"name": "footer",
"description": "A function used for rendering the footer",
"value": {
"kind": "expression",
"type": "(props: TransferListProps, direction: left | right) => VueNode"
}
},
{
"name": "locale",
"description": "The i18n text including filter, empty text, item unit, etc",
"value": {
"kind": "expression",
"type": "TransferLocale"
}
},
{
"name": "one-way",
"description": "Display as single direction style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "pagination",
"description": "Use pagination. Not work in render props",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { pageSize: number; simple: boolean; showSizeChanger?: boolean; showLessItems?: boolean }"
}
},
{
"name": "render",
"description": "The function to generate the item shown on a column. Based on an record (element of the dataSource array), this function should return a VueNode which is generated from that record. Also, it can return a plain object with value and label, label is a VueNode and value is for title",
"value": {
"kind": "expression",
"type": "(record: TransferItem) => VueNode"
}
},
{
"name": "row-key",
"description": "Specify the key that will be used for uniquely identify each element",
"value": {
"kind": "expression",
"type": "(record: TransferItem) => string"
}
},
{
"name": "select-all-labels",
"description": "A set of customized labels for select all checkboxes on the header",
"value": {
"kind": "expression",
"type": "(VueNode | (info: { selectedCount: number; totalCount: number }) => VueNode)[]"
}
},
{
"name": "selected-keys",
"description": "A set of keys of selected items, support v-model:selected-keys",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "selections-icon",
"description": "Custom dropdown icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "show-search",
"description": "If included, a search box is shown on each column",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | { placeholder?: string; defaultValue?: string }"
}
},
{
"name": "show-select-all",
"description": "Show select all checkbox on the header",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "status",
"description": "Set validation status",
"value": {
"kind": "expression",
"type": "error | warning"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "TransferStylesType"
}
},
{
"name": "target-keys",
"description": "A set of keys of elements that are listed on the right column, support v-model:target-keys",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "titles",
"description": "A set of titles that are sorted from left to right",
"value": {
"kind": "expression",
"type": "VueNode[]"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "(ZH) 选项在两栏之间转移时的回调函数\n\n(EN) A callback function that is executed when the transfer between columns is complete",
"arguments": [
{
"name": "payload",
"type": "(targetKeys: string[], direction: left | right, moveKeys: string[]) => void"
}
]
},
{
"name": "scroll",
"description": "(ZH) 选项列表滚动时的回调函数\n\n(EN) A callback function which is executed when scroll options list",
"arguments": [
{
"name": "payload",
"type": "(direction: left | right, event: Event) => void"
}
]
},
{
"name": "search",
"description": "(ZH) 搜索框内容时改变时的回调函数\n\n(EN) A callback function which is executed when search field are changed",
"arguments": [
{
"name": "payload",
"type": "(direction: left | right, value: string) => void"
}
]
},
{
"name": "selectChange",
"description": "(ZH) 选中项发生改变时的回调函数\n\n(EN) A callback function which is executed when selected items are changed",
"arguments": [
{
"name": "payload",
"type": "(sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void"
}
]
}
]
},
"slots": [
{
"name": "actions",
"description": "(ZH) 自定义操作按钮\n\n(EN) Custom operation buttons"
},
{
"name": "footer",
"description": "(ZH) 自定义底部\n\n(EN) Custom footer"
},
{
"name": "render",
"description": "(ZH) 自定义渲染项\n\n(EN) Custom item render"
},
{
"name": "notFoundContent",
"description": "(ZH) 自定义空内容\n\n(EN) Custom empty content"
},
{
"name": "selectAllLabels",
"description": "(ZH) 自定义全选标签\n\n(EN) Custom select all label"
}
]
},
{
"name": "a-tree",
"description": "(ZH) 多层次的结构列表。\n\n(EN) Multiple-level structure list.",
"attributes": [
{
"name": "allow-drop",
"description": "Whether to allow dropping on the node",
"value": {
"kind": "expression",
"type": "({ dropNode, dropPosition }) => boolean"
}
},
{
"name": "auto-expand-parent",
"description": "Whether to automatically expand a parent treeNode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "block-node",
"description": "Whether treeNode fill remaining horizontal space",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "checkable",
"description": "Add a Checkbox before the treeNodes",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "checked-keys",
"description": "(Controlled) Specifies the keys of the checked treeNodes (PS: When this specifies the key of a treeNode which is also a parent treeNode, all the children treeNodes of will be checked; and vice versa, when it specifies the key of a treeNode which is a child treeNode, its parent treeNode will also be checked. When checkable and checkStrictly is true, its object has checked and halfChecked property. Regardless of whether the child or parent treeNode is checked, they won't impact each other, support v-model:checked-keys",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[] | {checked: string[], halfChecked: string[]}"
}
},
{
"name": "check-strictly",
"description": "Check treeNode precisely; parent treeNode and children treeNodes are not associated",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "default-checked-keys",
"description": "Specifies the keys of the default checked treeNodes",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "default-expand-all",
"description": "Whether to expand all treeNodes by default",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "default-expanded-keys",
"description": "Specify the keys of the default expanded treeNodes",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "default-expand-parent",
"description": "If auto expand parent treeNodes when init",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "default-selected-keys",
"description": "Specifies the keys of the default selected treeNodes",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "disabled",
"description": "Whether the tree is disabled",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "draggable",
"description": "Specifies whether this Tree or the node is draggable. Use icon: false to disable drag handler icon",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | ((node: DataNode) => boolean) | { icon?: VueNode | false, nodeDraggable?: (node: DataNode) => boolean }"
}
},
{
"name": "expanded-keys",
"description": "(Controlled) Specifies the keys of the expanded treeNodes, support v-model:expanded-keys",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "field-names",
"description": "Customize node title, key, children field name",
"default": "{ title: title, key: key, children: children }",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "filter-ant-tree-node",
"description": "Defines a function to filter (highlight) treeNodes. When the function returns true, the corresponding treeNode will be highlighted",
"value": {
"kind": "expression",
"type": "function(node)"
}
},
{
"name": "height",
"description": "Config virtual scroll height. Will not support horizontal scroll when enabled",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "icon",
"description": "Insert a custom icon before the title. Need to set showIcon to true",
"value": {
"kind": "expression",
"type": "VueNode | (props) => VueNode"
}
},
{
"name": "load-data",
"description": "Load data asynchronously",
"value": {
"kind": "expression",
"type": "function(node)"
}
},
{
"name": "loaded-keys",
"description": "(Controlled) Set loaded tree nodes. Need to work with loadData",
"default": "[]",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "multiple",
"description": "Allows selecting multiple treeNodes",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "root-style",
"description": "Style on the root element",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "selectable",
"description": "Whether it can be selected",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "selected-keys",
"description": "(Controlled) Specifies the keys of the selected treeNodes, multiple selection needs to set multiple to true, support v-model:selected-keys",
"value": {
"kind": "expression",
"type": "string[]"
}
},
{
"name": "show-icon",
"description": "Controls whether to display the icon node (no default style)",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "show-line",
"description": "Shows a connecting line",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | {showLeafIcon: VueNode | ((props: AntTreeNodeProps) => VueNode)}"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: { props })=> Record"
}
},
{
"name": "switcher-icon",
"description": "Customize expand/collapse icons for tree nodes (With default rotate angular style)",
"value": {
"kind": "expression",
"type": "VueNode | ((props: AntTreeNodeProps) => VueNode)"
}
},
{
"name": "switcher-loading-icon",
"description": "Customize loading icons for tree nodes",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title-render",
"description": "Customize tree node title render",
"value": {
"kind": "expression",
"type": "(nodeData) => VueNode"
}
},
{
"name": "tree-data",
"description": "The treeNodes data Array, if set it then you need not to construct children TreeNode. (key should be unique across the whole array)",
"value": {
"kind": "expression",
"type": "array"
}
},
{
"name": "virtual",
"description": "Disable virtual scroll when set to false",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "check",
"description": "(ZH) 点击复选框触发\n\n(EN) Callback function for when the onCheck event occurs",
"arguments": [
{
"name": "payload",
"type": "function(checkedKeys, e:{checked: boolean, checkedNodes, node, event, halfCheckedKeys})"
}
]
},
{
"name": "dragEnd",
"description": "(ZH) dragend 触发时调用\n\n(EN) Callback function for when the onDragEnd event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node})"
}
]
},
{
"name": "dragEnter",
"description": "(ZH) dragenter 触发时调用\n\n(EN) Callback function for when the onDragEnter event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node, expandedKeys})"
}
]
},
{
"name": "dragLeave",
"description": "(ZH) dragleave 触发时调用\n\n(EN) Callback function for when the onDragLeave event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node})"
}
]
},
{
"name": "dragOver",
"description": "(ZH) dragover 触发时调用\n\n(EN) Callback function for when the onDragOver event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node})"
}
]
},
{
"name": "dragStart",
"description": "(ZH) 开始拖拽时调用\n\n(EN) Callback function for when the onDragStart event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node})"
}
]
},
{
"name": "drop",
"description": "(ZH) drop 触发时调用\n\n(EN) Callback function for when the onDrop event occurs",
"arguments": [
{
"name": "payload",
"type": "function({event, node, dragNode, dragNodesKeys})"
}
]
},
{
"name": "expand",
"description": "(ZH) 展开/收起节点时触发\n\n(EN) Callback function for when a treeNode is expanded or collapsed",
"arguments": [
{
"name": "payload",
"type": "function(expandedKeys, {expanded: boolean, node})"
}
]
},
{
"name": "load",
"description": "(ZH) 节点加载完毕时触发\n\n(EN) Callback function for when a treeNode is loaded",
"arguments": [
{
"name": "payload",
"type": "function(loadedKeys, {event, node})"
}
]
},
{
"name": "rightClick",
"description": "(ZH) 响应右键点击\n\n(EN) Callback function for when the user right clicks a treeNode",
"arguments": [
{
"name": "payload",
"type": "function({event, node})"
}
]
},
{
"name": "select",
"description": "(ZH) 点击树节点触发\n\n(EN) Callback function for when the user clicks a treeNode",
"arguments": [
{
"name": "payload",
"type": "function(selectedKeys, e:{selected: boolean, selectedNodes, node, event})"
}
]
}
]
},
"slots": [
{
"name": "switcherLoadingIcon",
"description": "(ZH) 自定义树节点的加载图标\n\n(EN) Customize loading icons for tree nodes"
},
{
"name": "switcherIcon",
"description": "(ZH) 自定义树节点的展开/折叠图标（带有默认 rotate 角度样式）\n\n(EN) Customize expand/collapse icons for tree nodes"
},
{
"name": "draggableIcon",
"description": "(ZH) 自定义拖拽图标\n\n(EN) Custom draggable icon"
},
{
"name": "icon",
"description": "(ZH) 在标题之前插入自定义图标\n\n(EN) Insert a custom icon before the title"
},
{
"name": "titleRender",
"description": "(ZH) 自定义渲染节点\n\n(EN) Customize tree node title render"
}
]
},
{
"name": "a-tree-node",
"description": "(ZH) 多层次的结构列表。\n\n(EN) Multiple-level structure list.",
"attributes": [
{
"name": "checkable",
"description": "When Tree is checkable, set TreeNode display Checkbox or not",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disable-checkbox",
"description": "Disables the checkbox of the treeNode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disables the treeNode",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "Customize icon. When you pass component, whose render will receive full TreeNode props as component props",
"value": {
"kind": "expression",
"type": "VueNode | (props) => VueNode"
}
},
{
"name": "is-leaf",
"description": "Determines if this is a leaf node (effective when loadData is specified). false will force the TreeNode to be treated as a parent node",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "key",
"description": "Used with (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. P.S.: It must be unique in all of treeNodes of the tree",
"default": "(internal calculated position of treeNode)",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "selectable",
"description": "Set whether the treeNode can be selected",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "title",
"description": "Title",
"default": "---",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-directory-tree",
"description": "(ZH) 多层次的结构列表。\n\n(EN) Multiple-level structure list.",
"attributes": [
{
"name": "expand-action",
"description": "Directory opening logic, options: false | click | doubleClick",
"default": "click",
"value": {
"kind": "expression",
"type": "string | boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-typography",
"description": "(ZH) 文本的基本格式。\n\n(EN) Basic text writing, including headings, body text, lists, and more.",
"attributes": [
{
"name": "direction",
"description": "Direction control",
"value": {
"kind": "expression",
"type": "'ltr' | 'rtl'"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-typography-text",
"description": "(ZH) 文本的基本格式。\n\n(EN) Basic text writing, including headings, body text, lists, and more.",
"attributes": [
{
"name": "code",
"description": "Code style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "copyable",
"description": "Whether to be copyable, customize it via setting an object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | copyable"
}
},
{
"name": "delete",
"description": "Deleted line style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disabled content",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "editable",
"description": "If editable. Can control edit state when is object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | editable"
}
},
{
"name": "ellipsis",
"description": "Display ellipsis when text overflows, can't configure expandable, rows and onExpand by using object. Diff with Typography.Paragraph, Text do not have 100% width style which means it will fix width on the first ellipsis. If you want to have responsive ellipsis, please set width manually",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | Omit"
}
},
{
"name": "keyboard",
"description": "Keyboard style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mark",
"description": "Marked style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "strong",
"description": "Bold style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "italic",
"description": "Italic style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "type",
"description": "Content type",
"value": {
"kind": "expression",
"type": "secondary | success | warning | danger"
}
},
{
"name": "underline",
"description": "Underlined style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyStylesType"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击时的回调\n\n(EN) Set the handler to handle click event",
"arguments": [
{
"name": "payload",
"type": "(event: MouseEvent) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-typography-title",
"description": "(ZH) 文本的基本格式。\n\n(EN) Basic text writing, including headings, body text, lists, and more.",
"attributes": [
{
"name": "code",
"description": "Code style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "copyable",
"description": "Whether to be copyable, customize it via setting an object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | copyable"
}
},
{
"name": "delete",
"description": "Deleted line style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disabled content",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "editable",
"description": "If editable. Can control edit state when is object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | editable"
}
},
{
"name": "ellipsis",
"description": "Display ellipsis when text overflows, can configure rows and expandable by using object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | ellipsis"
}
},
{
"name": "level",
"description": "Set content importance. Match with h1, h2, h3, h4, h5",
"default": "1",
"value": {
"kind": "expression",
"type": "number: 1, 2, 3, 4, 5"
}
},
{
"name": "mark",
"description": "Marked style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "italic",
"description": "Italic style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "type",
"description": "Content type",
"value": {
"kind": "expression",
"type": "secondary | success | warning | danger"
}
},
{
"name": "underline",
"description": "Underlined style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyStylesType"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击时的回调\n\n(EN) Set the handler to handle click event",
"arguments": [
{
"name": "payload",
"type": "(event: MouseEvent) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-typography-paragraph",
"description": "(ZH) 文本的基本格式。\n\n(EN) Basic text writing, including headings, body text, lists, and more.",
"attributes": [
{
"name": "code",
"description": "Code style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "copyable",
"description": "Whether to be copyable, customize it via setting an object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | copyable"
}
},
{
"name": "delete",
"description": "Deleted line style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disabled content",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "editable",
"description": "If editable. Can control edit state when is object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | editable"
}
},
{
"name": "ellipsis",
"description": "Display ellipsis when text overflows, can configure rows and expandable by using object",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean | ellipsis"
}
},
{
"name": "mark",
"description": "Marked style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "strong",
"description": "Bold style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "italic",
"description": "Italic style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "type",
"description": "Content type",
"value": {
"kind": "expression",
"type": "secondary | success | warning | danger"
}
},
{
"name": "underline",
"description": "Underlined style",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyClassNamesType"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "TypographyStylesType"
}
}
],
"js": {
"events": [
{
"name": "click",
"description": "(ZH) 点击时的回调\n\n(EN) Set the handler to handle click event",
"arguments": [
{
"name": "payload",
"type": "(event: MouseEvent) => void"
}
]
},
{
"name": "copy",
"description": "(ZH) 拷贝成功的回调函数\n\n(EN) Called when copied text",
"arguments": [
{
"name": "payload",
"type": "(event: MouseEvent) => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-upload",
"description": "(ZH) 文件选择上传和拖拽上传控件。\n\n(EN) Used to select and upload files or drag and drop files.",
"attributes": [
{
"name": "accept",
"description": "File types that can be accepted. See input accept Attribute",
"value": {
"kind": "expression",
"type": "string | AcceptObject"
}
},
{
"name": "action",
"description": "Uploading URL",
"value": {
"kind": "expression",
"type": "string | (file) => Promise"
}
},
{
"name": "before-upload",
"description": "Hook function which will be executed before uploading. Uploading will be stopped with false or a rejected Promise returned. When returned value is Upload.LIST_IGNORE, the list of files that have been uploaded will ignore it. **Warning：this function is not supported in IE9**",
"value": {
"kind": "expression",
"type": "(file: VcFile, fileList: [VcFile[]](#vcfile)) => boolean | Promise | Upload.LIST_IGNORE"
}
},
{
"name": "custom-request",
"description": "Override for the default xhr behavior allowing for additional customization and the ability to implement your own XMLHttpRequest",
"value": {
"kind": "expression",
"type": "( options: RequestOptions, info: \\{ defaultRequest: (option: RequestOptions) => void; \\} ) => void"
}
},
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "data",
"description": "Uploading extra params or function which can return uploading extra params",
"value": {
"kind": "expression",
"type": "object | (file) => object | Promise"
}
},
{
"name": "directory",
"description": "Support upload whole directory (caniuse)",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "Disable upload button",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "file-list",
"description": "List of files that have been uploaded (controlled). Here is a common issue #2423 when using it, support v-model:file-list",
"value": {
"kind": "expression",
"type": "UploadFile\\[]"
}
},
{
"name": "headers",
"description": "Set request headers, valid above IE10",
"value": {
"kind": "expression",
"type": "object"
}
},
{
"name": "icon-render",
"description": "Custom show icon",
"value": {
"kind": "expression",
"type": "(file: UploadFile, listType?: UploadListType) => VueNode"
}
},
{
"name": "is-image-url",
"description": "Customize if render in thumbnail",
"default": "(inside implementation)",
"value": {
"kind": "expression",
"type": "(file: UploadFile) => boolean"
}
},
{
"name": "item-render",
"description": "Custom item of uploadList",
"value": {
"kind": "expression",
"type": "(originNode: VueNode, file: UploadFile, fileList: object\\[], actions: \\{ download: function, preview: function, remove: function \\}) => VueNode"
}
},
{
"name": "list-type",
"description": "Built-in stylesheets, support for four types: text, picture, picture-card or picture-circle",
"default": "text",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "max-count",
"description": "Limit the number of uploaded files. Will replace current one when maxCount is 1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "method",
"description": "The http method of upload request",
"default": "post",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "multiple",
"description": "Whether to support selected multiple files. IE10+ supported. You can select multiple files with CTRL holding down while multiple is set to be true",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "name",
"description": "The name of uploading file",
"default": "file",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "open-file-dialog-on-click",
"description": "Click open file dialog",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "pastable",
"description": "Support paste file",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "preview-file",
"description": "Customize preview file logic",
"value": {
"kind": "expression",
"type": "(file: File | Blob) => Promise"
}
},
{
"name": "progress",
"description": "Custom progress bar",
"default": "\\{ strokeWidth: 2, showInfo: false \\}",
"value": {
"kind": "expression",
"type": "ProgressProps (support type=\"line\" only)"
}
},
{
"name": "show-upload-list",
"description": "Whether to show default upload list, could be an object to specify extra, showPreviewIcon, showRemoveIcon, showDownloadIcon, removeIcon and downloadIcon individually",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean | \\{ extra?: VueNode | (file: UploadFile) => VueNode, showPreviewIcon?: boolean | (file: UploadFile) => boolean, showDownloadIcon?: boolean | (file: UploadFile) => boolean, showRemoveIcon?: boolean | (file: UploadFile) => boolean, previewIcon?: VueNode | (file: UploadFile) => VueNode, removeIcon?: VueNode | (file: UploadFile) => VueNode, downloadIcon?: VueNode | (file: UploadFile) => VueNode \\}"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function.",
"value": {
"kind": "expression",
"type": "Record | (info: \\{ props \\})=> Record"
}
},
{
"name": "with-credentials",
"description": "The ajax upload with cookie sent",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": [
{
"name": "change",
"description": "A callback function, can be executed when uploading state is changing. It will trigger by every uploading phase. see onChange",
"arguments": [
{
"name": "payload",
"type": "function"
}
]
},
{
"name": "drop",
"description": "A callback function executed when files are dragged and dropped into the upload area",
"arguments": [
{
"name": "payload",
"type": "(event: DragEvent) => void"
}
]
},
{
"name": "download",
"description": "Click the method to download the file, pass the method to perform the method logic, and do not pass the default jump to the new TAB",
"arguments": [
{
"name": "payload",
"type": "function(file): void"
}
]
},
{
"name": "preview",
"description": "A callback function, will be executed when the file link or preview icon is clicked",
"arguments": [
{
"name": "payload",
"type": "function(file)"
}
]
},
{
"name": "remove",
"description": "A callback function, will be executed when removing file button is clicked, remove event will be prevented when the return value is false or a Promise which resolve(false) or reject",
"arguments": [
{
"name": "payload",
"type": "function(file): boolean | Promise"
}
]
}
]
},
"slots": [
{
"name": "itemRender",
"description": "Custom item of uploadList"
},
{
"name": "iconRender",
"description": "Custom show icon"
}
]
},
{
"name": "a-watermark",
"description": "(ZH) 给页面的某个区域加上水印。\n\n(EN) Add specific text or patterns to the page.",
"attributes": [
{
"name": "width",
"description": "The width of the watermark, the default value of content is its own width",
"default": "120",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "height",
"description": "The height of the watermark, the default value of content is its own height",
"default": "64",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "inherit",
"description": "Pass the watermark to the pop-up component such as Modal, Drawer",
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "rotate",
"description": "When the watermark is drawn, the rotation angle, unit °",
"default": "-22",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "z-index",
"description": "The z-index of the appended watermark element",
"default": "9",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "image",
"description": "Image source, it is recommended to export 2x or 3x image, high priority (support base64 format)",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "content",
"description": "Watermark text content",
"value": {
"kind": "expression",
"type": "string | string[]"
}
},
{
"name": "font",
"description": "Text style",
"default": "Font",
"value": {
"kind": "expression",
"type": "Font"
}
},
{
"name": "gap",
"description": "The spacing between watermarks",
"default": "\\[100, 100\\]",
"value": {
"kind": "expression",
"type": "\\[number, number\\]"
}
},
{
"name": "offset",
"description": "The offset of the watermark from the upper left corner of the container. The default is gap/2",
"default": "\\[gap\\[0\\]/2, gap\\[1\\]/2\\]",
"value": {
"kind": "expression",
"type": "\\[number, number\\]"
}
}
],
"js": {
"events": [
{
"name": "remove",
"description": "Callback when the watermark is removed by DOM mutation",
"arguments": [
{
"name": "payload",
"type": "() => void"
}
]
}
]
},
"slots": []
},
{
"name": "a-tree-select-props",
"description": "Tree selection control.",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "A callback function, can be executed when selected treeNodes or input value change",
"arguments": [
{
"name": "payload",
"type": "function(value, label, extra)"
}
]
},
{
"name": "openChange",
"description": "Callback when dropdown open state changes",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "select",
"description": "A callback function, can be executed when you select a treeNode",
"arguments": [
{
"name": "payload",
"type": "function(value, node, extra)"
}
]
},
{
"name": "treeExpand",
"description": "A callback function, can be executed when treeNode expanded",
"arguments": [
{
"name": "payload",
"type": "function(expandedKeys)"
}
]
},
{
"name": "popupScroll",
"description": "Called when dropdown scrolls",
"arguments": [
{
"name": "payload",
"type": "(event: UIEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "suffixIcon",
"description": "The custom suffix icon"
},
{
"name": "tagRender",
"description": "Customize tag render when multiple"
},
{
"name": "notFoundContent",
"description": "Specify content to show when no result matches"
},
{
"name": "switcherIcon",
"description": "Customize collapse/expand icon of tree node"
},
{
"name": "treeTitleRender",
"description": "Customize tree node title render"
}
]
},
{
"name": "a-tree-select",
"description": "树型选择控件。",
"attributes": [],
"js": {
"events": [
{
"name": "change",
"description": "选中树节点时调用此函数",
"arguments": [
{
"name": "payload",
"type": "function(value, label, extra)"
}
]
},
{
"name": "openChange",
"description": "展开下拉菜单的回调",
"arguments": [
{
"name": "payload",
"type": "(open: boolean) => void"
}
]
},
{
"name": "select",
"description": "被选中时调用",
"arguments": [
{
"name": "payload",
"type": "function(value, node, extra)"
}
]
},
{
"name": "treeExpand",
"description": "展示节点时调用",
"arguments": [
{
"name": "payload",
"type": "function(expandedKeys)"
}
]
},
{
"name": "popupScroll",
"description": "下拉列表滚动时的回调",
"arguments": [
{
"name": "payload",
"type": "(event: UIEvent) => void"
}
]
}
]
},
"slots": [
{
"name": "suffixIcon",
"description": "自定义的选择框后缀图标"
},
{
"name": "tagRender",
"description": "自定义 tag 内容，多选时生效"
},
{
"name": "notFoundContent",
"description": "当下拉列表为空时显示的内容"
},
{
"name": "switcherIcon",
"description": "自定义树节点的展开/折叠图标"
},
{
"name": "treeTitleRender",
"description": "自定义渲染节点"
}
]
},
{
"name": "a-result",
"description": "(ZH) 用于反馈一系列操作任务的处理结果。\n\n(EN) Used to feedback the processing results of a series of operations.",
"attributes": [
{
"name": "classes",
"description": "Customize class for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "extra",
"description": "Operating area",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "icon",
"description": "Custom back icon",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "status",
"description": "Result status, decide icons and colors",
"default": "info",
"value": {
"kind": "expression",
"type": "success | error | info | warning | 404 | 403 | 500"
}
},
{
"name": "styles",
"description": "Customize inline style for each semantic structure inside the component. Supports object or function",
"value": {
"kind": "expression",
"type": "Record | (info: { props }) => Record"
}
},
{
"name": "sub-title",
"description": "The subTitle",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title",
"description": "The title",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "icon",
"description": "(ZH) 自定义 icon\n\n(EN) Custom back icon"
},
{
"name": "title",
"description": "(ZH) title 文字\n\n(EN) The title"
},
{
"name": "subTitle",
"description": "(ZH) subTitle 文字\n\n(EN) The subTitle"
},
{
"name": "extra",
"description": "(ZH) 操作区\n\n(EN) Operating area"
}
]
},
{
"name": "a-menu-item",
"description": "(ZH) Menu item used as a child of Menu or SubMenu.\n\n(EN) Menu item used as a child of Menu or SubMenu.",
"attributes": [
{
"name": "danger",
"description": "(ZH) Display the danger style.\n\n(EN) Display the danger style.",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "(ZH) Whether the menu item is disabled.\n\n(EN) Whether the menu item is disabled.",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "(ZH) Icon of the menu item.\n\n(EN) Icon of the menu item.",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "extra",
"description": "(ZH) Extra content rendered at the end of the menu item.\n\n(EN) Extra content rendered at the end of the menu item.",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title",
"description": "(ZH) Title content used for the collapsed tooltip.\n\n(EN) Title content used for the collapsed tooltip.",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "default",
"description": "(ZH) Menu item content.\n\n(EN) Menu item content."
},
{
"name": "icon",
"description": "(ZH) Custom icon content. Takes priority over the `icon` prop.\n\n(EN) Custom icon content. Takes priority over the `icon` prop."
},
{
"name": "title",
"description": "(ZH) Custom title content. Takes priority over the `title` prop.\n\n(EN) Custom title content. Takes priority over the `title` prop."
},
{
"name": "extra",
"description": "(ZH) Custom extra content rendered at the end of the item.\n\n(EN) Custom extra content rendered at the end of the item."
}
]
},
{
"name": "a-sub-menu",
"description": "(ZH) Submenu container used to group related menu items.\n\n(EN) Submenu container used to group related menu items.",
"attributes": [
{
"name": "disabled",
"description": "(ZH) Whether the submenu is disabled.\n\n(EN) Whether the submenu is disabled.",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "(ZH) Icon of the submenu.\n\n(EN) Icon of the submenu.",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "title",
"description": "(ZH) Title content of the submenu.\n\n(EN) Title content of the submenu.",
"value": {
"kind": "expression",
"type": "VueNode"
}
},
{
"name": "popup-class-name",
"description": "(ZH) Submenu popup class name. Not effective when `mode=\"inline\"`.\n\n(EN) Submenu popup class name. Not effective when `mode=\"inline\"`.",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "popup-offset",
"description": "(ZH) Submenu popup offset. Not effective when `mode=\"inline\"`.\n\n(EN) Submenu popup offset. Not effective when `mode=\"inline\"`.",
"value": {
"kind": "expression",
"type": "[number, number]"
}
},
{
"name": "popup-style",
"description": "(ZH) Inline style of the submenu popup.\n\n(EN) Inline style of the submenu popup.",
"value": {
"kind": "expression",
"type": "CSSProperties"
}
},
{
"name": "popup-render",
"description": "(ZH) Custom renderer for the current submenu popup.\n\n(EN) Custom renderer for the current submenu popup.",
"value": {
"kind": "expression",
"type": "(node: VueNode, info: { item: SubMenuProps; keys: string[] }) => VueNode"
}
},
{
"name": "theme",
"description": "(ZH) Color theme of the submenu. Inherits from Menu by default.\n\n(EN) Color theme of the submenu. Inherits from Menu by default.",
"value": {
"kind": "expression",
"type": "`light` | `dark`"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "default",
"description": "(ZH) Submenu items.\n\n(EN) Submenu items."
},
{
"name": "icon",
"description": "(ZH) Custom icon content. Takes priority over the `icon` prop.\n\n(EN) Custom icon content. Takes priority over the `icon` prop."
},
{
"name": "title",
"description": "(ZH) Custom title content. Takes priority over the `title` prop.\n\n(EN) Custom title content. Takes priority over the `title` prop."
}
]
},
{
"name": "a-menu-divider",
"description": "(ZH) Divider line between menu items.\n\n(EN) Divider line between menu items.",
"attributes": [
{
"name": "dashed",
"description": "(ZH) Whether the divider line is dashed.\n\n(EN) Whether the divider line is dashed.",
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
},
{
"name": "a-menu-item-group",
"description": "(ZH) Group container for related menu items.\n\n(EN) Group container for related menu items.",
"attributes": [
{
"name": "title",
"description": "(ZH) Title content of the menu item group.\n\n(EN) Title content of the menu item group.",
"value": {
"kind": "expression",
"type": "VueNode"
}
}
],
"js": {
"events": []
},
"slots": [
{
"name": "default",
"description": "(ZH) Grouped menu items.\n\n(EN) Grouped menu items."
},
{
"name": "title",
"description": "(ZH) Custom group title. Takes priority over the `title` prop.\n\n(EN) Custom group title. Takes priority over the `title` prop."
}
]
},
{
"name": "a-style-provider",
"description": "(ZH) Provide CSS-in-JS context for styling configuration.\n\n(EN) Provide CSS-in-JS context for styling configuration.",
"attributes": [
{
"name": "auto-clear",
"description": "(ZH) Clear style cache on unmount.\n\n(EN) Clear style cache on unmount.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "cache",
"description": "(ZH) Set when you need SSR to extract style on your own. If not provided, it auto creates on server side.\n\n(EN) Set when you need SSR to extract style on your own. If not provided, it auto creates on server side.",
"value": {
"kind": "expression",
"type": "CacheEntity"
}
},
{
"name": "default-cache",
"description": "(ZH) Tell children this context is default generated context.\n\n(EN) Tell children this context is default generated context.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "hash-priority",
"description": "(ZH) Use :where selector to reduce hashId selector priority.\n\n(EN) Use :where selector to reduce hashId selector priority.",
"value": {
"kind": "expression",
"type": "HashPriority"
}
},
{
"name": "container",
"description": "(ZH) Tell cssinjs where to inject style in.\n\n(EN) Tell cssinjs where to inject style in.",
"value": {
"kind": "expression",
"type": "Element | ShadowRoot"
}
},
{
"name": "ssr-inline",
"description": "(ZH) Render inline for SSR fallback. Not recommended.\n\n(EN) Render inline for SSR fallback. Not recommended.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "transformers",
"description": "(ZH) Transform css before inject in document. Transformers do not support dynamic update.\n\n(EN) Transform css before inject in document. Transformers do not support dynamic update.",
"value": {
"kind": "expression",
"type": "Transformer[]"
}
},
{
"name": "linters",
"description": "(ZH) Linters to lint css before inject in document. Styles linted after transforming. Linters do not support dynamic update.\n\n(EN) Linters to lint css before inject in document. Styles linted after transforming. Linters do not support dynamic update.",
"value": {
"kind": "expression",
"type": "Linter[]"
}
},
{
"name": "layer",
"description": "(ZH) Wrap css in a layer to avoid global style conflict.\n\n(EN) Wrap css in a layer to avoid global style conflict.",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "auto-prefix",
"description": "(ZH) Hardcode here since transformer not support serialize effect.\n\n(EN) Hardcode here since transformer not support serialize effect.",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"js": {
"events": []
},
"slots": []
}
]
}
}
}