UNPKG

ant-design-vue

Version:

An enterprise-class UI design language and Vue-based implementation

1,306 lines 157 kB
{ "a-affix/offsetBottom": { "type": "number", "description": "Offset from the bottom of the viewport (in pixels), Default: -" }, "a-affix/offsetTop": { "type": "number", "description": "Offset from the top of the viewport (in pixels), Default: 0" }, "a-affix/target": { "type": "() => HTMLElement", "description": "Specifies the scrollable area DOM node, Default: () => window" }, "a-alert/action": { "type": "slot", "description": "The action of Alert, Default: -" }, "a-alert/afterClose": { "type": "() => void", "description": "Called when close animation is finished, Default: -" }, "a-alert/banner": { "type": "boolean", "description": "Whether to show as banner, Default: false" }, "a-alert/closable": { "type": "boolean", "description": "Whether Alert can be closed, Default: " }, "a-alert/closeIcon": { "type": "slot", "description": "Custom close icon, Default: `<CloseOutlined />`" }, "a-alert/closeText": { "type": "string|slot", "description": "Close text to show, Default: -" }, "a-alert/description": { "type": "string|slot", "description": "Additional content of Alert, Default: -" }, "a-alert/icon": { "type": "vnode | slot", "description": "Custom icon, effective when `showIcon` is `true`, Default: -" }, "a-alert/message": { "type": "string|slot", "description": "Content of Alert, Default: -" }, "a-alert/showIcon": { "type": "boolean", "description": "Whether to show icon, Default: false,in `banner` mode default is true" }, "a-alert/type": { "type": "string", "description": "Type of Alert styles, options: `success`, `info`, `warning`, `error`, Default: `info`,in `banner` mode default is `warning`" }, "a-anchor/affix": { "type": "boolean", "description": "Fixed mode of Anchor, Default: true" }, "a-anchor/bounds": { "type": "number", "description": "Bounding distance of anchor area, Default: 5(px)" }, "a-anchor/getContainer": { "type": "() => HTMLElement", "description": "Scrolling container, Default: () => window" }, "a-anchor/getCurrentAnchor": { "type": "(activeLink: string) => string", "description": "Customize the anchor highlight, Default: -" }, "a-anchor/offsetBottom": { "type": "number", "description": "Pixels to offset from bottom when calculating position of scroll, Default: -" }, "a-anchor/offsetTop": { "type": "number", "description": "Pixels to offset from top when calculating position of scroll, Default: 0" }, "a-anchor/showInkInFixed": { "type": "boolean", "description": "Whether show ink-square when `:affix=\"false\"`, Default: false" }, "a-anchor/targetOffset": { "type": "number", "description": "Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetoffset), Default: `offsetTop`" }, "a-anchor/wrapperClass": { "type": "string", "description": "The class name of the container, Default: -" }, "a-anchor/wrapperStyle": { "type": "object", "description": "The style of the container, Default: -" }, "a-anchor/items": { "type": "{ key, href, title, target, children }[] [see](#anchoritem)", "description": "Data configuration option content, support nesting through children, Default: -" }, "a-anchor/direction": { "type": "`vertical` | `horizontal`", "description": "Set Anchor direction, Default: `vertical`" }, "a-anchor/customTitle": { "type": "v-slot=\"AnchorItem\"", "description": "custom option title by slot, Default: -" }, "a-anchor-item/key": { "type": "string | number", "description": "The unique identifier of the Anchor Link, Default: -" }, "a-anchor-item/href": { "type": "string", "description": "The target of hyperlink, Default: " }, "a-anchor-item/target": { "type": "string", "description": "Specifies where to display the linked URL, Default: " }, "a-anchor-item/title": { "type": "VueNode | (item: AnchorItem) => VueNode", "description": "The content of hyperlink, Default: " }, "a-anchor-item/children": { "type": "[AnchorItem](#anchoritem)[]", "description": "Nested Anchor Link, `Attention: This attribute does not support horizontal orientation`, Default: -" }, "a-app/message": { "type": "[MessageConfig](/components/message/#messageconfig)", "description": "Global config for Message, Default: -" }, "a-app/notification": { "type": "[NotificationConfig](/components/notification/#notificationconfig)", "description": "Global config for Notification, Default: -" }, "a-auto-complete/allowClear": { "type": "boolean", "description": "Show clear button, effective in multiple mode only., Default: false" }, "a-auto-complete/autofocus": { "type": "boolean", "description": "get focus when component mounted, Default: false" }, "a-auto-complete/backfill": { "type": "boolean", "description": "backfill selected item the input when using keyboard, Default: false" }, "a-auto-complete/bordered": { "type": "boolean", "description": "Whether has border style, Default: true" }, "a-auto-complete/clearIcon": { "type": "slot", "description": "Use slot custom clear icon, Default: `<CloseCircleFilled />`" }, "a-auto-complete/default (for customize input element)": { "type": "slot", "description": "customize input element, Default: `<Input />`" }, "a-auto-complete/defaultActiveFirstOption": { "type": "boolean", "description": "Whether active first option by default, Default: true" }, "a-auto-complete/defaultOpen": { "type": "boolean", "description": "Initial open state of dropdown, Default: -" }, "a-auto-complete/disabled": { "type": "boolean", "description": "Whether disabled select, Default: false" }, "a-auto-complete/popupClassName": { "type": "string", "description": "The className of dropdown menu, Default: -" }, "a-auto-complete/dropdownMatchSelectWidth": { "type": "boolean | number", "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" }, "a-auto-complete/dropdownMenuStyle": { "type": "object", "description": "additional style applied to dropdown menu, Default: " }, "a-auto-complete/filterOption": { "type": "boolean or function(inputValue, 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" }, "a-auto-complete/open": { "type": "boolean", "description": "Controlled open state of dropdown, Default: -" }, "a-auto-complete/option": { "type": "v-slot:option=\"{value, label, [disabled, key, title]}\"", "description": "custom render option by slot, Default: -" }, "a-auto-complete/options": { "type": "[DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)[]", "description": "Data source for autocomplete, Default: " }, "a-auto-complete/placeholder": { "type": "string", "description": "placeholder of input, Default: -" }, "a-auto-complete/status": { "type": "'error' | 'warning'", "description": "Set validation status, Default: -" }, "a-auto-complete/v-model:value": { "type": "string|string[]|{ key: string, label: string|vNodes }|Array&lt;{ key: string, label: string|vNodes }>", "description": "selected option, Default: -" }, "a-avatar/alt": { "type": "string", "description": "This attribute defines the alternative text describing the image, Default: -" }, "a-avatar/crossOrigin": { "type": "`'anonymous'` | `'use-credentials'` | `''`", "description": "cors settings attributes, Default: -" }, "a-avatar/draggable": { "type": "boolean | `'true'` | `'false'`", "description": "Whether the picture is allowed to be dragged, Default: -" }, "a-avatar/gap": { "type": "number", "description": "Letter type unit distance between left and right sides, Default: 4" }, "a-avatar/icon": { "type": "VNode | slot", "description": "the `Icon` type for an icon avatar, see `Icon` Component, Default: -" }, "a-avatar/loadError": { "type": "() => boolean", "description": "handler when img load error, return false to prevent default fallback behavior, Default: -" }, "a-avatar/shape": { "type": "`circle` | `square`", "description": "the shape of avatar, Default: `circle`" }, "a-avatar/size": { "type": "number | `large` | `small` | `default` | { xs: number, sm: number, ...}", "description": "The size of the avatar, Default: `default`" }, "a-avatar/src": { "type": "string", "description": "the address of the image for an image avatar, Default: -" }, "a-avatar/srcset": { "type": "string", "description": "a list of sources to use for different screen resolutions, Default: -" }, "a-avatar-group/maxCount": { "type": "number", "description": "Max avatars to show, Default: -" }, "a-avatar-group/maxPopoverPlacement": { "type": "`top` | `bottom`", "description": "The placement of excess avatar Popover, Default: `top`" }, "a-avatar-group/maxPopoverTrigger": { "type": "`hover` | `focus` | `click`", "description": "Set the trigger of excess avatar Popover, Default: `hover`" }, "a-avatar-group/maxStyle": { "type": "CSSProperties", "description": "The style of excess avatar style, Default: -" }, "a-avatar-group/size": { "type": "number | `large` | `small` | `default` | { xs: number, sm: number, ...}", "description": "The size of the avatar, Default: `default`" }, "a-avatar-group/shape": { "type": "`circle` | `square`", "description": "The shape of the avatar, Default: `circle`" }, "a-breadcrumb/itemRender": { "type": "({route, params, routes, paths}) => vNode", "description": "Custom item renderer, #itemRender=\"{route, params, routes, paths}\", Default: " }, "a-breadcrumb/params": { "type": "object", "description": "Routing parameters, Default: " }, "a-breadcrumb/routes": { "type": "[routes[]](#routes)", "description": "The routing stack information of router, Default: " }, "a-breadcrumb/separator": { "type": "string|slot", "description": "Custom separator, Default: " }, "a-breadcrumb-item/href": { "type": "string", "description": "Target of hyperlink, Default: -" }, "a-breadcrumb-item/overlay": { "type": "[Menu](/components/menu) | () => Menu", "description": "The dropdown menu, Default: -" }, "a-button/block": { "type": "boolean", "description": "option to fit button width to its parent width, Default: `false`" }, "a-button/danger": { "type": "boolean", "description": "set the danger status of button, Default: `false`" }, "a-button/disabled": { "type": "boolean", "description": "disabled state of button, Default: `false`" }, "a-button/ghost": { "type": "boolean", "description": "make background transparent and invert text and border colors, Default: `false`" }, "a-button/href": { "type": "string", "description": "redirect url of link button, Default: -" }, "a-button/htmlType": { "type": "string", "description": "set the original html `type` of `button`, see: [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type), Default: `button`" }, "a-button/icon": { "type": "v-slot", "description": "set the icon of button, see: Icon component, Default: -" }, "a-button/loading": { "type": "boolean | { delay: number }", "description": "set the loading status of button, Default: `false`" }, "a-button/shape": { "type": "`default` | `circle` | `round`", "description": "Can be set button shape, Default: `default`" }, "a-button/size": { "type": "`large` | `middle` | `small`", "description": "set the size of button, Default: `middle`" }, "a-button/target": { "type": "string", "description": "same as target attribute of a, works when href is specified, Default: -" }, "a-button/type": { "type": "`primary` | `ghost` | `dashed` | `link` | `text` | `default`", "description": "can be set button type, Default: `default`" }, "a-calendar/dateCellRender": { "type": "v-slot:dateCellRender=\"{current: dayjs}\"", "description": "Customize the display of the date cell by setting a scoped slot, the returned content will be appended to the cell, Default: -" }, "a-calendar/dateFullCellRender": { "type": "v-slot:dateFullCellRender=\"{current: dayjs}\"", "description": "Customize the display of the date cell by setting a scoped slot, the returned content will override the cell, Default: -" }, "a-calendar/disabledDate": { "type": "(currentDate: dayjs) => boolean", "description": "Function that specifies the dates that cannot be selected, Default: -" }, "a-calendar/fullscreen": { "type": "boolean", "description": "Whether to display in full-screen, Default: `true`" }, "a-calendar/headerRender": { "type": "v-slot:headerRender=\"{value: dayjs, type: string, onChange: f(), onTypeChange: f()}\"", "description": "render custom header in panel, Default: -" }, "a-calendar/locale": { "type": "object", "description": "The calendar's locale, Default: [default](https://github.com/vueComponent/ant-design-vue/blob/main/components/date-picker/locale/example.json)" }, "a-calendar/mode": { "type": "`month` | `year`", "description": "The display mode of the calendar, Default: `month`" }, "a-calendar/monthCellRender": { "type": "v-slot:monthCellRender=\"{current: dayjs}\"", "description": "Customize the display of the month cell by setting a scoped slot, the returned content will be appended to the cell, Default: -" }, "a-calendar/monthFullCellRender": { "type": "v-slot:monthFullCellRender=\"{current: dayjs}\"", "description": "Customize the display of the month cell by setting a scoped slot, the returned content will override the cell, Default: -" }, "a-calendar/validRange": { "type": "[[dayjs](https://day.js.org/), [dayjs](https://day.js.org/)]", "description": "to set valid range, Default: -" }, "a-calendar/value(v-model)": { "type": "[dayjs](https://day.js.org/)", "description": "The current selected date, Default: current date" }, "a-calendar/valueFormat": { "type": "string, [date formats](https://day.js.org/docs/en/display/format)", "description": "optional, format of binding value. If not specified, the binding value will be a Date object, Default: -" }, "a-card/activeTabKey": { "type": "string", "description": "Current TabPane's key, Default: -" }, "a-card/bodyStyle": { "type": "object", "description": "Inline style to apply to the card content, Default: -" }, "a-card/bordered": { "type": "boolean", "description": "Toggles rendering of the border around the card, Default: `true`" }, "a-card/defaultActiveTabKey": { "type": "string", "description": "Initial active TabPane's key, if `activeTabKey` is not set., Default: -" }, "a-card/extra": { "type": "-", "description": "Content to render in the top-right corner of the card, Default: " }, "a-card/headStyle": { "type": "object", "description": "Inline style to apply to the card head, Default: -" }, "a-card/hoverable": { "type": "boolean", "description": "Lift up when hovering card, Default: false" }, "a-card/loading": { "type": "boolean", "description": "Shows a loading indicator while the contents of the card are being fetched, Default: false" }, "a-card/size": { "type": "`default` | `small`", "description": "Size of card, Default: `default`" }, "a-card/tabList": { "type": "Array&lt;{key: string, tab: any}>", "description": "List of TabPane's head, Custom tabs with the customTab(v3.0) slot, Default: -" }, "a-card/title": { "type": "-", "description": "Card title, Default: " }, "a-card/type": { "type": "string", "description": "Card style type, can be set to `inner` or not set, Default: -" }, "a-card/actions": { "type": "-", "description": "The action list, shows at the bottom of the Card., Default: " }, "a-card/cover": { "type": "-", "description": "Card cover, Default: " }, "a-card/customTab": { "type": "{ item: tabList[number] }", "description": "custom tabList tab, Default: " }, "a-card/tabBarExtraContent": { "type": "-", "description": "Extra content in tab bar, Default: " }, "a-card-meta/avatar": { "type": "slot", "description": "avatar or icon, Default: -" }, "a-card-meta/description": { "type": "string|slot", "description": "description content, Default: -" }, "a-card-meta/title": { "type": "string|slot", "description": "title content, Default: -" }, "a-carousel/autoplay": { "type": "boolean", "description": "Whether to scroll automatically, Default: `false`" }, "a-carousel/dotPosition": { "type": "string", "description": "The position of the dots, which can be one of `top` `bottom` `left` `right`, Default: `bottom`" }, "a-carousel/dots": { "type": "boolean", "description": "Whether to show the dots at the bottom of the gallery, Default: `true`" }, "a-carousel/dotsClass": { "type": "string", "description": "Class name of the dots, Default: `slick-dots`" }, "a-carousel/easing": { "type": "string", "description": "Transition interpolation function name, Default: `linear`" }, "a-carousel/effect": { "type": "`scrollx` | `fade`", "description": "Transition effect, Default: `scrollx`" }, "a-carousel/afterChange": { "type": "function(current)", "description": "Callback function called after the current index changes, Default: -" }, "a-carousel/beforeChange": { "type": "function(from, to)", "description": "Callback function called before the current index changes, Default: -" }, "a-cascader/allowClear": { "type": "boolean", "description": "whether allow clear, Default: true" }, "a-cascader/autofocus": { "type": "boolean", "description": "get focus when component mounted, Default: false" }, "a-cascader/bordered": { "type": "boolean", "description": "Whether has border style, Default: true" }, "a-cascader/clearIcon": { "type": "slot", "description": "The custom clear icon, Default: -" }, "a-cascader/changeOnSelect": { "type": "boolean", "description": "(Work on single select) change value on each selection if set to true, see above demo for details, Default: false" }, "a-cascader/disabled": { "type": "boolean", "description": "whether disabled select, Default: false" }, "a-cascader/displayRender": { "type": "`({labels, selectedOptions}) => VNode`", "description": "render function of displaying selected options, you can use #displayRender=\"{labels, selectedOptions}\"., Default: `labels => labels.join(' / ')`" }, "a-cascader/popupClassName": { "type": "string", "description": "additional className of popup overlay, Default: -" }, "a-cascader/dropdownStyle": { "type": "CSSProperties", "description": "additional style of popup overlay, Default: {}" }, "a-cascader/expandIcon": { "type": "slot", "description": "Customize the current item expand icon, Default: -" }, "a-cascader/expandTrigger": { "type": "`click` | `hover`", "description": "expand current item when click or hover, Default: 'click'" }, "a-cascader/fieldNames": { "type": "object", "description": "custom field name for label and value and children, Default: `{ label: 'label', value: 'value', children: 'children' }`" }, "a-cascader/getPopupContainer": { "type": "Function(triggerNode)", "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" }, "a-cascader/loadData": { "type": "`(selectedOptions) => void`", "description": "To load option lazily, and it cannot work with `showSearch`, Default: -" }, "a-cascader/maxTagCount": { "type": "number | `responsive`", "description": "Max tag count to show. `responsive` will cost render performance, Default: -" }, "a-cascader/maxTagPlaceholder": { "type": "v-slot | function(omittedValues)", "description": "Placeholder for not showing tags, Default: -" }, "a-cascader/multiple": { "type": "boolean", "description": "Support multiple or not, Default: -" }, "a-cascader/notFoundContent": { "type": "string | slot", "description": "Specify content to show when no result matches., Default: 'Not Found'" }, "a-cascader/open": { "type": "boolean", "description": "set visible of cascader popup, Default: -" }, "a-cascader/options": { "type": "[Option](#option)[]", "description": "data options of cascade, Default: -" }, "a-cascader/placeholder": { "type": "string", "description": "input placeholder, Default: 'Please select'" }, "a-cascader/placement": { "type": "`bottomLeft` | `bottomRight` | `topLeft` | `topRight`", "description": "Use preset popup align config from builtinPlacements, Default: `bottomLeft`" }, "a-cascader/removeIcon": { "type": "slot", "description": "The custom remove icon, Default: -" }, "a-cascader/searchValue": { "type": "string", "description": "Set search value, Need work with `showSearch`, Default: -" }, "a-cascader/showSearch": { "type": "boolean | [object](#showsearch)", "description": "Whether show search input in single mode., Default: false" }, "a-cascader/size": { "type": "`large` | `default` | `small`", "description": "input size, Default: `default`" }, "a-cascader/status": { "type": "'error' | 'warning'", "description": "Set validation status, Default: -" }, "a-cascader/suffixIcon": { "type": "string | VNode | slot", "description": "The custom suffix icon, Default: -" }, "a-cascader/showCheckedStrategy": { "type": "`Cascader.SHOW_PARENT` | `Cascader.SHOW_CHILD`", "description": "The way show selected item in box. ** `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`" }, "a-cascader/tagRender": { "type": "slot", "description": "Customize tag render when `multiple`, Default: -" }, "a-cascader/value(v-model)": { "type": "string[] | number[]", "description": "selected value, Default: -" }, "a-checkbox/autofocus": { "type": "boolean", "description": "get focus when component mounted, Default: false" }, "a-checkbox/checked(v-model)": { "type": "boolean", "description": "Specifies whether the checkbox is selected., Default: false" }, "a-checkbox/disabled": { "type": "boolean", "description": "Disable all checkboxes, Default: false" }, "a-checkbox/indeterminate": { "type": "boolean", "description": "indeterminate checked state of checkbox, Default: false" }, "a-checkbox/value": { "type": "boolean | string | number", "description": "value of checkbox in CheckboxGroup, Default: -" }, "a-checkbox/name": { "type": "string", "description": "The `name` property of all `input[type=\"checkbox\"]` children, Default: -" }, "a-checkbox/options": { "type": "string[] | Array&lt;{ label: string value: string disabled?: boolean, indeterminate?: boolean, onChange?: function }>", "description": "Specifies options, you can customize `label` with slot = \"label\" slot-scope=\"option\", Default: \\[]" }, "a-checkbox/value(v-model)": { "type": "(boolean | string | number)[]", "description": "Used for setting the currently selected value., Default: \\[]" }, "a-checkbox/blur()": { "type": "", "description": "remove focus, Default: undefined" }, "a-checkbox/focus()": { "type": "", "description": "get focus, Default: undefined" }, "a-collapse/accordion": { "type": "boolean", "description": "If `true`, `Collapse` renders as `Accordion`, Default: `false`" }, "a-collapse/activeKey(v-model)": { "type": "string[] | string <br> number[] | number", "description": "Key of the active panel, Default: No default value. In `accordion` mode, it's the key of the first panel." }, "a-collapse/bordered": { "type": "boolean", "description": "Toggles rendering of the border around the collapse block, Default: `true`" }, "a-collapse/collapsible": { "type": "`header` | `icon` | `disabled`", "description": "Specify whether the panels of children be collapsible or the trigger area of collapsible, Default: -" }, "a-collapse/destroyInactivePanel": { "type": "boolean", "description": "Destroy Inactive Panel, Default: `false`" }, "a-collapse/expandIcon": { "type": "Function(props):VNode | v-slot:expandIcon=\"props\"", "description": "allow to customize collapse icon, Default: " }, "a-collapse/expandIconPosition": { "type": "`start` | `end`", "description": "Set expand icon position, Default: -" }, "a-collapse/ghost": { "type": "boolean", "description": "Make the collapse borderless and its background transparent, Default: false" }, "a-collapse-panel/collapsible": { "type": "`header` | `disabled`", "description": "Specify whether the panel be collapsible or the trigger area of collapsible, Default: -" }, "a-collapse-panel/disabled": { "type": "boolean", "description": "If `true`, panel cannot be opened or closed, Default: `false`" }, "a-collapse-panel/extra": { "type": "VNode | slot", "description": "extra element in the corner, Default: -" }, "a-collapse-panel/forceRender": { "type": "boolean", "description": "Forced render of content on panel, instead of lazy rending after clicking on header, Default: `false`" }, "a-collapse-panel/header": { "type": "string | slot", "description": "Title of the panel, Default: -" }, "a-collapse-panel/key": { "type": "string | number", "description": "Unique key identifying the panel from among its siblings, Default: -" }, "a-collapse-panel/showArrow": { "type": "boolean", "description": "If `false`, panel will not show arrow icon, Default: `true`" }, "a-comment/actions": { "type": "Array | slot", "description": "List of action items rendered below the comment content, Default: -" }, "a-comment/author": { "type": "string|slot", "description": "The element to display as the comment author, Default: -" }, "a-comment/avatar": { "type": "string|slot", "description": "The element to display as the comment avatar - generally an antd `Avatar` or src, Default: -" }, "a-comment/content": { "type": "string|slot", "description": "The main content of the comment, Default: -" }, "a-comment/datetime": { "type": "string|slot", "description": "A datetime element containing the time to be displayed, Default: -" }, "a-config-provider/autoInsertSpaceInButton": { "type": "boolean", "description": "Set `false` to remove space between 2 chinese characters on Button, Default: true" }, "a-config-provider/componentSize": { "type": "`small` | `middle` | `large`", "description": "Config antd component size, Default: -" }, "a-config-provider/csp": { "type": "{ nonce: string }", "description": "Set [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) config, Default: -" }, "a-config-provider/direction": { "type": "`ltr` | `rtl`", "description": "Set direction of layout. See [demo](#components-config-provider-demo-direction), Default: `ltr`" }, "a-config-provider/dropdownMatchSelectWidth": { "type": "boolean | number", "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: -" }, "a-config-provider/form": { "type": "{ validateMessages?: [ValidateMessages](/components/form/#validatemessages), requiredMark?: boolean | `optional` }", "description": "Set Form common props, Default: -" }, "a-config-provider/getPopupContainer": { "type": "Function(triggerNode, dialogContext)", "description": "to set the container of the popup element. The default is to create a `div` element in `body`., Default: `() => document.body`" }, "a-config-provider/getTargetContainer": { "type": "() => HTMLElement", "description": "Config Affix, Anchor scroll target container, Default: () => window" }, "a-config-provider/input": { "type": "{ autocomplete?: string }", "description": "Set Input common props, Default: -" }, "a-config-provider/locale": { "type": "object", "description": "language package setting, you can find the packages in [ant-design-vue/es/locale](http://unpkg.com/ant-design-vue/es/locale/), Default: -" }, "a-config-provider/pageHeader": { "type": "{ ghost:boolean }", "description": "Unify the ghost of pageHeader ,Ref [pageHeader]\\(&lt;(/components/page-header)>, Default: 'true'" }, "a-config-provider/prefixCls": { "type": "string", "description": "set prefix class, Default: ant" }, "a-config-provider/renderEmpty": { "type": "slot-scope | Function(componentName: string): VNode", "description": "set empty content of components. Ref [Empty](/components/empty/), Default: -" }, "a-config-provider/space": { "type": "{ size: `small` | `middle` | `large` | `number` }", "description": "Set Space `size`, ref [Space](/components/space), Default: -" }, "a-config-provider/transformCellText": { "type": "Function({ text, column, record, index }) => any", "description": "Table data can be changed again before rendering. The default configuration of general user empty data., Default: -" }, "a-config-provider/virtual": { "type": "boolean", "description": "Disable virtual scroll when set to false, Default: true" }, "a-config-provider/wave": { "type": "{ disabled?: boolean }", "description": "Config wave effect, Default: -" }, "a-date-picker/allowClear": { "type": "boolean", "description": "Whether to show clear button, Default: true" }, "a-date-picker/autofocus": { "type": "boolean", "description": "If get focus when component mounted, Default: false" }, "a-date-picker/bordered": { "type": "boolean", "description": "Whether has border style, Default: true" }, "a-date-picker/dateRender": { "type": "v-slot:dateRender=\"{current, today}\"", "description": "Custom rendering function for date cells, Default: -" }, "a-date-picker/disabled": { "type": "boolean", "description": "Determine whether the DatePicker is disabled, Default: false" }, "a-date-picker/disabledDate": { "type": "(currentDate: dayjs) => boolean", "description": "Specify the date that cannot be selected, Default: -" }, "a-date-picker/format": { "type": "[formatType](#formattype)", "description": "To set the date format, refer to [dayjs](https://day.js.org/). When an array is provided, all values are used for parsing and first value is used for formatting, support [Custom Format](#components-date-picker-demo-format), Default: `YYYY-MM-DD`" }, "a-date-picker/dropdownClassName": { "type": "string", "description": "To customize the className of the popup calendar, Default: -" }, "a-date-picker/getPopupContainer": { "type": "function(trigger)", "description": "To set the container of the floating layer, while the default is to create a `div` element in `body`, Default: -" }, "a-date-picker/inputReadOnly": { "type": "boolean", "description": "Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices), Default: false" }, "a-date-picker/locale": { "type": "object", "description": "Localization configuration, Default: [default](https://github.com/vueComponent/ant-design-vue/blob/main/components/date-picker/locale/example.json)" }, "a-date-picker/mode": { "type": "`time` | `date` | `month` | `year` | `decade`", "description": "The picker panel mode, Default: -" }, "a-date-picker/nextIcon": { "type": "slot", "description": "The custom next icon, Default: -" }, "a-date-picker/open": { "type": "boolean", "description": "The open state of picker, Default: -" }, "a-date-picker/picker": { "type": "`date` | `week` | `month` | `quarter` | `year`", "description": "Set picker type, Default: `date`" }, "a-date-picker/placeholder": { "type": "string | [string,string]", "description": "The placeholder of date input, Default: -" }, "a-date-picker/placement": { "type": "`bottomLeft` `bottomRight` `topLeft` `topRight`", "description": "The position where the selection box pops up, Default: bottomLeft" }, "a-date-picker/popupStyle": { "type": "CSSProperties", "description": "To customize the style of the popup calendar, Default: {}" }, "a-date-picker/presets": { "type": "{ label: slot, value: [dayjs](https://day.js.org/) }[]", "description": "The preset ranges for quick selection, Default: -" }, "a-date-picker/prevIcon": { "type": "slot", "description": "The custom prev icon, Default: -" }, "a-date-picker/size": { "type": "`large` | `middle` | `small`", "description": "To determine the size of the input box, the height of `large` and `small`, are 40px and 24px respectively, while default size is 32px, Default: -" }, "a-date-picker/status": { "type": "'error' | 'warning'", "description": "Set validation status, Default: -" }, "a-date-picker/suffixIcon": { "type": "v-slot:suffixIcon", "description": "The custom suffix icon, Default: -" }, "a-date-picker/superNextIcon": { "type": "slot", "description": "The custom super next icon, Default: -" }, "a-date-picker/superPrevIcon": { "type": "slot", "description": "The custom super prev icon, Default: -" }, "a-date-picker/valueFormat": { "type": "string, [date formats](https://day.js.org/docs/en/display/format)", "description": "optional, format of binding value. If not specified, the binding value will be a Date object, Default: -" }, "a-descriptions/bordered": { "type": "boolean", "description": "whether to display the border, Default: false" }, "a-descriptions/colon": { "type": "boolean", "description": "change default props `colon` value of `Descriptions.Item`, Default: true" }, "a-descriptions/column": { "type": "number", "description": "the number of `DescriptionItems` in a row,could be a number or a object like `{ xs: 8, sm: 16, md: 24}`,(Only set `bordered={true}` to take effect), Default: 3" }, "a-descriptions/contentStyle": { "type": "CSSProperties", "description": "Customize content style, Default: -" }, "a-descriptions/extra": { "type": "string | VNode | slot", "description": "The action area of the description list, placed at the top-right, Default: -" }, "a-descriptions/labelStyle": { "type": "CSSProperties", "description": "Customize label style, Default: -" }, "a-descriptions/layout": { "type": "`horizontal` | `vertical`", "description": "Define description layout, Default: `horizontal`" }, "a-descriptions/size": { "type": "`default` | `middle` | `small`", "description": "set the size of the list. Can be set to `middle`,`small`, or not filled, Default: `default`" }, "a-descriptions/title": { "type": "string | VNode | slot", "description": "The title of the description list, placed at the top, Default: -" }, "a-divider/dashed": { "type": "boolean", "description": "whether line is dashed, Default: false" }, "a-divider/orientation": { "type": "`left` | `right` | `center`", "description": "position of title inside divider, Default: `center`" }, "a-divider/orientationMargin": { "type": "string | number", "description": "The margin-left/right between the title and its closest border, while the `orientation` must be `left` or `right`, Default: -" }, "a-divider/plain": { "type": "boolean", "description": "Divider text show as plain style, Default: true" }, "a-divider/type": { "type": "`horizontal` | `vertical`", "description": "direction type of divider, Default: `horizontal`" }, "a-drawer/autofocus": { "type": "boolean", "description": "Whether Drawer should get focused after open, Default: true" }, "a-drawer/bodyStyle": { "type": "CSSProperties", "description": "Style of the drawer content part, Default: -" }, "a-drawer/class": { "type": "string", "description": "Config Drawer Panel className. Use `rootClassName` if want to config top dom style, Default: -" }, "a-drawer/closable": { "type": "boolean", "description": "Whether a close (x) button is visible on top left of the Drawer dialog or not, Default: true" }, "a-drawer/closeIcon": { "type": "VNode | slot", "description": "Custom close icon, Default: `<CloseOutlined />`" }, "a-drawer/contentWrapperStyle": { "type": "CSSProperties", "description": "Style of the drawer wrapper of content part, Default: -" }, "a-drawer/destroyOnClose": { "type": "boolean", "description": "Whether to unmount child components on closing drawer or not, Default: false" }, "a-drawer/extra": { "type": "VNode | slot", "description": "Extra actions area at corner, Default: -" }, "a-drawer/footer": { "type": "VNode | slot", "description": "The footer for Drawer, Default: -" }, "a-drawer/footerStyle": { "type": "CSSProperties", "description": "Style of the drawer footer part, Default: -" }, "a-drawer/forceRender": { "type": "boolean", "description": "Prerender Drawer component forcely, Default: false" }, "a-drawer/getContainer": { "type": "HTMLElement | `() => HTMLElement` | Selectors", "description": "mounted node and display window for Drawer, Default: 'body'" }, "a-drawer/headerStyle": { "type": "CSSProperties", "description": "Style of the drawer header part, Default: -" }, "a-drawer/height": { "type": "string | number", "description": "Placement is `top` or `bottom`, height of the Drawer dialog, Default: 378" }, "a-drawer/keyboard": { "type": "boolean", "description": "Whether support press esc to close, Default: true" }, "a-drawer/mask": { "type": "Boolean", "description": "Whether to show mask or not, Default: true" }, "a-drawer/maskClosable": { "type": "boolean", "description": "Clicking on the mask (area outside the Drawer) to close the Drawer or not, Default: true" }, "a-drawer/maskStyle": { "type": "CSSProperties", "description": "Style for Drawer's mask element, Default: {}" }, "a-drawer/placement": { "type": "'top' | 'right' | 'bottom' | 'left'", "description": "The placement of the Drawer, Default: 'right'" }, "a-drawer/push": { "type": "boolean | {distance: string | number}", "description": "Nested drawers push behavior, Default: { distance: 180 }" }, "a-drawer/rootClassName": { "type": "string", "description": "The class name of the container of the Drawer dialog, Default: -" }, "a-drawer/rootStyle": { "type": "CSSProperties", "description": "Style of wrapper element which **contains mask** compare to `style`, Default: -" }, "a-drawer/style": { "type": "CSSProperties", "description": "Style of wrapper element which contains mask compare to drawerStyle, Default: -" }, "a-drawer/size": { "type": "`default` | `large`", "description": "presetted size of drawer, default `378px` and large `736px`, Default: `default`" }, "a-drawer/title": { "type": "string | slot", "description": "The title for Drawer, Default: -" }, "a-drawer/open(v-model)": { "type": "boolean", "description": "Whether the Drawer dialog is visible or not, Default: -" }, "a-drawer/width": { "type": "string | number", "description": "Width of the Drawer dialog, Default: 378" }, "a-drawer/zIndex": { "type": "Number", "description": "The `z-index` of the Drawer, Default: 1000" }, "a-empty/description": { "type": "string | v-slot", "description": "Customize description, Default: -" }, "a-empty/image": { "type": "string | v-slot", "description": "Customize image. Will tread as image url when string provided, Default: false" }, "a-empty/imageStyle": { "type": "CSSProperties", "description": "style of image, Default: -" }, "a-dropdown/align": { "type": "Object", "description": "this value will be merged into placement's config, please refer to the settings [dom-align](https://github.com/yiminghe/dom-align), Default: -" }, "a-dropdown/arrow": { "type": "boolean | { pointAtCenter: boolean }", "description": "Whether the dropdown arrow should be open, Default: false" }, "a-dropdown/destroyPopupOnHide": { "type": "boolean", "description": "Whether destroy dropdown when hidden, Default: false" }, "a-dropdown/disabled": { "type": "boolean", "description": "whether the dropdown menu is disabled, Default: -" }, "a-dropdown/getPopupContainer": { "type": "Function(triggerNode)", "description": "to set the container of the dropdown menu. The default is to create a `div` element in `body`, you can reset it to the scrolling area and make a relative reposition. [example](https://codepen.io/afc163/pen/zEjNOy?editors=0010), Default: `() => document.body`" }, "a-dropdown/overlay(v-slot)": { "type": "[Menu](/components/menu)", "description": "the dropdown menu, Default: -" }, "a-dropdown/overlayClassName": { "type": "string", "description": "Class name of the dropdown root element, Default: -" }, "a-dropdown/overlayStyle": { "type": "object", "description": "Style of the dropdown root element, Default: -" }, "a-dropdown/placement": { "type": "String", "description": "placement of pop menu: `bottomLeft` `bottom` `bottomRight` `topLeft` `top` `topRight`, Default: `bottomLeft`" }, "a-dropdown/trigger": { "type": "Array&lt;`click`|`hover`|`contextmenu`>", "description": "the trigger mode which executes the drop-down action, hover doesn't work on mobile device, Default: `['hover']`" }, "a-dropdown/open(v-model)": { "type": "boolean", "description": "whether the dropdown menu is open, Default: -" }, "a-dropdown-button/disabled": { "type": "boolean", "description": "whether the dropdown menu is disabled, Default: -" }, "a-dropdown-button/icon": { "type": "vNode | slot", "description": "Icon (appears on the right), Default: -" }, "a-dropdown-button/loading": { "type": "boolean | { delay: number }", "description": "Set the loading status of button, Default: false" }, "a-dropdown-button/overlay(v-slot)": { "type": "[Menu](/components/menu)", "description": "the dropdown menu, Default: -" }, "a-dropdown-button/placement": { "type": "String", "description": "placement of pop menu: `bottomLeft` `bottom` `bottomRight` `topLeft` `top` `topRight`, Default: `bottomLeft`" }, "a-dropdown-button/size": { "type": "string", "description": "size of the button, the same as [Button](/components/button), Default: `default`" }, "a-dropdown-button/trigger": { "type": "Array&lt;`click`|`hover`|`contextmenu`>", "description": "the trigger mode which executes the drop-down action, Default: `['hover']`" }, "a-dropdown-button/type": { "type": "string", "description": "type of the button, the same as [Button](/components/button), Default: `default`" }, "a-dropdown-button/open(v-model)": { "type": "boolean", "description": "whether the dropdown menu is open, Default: -" }, "a-flex/vertical": { "type": "boolean", "description": "Is direction of the flex vertical, use `flex-direction: column`, Default: `false`" }, "a-flex/wrap": { "type": "reference [flex-wrap](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-wrap)", "description": "Set whether the element is displayed in a single line or in multiple lines, Default: nowrap" }, "a-flex/justify": { "type": "reference [justify-content](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content)", "description": "Sets the alignment of elements in the direction of the main axis, Default: normal" }, "a-flex/align": { "type": "reference [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)", "description": "Sets the alignment of elements in the direction of the cross axis, Default: normal" }, "a-flex/flex": { "type": "reference [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex)", "description": "flex CSS shorthand properties, Default: normal" }, "a-flex/gap": { "type": "`small` | `middle` | `large` | string | number", "description": "Sets the gap between grids, Default: -" }, "a-flex/component": { "type": "Component", "description": "custom element type, Default: `div`" }, "a-float-button/icon": { "type": "slot", "description": "Set the icon component of button, Default: -" }, "a-float-button/description": { "type": "string | slot", "description": "Text and other, Default: -" }, "a-float-button/tooltip": { "type": "string | slot", "description": "The text shown in the tooltip, Default: " }, "a-float-button/type": { "type": "`default` | `primary`", "description": "Setting button type, Default: `default`" }, "a-float-button/shape": { "type": "`circle` | `square`", "description": "Setting button shape, Default: `circle`" }, "a-float-button/href": { "type": "string", "description": "The target of hyperlink, Default: -" }, "a-float-button/target": { "type": "string", "description": "Specifies where to display the linked URL, Default: -" }, "a-float-button/badge": { "type": "[BadgeProps](/components/badge#api)", "description": "Attach Badge to FloatButton. `status` and other props related are not supported., Default: -" }, "a-form/colon": { "type": "boolean", "description": "change default props colon value of Form.Item (only effective when prop layout is horizontal), Default: true" }, "a-form/disabled": { "type": "boolean", "description": "Set form component disable, only available for antdv components, Default: false" }, "a-form/hideRequiredMark": { "type": "Boolean", "description": "Hide required mark of all form items, Default: false" }, "a-form/labelAlign": { "type": "'left' | 'right'", "description": "text align of label of all items, Default: 'right'" }, "a-form/labelCol": { "type": "[object](/components/grid/#col)", "description": "The layout of label. You can set `span` `offset` to something like `{span: 3, offset: 12}` or `sm: {span: 3, offset: 12}` same as with `<Col>`, Default: " }, "a-form/labelWrap": { "type": "boolean", "description": "whether label can be wrap, Default: false" }, "a-form/layout": { "type": "'horizontal'|'vertical'|'inline'", "description": "Define form layout, Default: 'horizontal'" }, "a-form/model": { "type": "object", "description": "data of form component, Default: " }, "a-form/name": { "type": "string", "description": "Form name. Will be the prefix of Field `id`, Default: -" }, "a-form/noStyle": { "type": "boolean", "description": "No style for `true`, used as a pure field control, Default: false" }, "a-form/rules": { "type": "object", "description": "validation rules of form, Default: " }, "a-form/scrollToFirstError": { "type": "boolean | [options](https://github.com/stipsan/scroll-into-view-if-needed/#options)", "description": "Auto scroll to first failed field when submit, Default: false" }, "a-form/validateOnRuleChange": { "type": "boolean", "description": "whether to trigger validation when the `rules` prop is changed, Default: true" }, "a-form/validateTrigger": { "type": "string | string[]", "description": "Config field validate trigger, Default: `change`" }, "a-form/wrapperCol": { "type": "[object](/components/grid/#col)", "description": "The layout for input controls, same as `labelCol`, Default: " }, "a-form-item/autoLink": { "type": "boolean", "description": "Whether to automatically associate form fields. In most cases, you can use automatic association. If the conditions for automatic association are not met, you can manually associate them. See the notes below., Default: true" }, "a-form-it