{
"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/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-balls when `：affix=\"false\"`, Default: false"
},
"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/getCurrentAnchor": {
"type": "() => string",
"description": "Customize the anchor highlight, Default: -"
},
"a-anchor/targetOffset": {
"type": "number",
"description": "Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetOffset), Default: `offsetTop`"
},
"a-autocomplete/allowClear": {
"type": "boolean",
"description": "Show clear button, effective in multiple mode only., Default: false"
},
"a-autocomplete/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-autocomplete/backfill": {
"type": "boolean",
"description": "backfill selected item the input when using keyboard, Default: false"
},
"a-autocomplete/#default (for customize input element)": {
"type": "HTMLInputElement / HTMLTextAreaElement",
"description": "customize input element, Default: ``"
},
"a-autocomplete/options": {
"type": "slot | [DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)[]",
"description": "Data source for autocomplete, Default: "
},
"a-autocomplete/dropdownMenuStyle": {
"type": "object",
"description": "additional style applied to dropdown menu, Default: "
},
"a-autocomplete/defaultActiveFirstOption": {
"type": "boolean",
"description": "Whether active first option by default, Default: true"
},
"a-autocomplete/disabled": {
"type": "boolean",
"description": "Whether disabled select, Default: false"
},
"a-autocomplete/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-autocomplete/optionLabelProp": {
"type": "string",
"description": "Which prop value of option will render as content of select., Default: `children`"
},
"a-autocomplete/placeholder": {
"type": "string",
"description": "placeholder of input, Default: -"
},
"a-autocomplete/v-model:value": {
"type": "string|string[]",
"description": "selected option, Default: { key: string, label: string\\"
},
"a-autocomplete/defaultOpen": {
"type": "boolean",
"description": "Initial open state of dropdown, Default: -"
},
"a-autocomplete/open": {
"type": "boolean",
"description": "Controlled open state of dropdown, Default: -"
},
"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/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/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-avatar/icon": {
"type": "VNode | slot",
"description": "the `Icon` type for an icon avatar, see `Icon` Component, Default: -"
},
"a-avatar/shape": {
"type": "`circle` | `square`",
"description": "the shape of avatar, Default: `circle`"
},
"a-avatar/size": {
"type": "number | `large` ",
"description": "The size of the avatar, Default: `small` \\"
},
"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/alt": {
"type": "string",
"description": "This attribute defines the alternative text describing the image, Default: -"
},
"a-avatar/gap": {
"type": "number",
"description": "Letter type unit distance between left and right sides, Default: 4"
},
"a-avatar/draggable": {
"type": "boolean | `'true'` ",
"description": "Whether the picture is allowed to be dragged, Default: `'false'`"
},
"a-avatar/loadError": {
"type": "() => boolean",
"description": "handler when img load error, return false to prevent default fallback behavior, 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/maxStyle": {
"type": "CSSProperties",
"description": "The style of excess avatar style, Default: -"
},
"a-avatar-group/size": {
"type": "number | `large` ",
"description": "The size of the avatar, Default: `small` \\"
},
"a-backtop/target": {
"type": "() => HTMLElement",
"description": "specifies the scrollable area dom node, Default: () => window"
},
"a-backtop/visibilityHeight": {
"type": "number",
"description": "the `BackTop` button will not show until the scroll height reaches this value, Default: 400"
},
"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": "`circle` | `round`",
"description": "can be set button shape, Default: -"
},
"a-button/size": {
"type": "`large` | `middle` ",
"description": "set the size of button, Default: `small`"
},
"a-button/target": {
"type": "string",
"description": "same as target attribute of a, works when href is specified, Default: -"
},
"a-button/type": {
"type": "`primary` | `ghost` ",
"description": "can be set button type, Default: `dashed` \\"
},
"a-calendar/dateCellRender": {
"type": "function(object: {current: moment})",
"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": "function(object: {current: moment})",
"description": "Customize the display of the date cell by setting a scoped slot, the returned content will override the cell, Default: -"
},
"a-calendar/defaultValue": {
"type": "[moment](http://momentjs.com/)",
"description": "The date selected by default, Default: default date"
},
"a-calendar/disabledDate": {
"type": "(currentDate: moment) => 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/locale": {
"type": "object",
"description": "The calendar's locale, Default: [default](https://github.com/vueComponent/ant-design-vue/blob/next/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": "function(object: {current: moment})",
"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": "function(object: {current: moment})",
"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": "[[moment](http://momentjs.com/), [moment](http://momentjs.com/)]",
"description": "to set valid range, Default: -"
},
"a-calendar/value(v-model)": {
"type": "[moment](http://momentjs.com/)",
"description": "The current selected date, Default: current date"
},
"a-calendar/headerRender": {
"type": "function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | v-slot",
"description": "render custom header in panel, Default: -"
},
"a-calendar/valueFormat": {
"type": "string，[date formats](https://momentjs.com/docs/#/displaying/format/)",
"description": "optional, format of binding value. If not specified, the binding value will be a Date object, Default: -"
},
"a-card/actions": {
"type": "slots",
"description": "The action list, shows at the bottom of the Card., Default: -"
},
"a-card/activeTabKey": {
"type": "string",
"description": "Current TabPane's key, Default: -"
},
"a-card/headStyle": {
"type": "object",
"description": "Inline style to apply to the card head, 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/cover": {
"type": "slot",
"description": "Card cover, Default: -"
},
"a-card/defaultActiveTabKey": {
"type": "string",
"description": "Initial active TabPane's key, if `activeTabKey` is not set., Default: -"
},
"a-card/extra": {
"type": "string|slot",
"description": "Content to render in the top-right corner of the card, 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/tabList": {
"type": "Array<{key: string, tab: any, slots: {tab: 'XXX'}}>",
"description": "List of TabPane's head, Custom tabs can be created with the slots property, Default: -"
},
"a-card/tabBarExtraContent": {
"type": "slot",
"description": "Extra content in tab bar, Default: -"
},
"a-card/size": {
"type": "`default` | `small`",
"description": "Size of card, Default: `default`"
},
"a-card/title": {
"type": "string|slot",
"description": "Card title, Default: -"
},
"a-card/type": {
"type": "string",
"description": "Card style type, can be set to `inner` or not set, 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/afterChange": {
"type": "function(current)",
"description": "Callback function called after the current index changes, Default: -"
},
"a-carousel/autoplay": {
"type": "boolean",
"description": "Whether to scroll automatically, Default: `false`"
},
"a-carousel/beforeChange": {
"type": "function(from, to)",
"description": "Callback function called before the current index changes, Default: -"
},
"a-carousel/dots": {
"type": "boolean",
"description": "Whether to show the dots at the bottom of the gallery, Default: `true`"
},
"a-carousel/dotPosition": {
"type": "string",
"description": "The position of the dots, which can be one of `top` `bottom` `left` `right`, Default: bottom"
},
"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-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/changeOnSelect": {
"type": "boolean",
"description": "change value on each selection if set to true, see above demo for details, Default: false"
},
"a-cascader/defaultValue": {
"type": "string[] | number[]",
"description": "initial selected value, Default: \\[]"
},
"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/expandTrigger": {
"type": "string",
"description": "expand current item when click or hover, one of 'click' '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/notFoundContent": {
"type": "string",
"description": "Specify content to show when no result matches., Default: 'Not Found'"
},
"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/popupClassName": {
"type": "string",
"description": "additional className of popup overlay, Default: -"
},
"a-cascader/popupStyle": {
"type": "object",
"description": "additional style of popup overlay, Default: {}"
},
"a-cascader/popupPlacement": {
"type": "string",
"description": "use preset popup align config from builtinPlacements：`bottomLeft` `bottomRight` `topLeft` `topRight`, Default: `bottomLeft`"
},
"a-cascader/popupVisible": {
"type": "boolean",
"description": "set visible of cascader popup, Default: -"
},
"a-cascader/showSearch": {
"type": "boolean | [object](#showsearch)",
"description": "Whether show search input in single mode., Default: false"
},
"a-cascader/size": {
"type": "string",
"description": "input size, one of `large` `default` `small`, Default: `default`"
},
"a-cascader/suffixIcon": {
"type": "string | VNode ",
"description": "The custom suffix icon, Default: slot"
},
"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/name": {
"type": "string",
"description": "The `name` property of all `input[type=\"checkbox\"]` children, Default: -"
},
"a-checkbox/options": {
"type": "string[] | Array<{ 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": "string[]",
"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/activeKey(v-model)": {
"type": "string[]|string",
"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/accordion": {
"type": "boolean",
"description": "If `true`, `Collapse` renders as `Accordion`, Default: `false`"
},
"a-collapse/expandIcon": {
"type": "Function(props):VNode | slot=\"expandIcon\" slot-scope=\"props\"",
"description": "allow to customize collapse icon, Default: #expandIcon=\"props\""
},
"a-collapse/expandIconPosition": {
"type": "`left`",
"description": "Set expand icon position: `left`, `right`, Default: -"
},
"a-collapse/destroyInactivePanel": {
"type": "boolean",
"description": "Destroy Inactive Panel, Default: `false`"
},
"a-collapse-panel/disabled": {
"type": "boolean",
"description": "If `true`, panel cannot be opened or closed, Default: `false`"
},
"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",
"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-collapse-panel/extra": {
"type": "VNode | slot",
"description": "extra element in the corner, Default: -"
},
"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-colorpicker/defaultValue": {
"type": "string",
"description": "default color, Default: -"
},
"a-colorpicker/config": {
"type": "[pickr options](https://github.com/Simonwep/pickr)",
"description": "pickr config, Default: -"
},
"a-colorpicker/value": {
"type": "string",
"description": "color value, Default: -"
},
"a-colorpicker/locale": {
"type": "[default setting](https://github.com/vueComponent/ant-design-vue/blob/next/components/color-picker/locale)",
"description": "locale package, Default: -"
},
"a-colorpicker/colorRounded": {
"type": "number",
"description": "precision of color, Default: 0"
},
"a-colorpicker/size": {
"type": "'large'|'small'",
"description": "size of pickr, Default: 'default'"
},
"a-colorpicker/getPopupContainer": {
"type": "Function(triggerNode)",
"description": "to set the container of the floating layer, while the default is to create a div element in body, Default: () => document.body"
},
"a-colorpicker/disabled": {
"type": "boolean",
"description": "whether disabled picker, Default: false"
},
"a-colorpicker/format": {
"type": "'HEXA' |'RGBA' ",
"description": "Color format, Default: 'HSVA' \\"
},
"a-configprovider/autoInsertSpaceInButton": {
"type": "boolean",
"description": "Set `false` to remove space between 2 chinese characters on Button, Default: true"
},
"a-configprovider/csp": {
"type": "{ nonce: string }",
"description": "Set [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) config, Default: -"
},
"a-configprovider/renderEmpty": {
"type": "slot-scope | Function(componentName: string): ReactNode",
"description": "set empty content of components. Ref [Empty](/components/empty/), Default: -"
},
"a-configprovider/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-configprovider/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-configprovider/prefixCls": {
"type": "string",
"description": "set prefix class, Default: ant"
},
"a-configprovider/pageHeader": {
"type": "{ ghost:boolean }",
"description": "Unify the ghost of pageHeader ,Ref [pageHeader](<(/components/page-header)>, Default: 'true'"
},
"a-configprovider/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-datepicker/allowClear": {
"type": "boolean",
"description": "Whether to show clear button, Default: true"
},
"a-datepicker/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-datepicker/dateRender": {
"type": "#dateRender=\"{current, today}\"",
"description": "custom rendering function for date cells by setting a slot, Default: -"
},
"a-datepicker/disabled": {
"type": "boolean",
"description": "determine whether the DatePicker is disabled, Default: false"
},
"a-datepicker/disabledDate": {
"type": "(currentDate: moment) => boolean",
"description": "specify the date that cannot be selected, Default: -"
},
"a-datepicker/getCalendarContainer": {
"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-datepicker/locale": {
"type": "object",
"description": "localization configuration, Default: [default](https://github.com/vueComponent/ant-design-vue/blob/next/components/date-picker/locale/example.json)"
},
"a-datepicker/mode": {
"type": "`time",
"description": "picker panel mode, Default: date"
},
"a-datepicker/open": {
"type": "boolean",
"description": "open state of picker, Default: -"
},
"a-datepicker/placeholder": {
"type": "string|RangePicker[]",
"description": "placeholder of date input, Default: -"
},
"a-datepicker/popupStyle": {
"type": "CSSProperties",
"description": "to customize the style of the popup calendar, Default: {}"
},
"a-datepicker/dropdownClassName": {
"type": "string",
"description": "to customize the class of the popup calendar, Default: -"
},
"a-datepicker/size": {
"type": "string",
"description": "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-datepicker/suffixIcon": {
"type": "VNode | slot",
"description": "The custom suffix icon, Default: -"
},
"a-datepicker/inputReadOnly": {
"type": "boolean",
"description": "Set the readonly attribute of the input tag (avoids virtual keyboard on touch devices), Default: -"
},
"a-datepicker/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-datepicker/valueFormat": {
"type": "string，[date formats](https://momentjs.com/docs/#/displaying/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/extra": {
"type": "string | VNode ",
"description": "The action area of the description list, placed at the top-right, Default: slot"
},
"a-descriptions/layout": {
"type": "`horizontal",
"description": "Define description layout, Default: vertical`"
},
"a-descriptions/size": {
"type": "`default",
"description": "set the size of the list. Can be set to `middle`,`small`, or not filled, Default: middle"
},
"a-descriptions/title": {
"type": "string | VNode ",
"description": "The title of the description list, placed at the top, Default: slot"
},
"a-descriptions/labelStyle": {
"type": "CSSProperties",
"description": "Customize label style, Default: -"
},
"a-descriptions/contentStyle": {
"type": "CSSProperties",
"description": "Customize content style, Default: -"
},
"a-divider/dashed": {
"type": "Boolean",
"description": "whether line is dashed, Default: false"
},
"a-divider/orientation": {
"type": "enum: `left` `right` `center`",
"description": "position of title inside divider, Default: `center`"
},
"a-divider/type": {
"type": "enum: `horizontal` `vertical`",
"description": "direction type of divider, Default: `horizontal`"
},
"a-divider/plain": {
"type": "boolean",
"description": "Divider text show as plain style, Default: true"
},
"a-drawer/closable": {
"type": "boolean",
"description": "Whether a close (x) button is visible on top right of the Drawer dialog or not., Default: true"
},
"a-drawer/destroyOnClose": {
"type": "boolean",
"description": "Whether to unmount child components on closing drawer or not., Default: false"
},
"a-drawer/getContainer": {
"type": "HTMLElement | `() => HTMLElement` ",
"description": "Return the mounted node for Drawer., Default: Selectors"
},
"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": "object",
"description": "Style for Drawer's mask element., Default: {}"
},
"a-drawer/title": {
"type": "string|slot",
"description": "The title for Drawer., Default: -"
},
"a-drawer/visible(v-model)": {
"type": "boolean",
"description": "Whether the Drawer dialog is visible or not., Default: false"
},
"a-drawer/wrapClassName": {
"type": "string",
"description": "The class name of the container of the Drawer dialog., Default: -"
},
"a-drawer/wrapStyle": {
"type": "object",
"description": "Style of wrapper element which **contains mask** compare to `drawerStyle`, Default: -"
},
"a-drawer/drawerStyle": {
"type": "object",
"description": "Style of the popup layer element, Default: -"
},
"a-drawer/headerStyle": {
"type": "object",
"description": "Style of the drawer header part, Default: -"
},
"a-drawer/bodyStyle": {
"type": "object",
"description": "Style of the drawer content part, Default: -"
},
"a-drawer/width": {
"type": "string|number",
"description": "Width of the Drawer dialog., Default: 256"
},
"a-drawer/height": {
"type": "string|number",
"description": "placement is `top` or `bottom`, height of the Drawer dialog., Default: -"
},
"a-drawer/zIndex": {
"type": "Number",
"description": "The `z-index` of the Drawer., Default: 1000"
},
"a-drawer/placement": {
"type": "'top' | 'right' ",
"description": "The placement of the Drawer., Default: 'bottom' \\"
},
"a-drawer/handle": {
"type": "VNode | slot",
"description": "After setting, the drawer is directly mounted on the DOM, and you can control the drawer to open or close through this `handle`., Default: -"
},
"a-drawer/afterVisibleChange": {
"type": "function(visible)",
"description": "Callback after the animation ends when switching drawers., Default: -"
},
"a-drawer/keyboard": {
"type": "Boolean",
"description": "Whether support press esc to close, Default: true"
},
"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` `bottomCenter` `bottomRight` `topLeft` `topCenter` `topRight`, Default: `bottomLeft`"
},
"a-dropdown/trigger": {
"type": "Array<`click`|`hover`",
"description": "the trigger mode which executes the drop-down action, hover doesn't work on mobile device, Default: `contextmenu`>"
},
"a-dropdown/visible(v-model)": {
"type": "boolean",
"description": "whether the dropdown menu is visible, 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/overlay(v-slot)": {
"type": "[Menu](/components/menu)",
"description": "the dropdown menu, Default: -"
},
"a-dropdown-button/placement": {
"type": "String",
"description": "placement of pop menu: `bottomLeft` `bottomCenter` `bottomRight` `topLeft` `topCenter` `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<`click`|`hover`",
"description": "the trigger mode which executes the drop-down action, Default: `contextmenu`>"
},
"a-dropdown-button/type": {
"type": "string",
"description": "type of the button, the same as [Button](/components/button), Default: `default`"
},
"a-dropdown-button/visible(v-model)": {
"type": "boolean",
"description": "whether the dropdown menu is visible, Default: -"
},
"a-empty/description": {
"type": "string | v-slot",
"description": "Customize description, Default: -"
},
"a-empty/imageStyle": {
"type": "CSSProperties",
"description": "style of image, Default: -"
},
"a-empty/image": {
"type": "string | v-slot",
"description": "Customize image. Will tread as image url when string provided, Default: false"
},
"a-form/model": {
"type": "object",
"description": "data of form component, Default: "
},
"a-form/rules": {
"type": "object",
"description": "validation rules of form, Default: "
},
"a-form/hideRequiredMark": {
"type": "Boolean",
"description": "Hide required mark of all form items, Default: false"
},
"a-form/layout": {
"type": "'horizontal'|'vertical'",
"description": "Define form layout, Default: 'inline'"
},
"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 `
`, Default: "
},
"a-form/wrapperCol": {
"type": "[object](/components/grid/#Col)",
"description": "The layout for input controls, same as `labelCol`, 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/validateOnRuleChange": {
"type": "boolean",
"description": "whether to trigger validation when the `rules` prop is changed, Default: true"
},
"a-form/name": {
"type": "string",
"description": "Form name. Will be the prefix of Field `id`, 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/validateTrigger": {
"type": "string | string[]",
"description": "Config field validate trigger, Default: `change`"
},
"a-form-item/name": {
"type": "string",
"description": "a key of `model`. In the use of validate and resetFields method, the attribute is required, Default: "
},
"a-form-item/rules": {
"type": "object | array",
"description": "validation rules of form, 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-item/colon": {
"type": "boolean",
"description": "Used with `label`, whether to display `:` after label text., Default: true"
},
"a-form-item/extra": {
"type": "string|slot",
"description": "The extra prompt message. It is similar to help. Usage example: to display error message and prompt message at the same time., Default: "
},
"a-form-item/hasFeedback": {
"type": "boolean",
"description": "Used with `validateStatus`, this option specifies the validation status icon. Recommended to be used only with `Input`., Default: false"
},
"a-form-item/help": {
"type": "string|slot",
"description": "The prompt message. If not provided, the prompt message will be generated by the validation rule., Default: "
},
"a-form-item/htmlFor": {
"type": "string",
"description": "Set sub label `htmlFor`., Default: "
},
"a-form-item/label": {
"type": "string|slot",
"description": "Label text, Default: "
},
"a-form-item/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 `
`, Default: "
},
"a-form-item/labelAlign": {
"type": "'left' | 'right'",
"description": "text align of label, Default: 'right'"
},
"a-form-item/required": {
"type": "boolean",
"description": "Whether provided or not, it will be generated by the validation rule., Default: false"
},
"a-form-item/validateStatus": {
"type": "string",
"description": "The validation status. If not provided, it will be generated by validation rule. options: 'success' 'warning' 'error' 'validating', Default: "
},
"a-form-item/wrapperCol": {
"type": "[object](/components/grid/#Col)",
"description": "The layout for input controls, same as `labelCol`, Default: "
},
"a-form-item/validateFirst": {
"type": "boolean",
"description": "Whether stop validate on first rule of error for this field., Default: false"
},
"a-form-item/validateTrigger": {
"type": "string | string[]",
"description": "When to validate the value of children node, Default: `change`"
},
"a-common/style": {
"type": "CSSProperties",
"description": "Style properties of icon, like `fontSize` and `color`, Default: -"
},
"a-common/spin": {
"type": "boolean",
"description": "Rotate icon with animation, Default: false"
},
"a-common/rotate": {
"type": "number",
"description": "Rotate by n degrees (not working in IE9), Default: -"
},
"a-common/twoToneColor": {
"type": "string (hex color)",
"description": "Only supports the two-tone icon. Specify the primary color., Default: -"
},
"a-custom/style": {
"type": "CSSProperties",
"description": "The computed style of the `svg` element, Default: -"
},
"a-custom/spin": {
"type": "boolean",
"description": "Rotate icon with animation, Default: false"
},
"a-custom/rotate": {
"type": "number",
"description": "Rotate degrees (not working in IE9), Default: -"
},
"a-custom/component": {
"type": "ComponentType",
"description": "The component used for the root node., Default: -"
},
"a-custom/scriptUrl": {
"type": "string",
"description": "The URL generated by [iconfont.cn](http://iconfont.cn/) project., Default: -"
},
"a-custom/extraCommonProps": {
"type": "`{ class, attrs, props, on, style }`",
"description": "Define extra properties to the component, Default: {}"
},
"a-custom/width": {
"type": "string | number",
"description": "The width of the `svg` element, Default: '1em'"
},
"a-custom/height": {
"type": "string | number",
"description": "The height of the `svg` element, Default: '1em'"
},
"a-custom/fill": {
"type": "string",
"description": "Define the color used to paint the `svg` element, Default: 'currentColor'"
},
"a-custom/class": {
"type": "string",
"description": "The computed class name of the `svg` element, Default: -"
},
"a-image/alt": {
"type": "string",
"description": "Image description, Default: -"
},
"a-image/fallback": {
"type": "string",
"description": "Load failure fault-tolerant src, Default: -"
},
"a-image/height": {
"type": "string | number",
"description": "Image height, Default: -"
},
"a-image/placeholder": {
"type": "boolean | slot",
"description": "Load placeholder, use default placeholder when set `true`, Default: -"
},
"a-image/preview": {
"type": "boolean | [previewType](#previewType)",
"description": "preview config, disabled when `false`, Default: true"
},
"a-image/src": {
"type": "string",
"description": "Image path, Default: -"
},
"a-image/width": {
"type": "string | number",
"description": "Image width, Default: -"
},
"a-inputnumber/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-inputnumber/defaultValue": {
"type": "number",
"description": "initial value, Default: "
},
"a-inputnumber/disabled": {
"type": "boolean",
"description": "disable the input, Default: false"
},
"a-inputnumber/formatter": {
"type": "function(value: number | string): string",
"description": "Specifies the format of the value presented, Default: -"
},
"a-inputnumber/max": {
"type": "number",
"description": "max value, Default: Infinity"
},
"a-inputnumber/min": {
"type": "number",
"description": "min value, Default: -Infinity"
},
"a-inputnumber/parser": {
"type": "function( string): number",
"description": "Specifies the value extracted from formatter, Default: -"
},
"a-inputnumber/precision": {
"type": "number",
"description": "precision of input value, Default: -"
},
"a-inputnumber/decimalSeparator": {
"type": "string",
"description": "decimal separator, Default: -"
},
"a-inputnumber/size": {
"type": "string",
"description": "height of input box, Default: -"
},
"a-inputnumber/step": {
"type": "number|string",
"description": "The number to which the current value is increased or decreased. It can be an integer or decimal., Default: 1"
},
"a-inputnumber/value(v-model)": {
"type": "number",
"description": "current value, Default: "
},
"a-input/addonAfter": {
"type": "string|slot",
"description": "The label text displayed after (on the right side of) the input field., Default: "
},
"a-input/addonBefore": {
"type": "string|slot",
"description": "The label text displayed before (on the left side of) the input field., Default: "
},
"a-input/defaultValue": {
"type": "string",
"description": "The initial input content, Default: "
},
"a-input/disabled": {
"type": "boolean",
"description": "Whether the input is disabled., Default: false"
},
"a-input/id": {
"type": "string",
"description": "The ID for input, Default: "
},
"a-input/maxlength": {
"type": "number",
"description": "max length, Default: "
},
"a-input/prefix": {
"type": "string|slot",
"description": "The prefix icon for the Input., Default: "
},
"a-input/size": {
"type": "string",
"description": "The size of the input box. Note: in the context of a form, the `large` size is used. Available: `large` `default` `small`, Default: `default`"
},
"a-input/suffix": {
"type": "string|slot",
"description": "The suffix icon for the Input., Default: "
},
"a-input/type": {
"type": "string",
"description": "The type of input, see: [MDN](https://developer.mozilla.org/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types)(use `Input.TextArea` instead of `type=\"textarea\"`), Default: `text`"
},
"a-input/value(v-model)": {
"type": "string",
"description": "The input content value, Default: "
},
"a-input/allowClear": {
"type": "boolean",
"description": "allow to remove input content with clear icon, Default: "
},
"a-input/change": {
"type": "function(e)",
"description": "callback when user input, Default: "
},
"a-input/pressEnter": {
"type": "function(e)",
"description": "The callback function that is triggered when Enter key is pressed., Default: undefined"
},
"a-input-text-area/autosize": {
"type": "false`or an object`{ minRows: 2, maxRows: 6 }`",
"description": "Height autosize feature, can be set to `true, Default: boolean|object"
},
"a-input-text-area/defaultValue": {
"type": "string",
"description": "The initial input content, Default: "
},
"a-input-text-area/value(v-model)": {
"type": "string",
"description": "The input content value, Default: "
},
"a-input-text-area/allowClear": {
"type": "boolean",
"description": "allow to remove input content with clear icon, Default: "
},
"a-input-text-area/showCount": {
"type": "boolean",
"description": "Whether show text count, Default: false"
},
"a-input-text-area/pressEnter": {
"type": "function(e)",
"description": "The callback function that is triggered when Enter key is pressed., Default: undefined"
},
"a-input-search/enterButton": {
"type": "boolean|slot",
"description": "to show an enter button after input. This prop is conflict with addon., Default: false"
},
"a-input-search/search": {
"type": "function(value, event)",
"description": "The callback function that is triggered when you click on the search-icon or press Enter key., Default: "
},
"a-input-search/loading": {
"type": "boolean",
"description": "Search box with loading., Default: "
},
"a-input-group/compact": {
"type": "boolean",
"description": "Whether use compact style, Default: false"
},
"a-input-group/size": {
"type": "string",
"description": "The size of `Input.Group` specifies the size of the included `Input` fields. Available: `large` `default` `small`, Default: `default`"
},
"a-input-password/visibilityToggle": {
"type": "boolean",
"description": "Whether show toggle button, Default: true"
},
"a-layout/class": {
"type": "string",
"description": "container className, Default: -"
},
"a-layout/style": {
"type": "object|string",
"description": "to customize the styles, Default: -"
},
"a-layout/hasSider": {
"type": "boolean",
"description": "whether contain Sider in children, don't have to assign it normally. Useful in ssr avoid style flickering, Default: -"
},
"a-layout-sider/breakpoint": {
"type": "Enum { 'xs', 'sm', 'md', 'lg', 'xl', 'xxl' }",
"description": "[breakpoints](/components/grid#api) of the responsive layout, Default: -"
},
"a-layout-sider/class": {
"type": "string",
"description": "container className, Default: -"
},
"a-layout-sider/collapsed(v-model)": {
"type": "boolean",
"description": "to set the current status, Default: -"
},
"a-layout-sider/collapsedWidth": {
"type": "number",
"description": "width of the collapsed sidebar, by setting to `0` a special trigger will appear, Default: 80"
},
"a-layout-sider/collapsible": {
"type": "boolean",
"description": "whether can be collapsed, Default: false"
},
"a-layout-sider/defaultCollapsed": {
"type": "boolean",
"description": "to set the initial status, Default: false"
},
"a-layout-sider/reverseArrow": {
"type": "boolean",
"description": "reverse direction of arrow, for a sider that expands from the right, Default: false"
},
"a-layout-sider/style": {
"type": "object|string",
"description": "to customize the styles, Default: -"
},
"a-layout-sider/theme": {
"type": "string: `light` `dark`",
"description": "color theme of the sidebar, Default: `dark`"
},
"a-layout-sider/trigger": {
"type": "string|slot",
"description": "specify the customized trigger, set to null to hide the trigger, Default: -"
},
"a-layout-sider/width": {
"type": "number|string",
"description": "width of the sidebar, Default: 200"
},
"a-layout-sider/zeroWidthTriggerStyle": {
"type": "object",
"description": "to customize the styles of the special trigger that appears when `collapsedWidth` is 0, Default: -"
},
"a-list/bordered": {
"type": "boolean",
"description": "Toggles rendering of the border around the list, Default: false"
},
"a-list/footer": {
"type": "string|slot",
"description": "List footer renderer, Default: -"
},
"a-list/grid": {
"type": "object",
"description": "The grid type of list. You can set grid to something like {gutter: 16, column: 4}, Default: -"
},
"a-list/header": {
"type": "string|slot",
"description": "List header renderer, Default: -"
},
"a-list/itemLayout": {
"type": "string",
"description": "The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical`, Default: -"
},
"a-list/rowKey": {
"type": "string|Function(record):string",
"description": "Item's unique key, could be a string or function that returns a string, Default: `key`"
},
"a-list/loading": {
"type": "boolean|[object](https://www.antdv.com/components/spin/#API)",
"description": "Shows a loading indicator while the contents of the list are being fetched, Default: false"
},
"a-list/loadMore": {
"type": "string|slot",
"description": "Shows a load more content, Default: -"
},
"a-list/locale": {
"type": "object",
"description": "i18n text including empty text, Default: emptyText: 'No Data' "
},
"a-list/pagination": {
"type": "boolean | object",
"description": "Pagination [config](https://www.antdv.com/components/pagination/#API), hide it by setting it to false, Default: false"
},
"a-list/split": {
"type": "boolean",
"description": "Toggles rendering of the split under the list item, Default: true"
},
"a-list/dataSource": {
"type": "any[]",
"description": "dataSource array for list, Default: -"
},
"a-list/renderItem": {
"type": "({item, index}) => vNode",
"description": "Custom item renderer, #renderItem=\"{item, index}\", Default: "
},
"a-list/column": {
"type": "number oneOf [ 1, 2, 3, 4, 6, 8, 12, 24]",
"description": "column of grid, Default: -"
},
"a-list/gutter": {
"type": "number",
"description": "spacing between grid, Default: 0"
},
"a-list/size": {
"type": "`default` | `middle` ",
"description": "Size of list, Default: `small`"
},
"a-list/xs": {
"type": "number",
"description": "`<576px` column of grid, Default: -"
},
"a-list/sm": {
"type": "number",
"description": "`≥576px` column of grid, Default: -"
},
"a-list/md": {
"type": "number",
"description": "`≥768px` column of grid, Default: -"
},
"a-list/lg": {
"type": "number",
"description": "`≥992px` column of grid, Default: -"
},
"a-list/xl": {
"type": "number",
"description": "`≥1200px` column of grid, Default: -"
},
"a-list/xxl": {
"type": "number",
"description": "`≥1600px` column of grid, Default: -"
},
"a-list-item/actions": {
"type": "Array|slot",
"description": "The actions content of list item. If `itemLayout` is `vertical`, shows the content on bottom, otherwise shows content on the far right., Default: -"
},
"a-list-item/extra": {
"type": "string|slot",
"description": "The extra content of list item. If `itemLayout` is `vertical`, shows the content on right, otherwise shows content on the far right., Default: -"
},
"a-list-item.-meta/avatar": {
"type": "slot",
"description": "The avatar of list item, Default: -"
},
"a-list-item.-meta/description": {
"type": "string|slot",
"description": "The description of list item, Default: -"
},
"a-list-item.-meta/title": {
"type": "string|slot",
"description": "The title of list item, Default: -"
},
"a-menu/forceSubMenuRender": {
"type": "boolean",
"description": "render submenu into DOM before it shows, Default: false"
},
"a-menu/inlineCollapsed": {
"type": "boolean",
"description": "specifies the collapsed status when menu is inline mode, Default: -"
},
"a-menu/inlineIndent": {
"type": "number",
"description": "indent px of inline menu item on each level, Default: 24"
},
"a-menu/mode": {
"type": "string: `vertical` | `vertical-right` ",
"description": "type of the menu; `vertical`, `horizontal`, and `inline` modes are supported, Default: `horizontal` \\"
},
"a-menu/multiple": {
"type": "boolean",
"description": "Allow selection of multiple items, Default: false"
},
"a-menu/openKeys(v-model)": {
"type": "string[]",
"description": "array with the keys of currently opened sub menus, Default: "
},
"a-menu/selectable": {
"type": "boolean",
"description": "allow selecting menu items, Default: true"
},
"a-menu/selectedKeys(v-model)": {
"type": "string[]",
"description": "array with the keys of currently selected menu items, Default: "
},
"a-menu/style": {
"type": "object",
"description": "style of the root node, Default: "
},
"a-menu/subMenuCloseDelay": {
"type": "number",
"description": "delay time to hide submenu when mouse leave, unit: second, Default: 0.1"
},
"a-menu/subMenuOpenDelay": {
"type": "number",
"description": "delay time to show submenu when mouse enter, unit: second, Default: 0"
},
"a-menu/theme": {
"type": "string: `light` `dark`",
"description": "color theme of the menu, Default: `light`"
},
"a-menu/overflowedIndicator": {
"type": "DOM",
"description": "Customized icon when menu is collapsed, Default: `···`"
},
"a-menu/click": {
"type": "function({ item, key, keyPath })",
"description": "callback executed when a menu item is clicked, Default: undefined"
},
"a-menu/deselect": {
"type": "function({ item, key, selectedKeys })",
"description": "callback executed when a menu item is deselected, only supported for multiple mode, Default: undefined"
},
"a-menu/openChange": {
"type": "function(openKeys: string[])",
"description": "called when open/close sub menu, Default: undefined"
},
"a-menu/select": {
"type": "function({ item, key, selectedKeys })",
"description": "callback executed when a menu item is selected, Default: undefined"
},
"a-menu-item/disabled": {
"type": "boolean",
"description": "whether menu item is disabled or not, Default: false"
},
"a-menu-item/key": {
"type": "string",
"description": "unique id of the menu item, Default: "
},
"a-menu-item/title": {
"type": "string",
"description": "set display title for collapsed item, Default: "
},
"a-menu-sub-menu/popupClassName": {
"type": "string",
"description": "Sub-menu class name, Default: "
},
"a-menu-sub-menu/disabled": {
"type": "boolean",
"description": "whether sub menu is disabled or not, Default: false"
},
"a-menu-sub-menu/key": {
"type": "string",
"description": "Unique ID of the sub menu, Default: "
},
"a-menu-sub-menu/title": {
"type": "string|slot",
"description": "title of the sub menu, Default: "
},
"a-menu-sub-menu/expandIcon": {
"type": "slot",
"description": "Customized expandIcon, Default: arrow icon"
},
"a-menu-sub-menu/titleClick": {
"type": "function({ key, domEvent })",
"description": "callback executed when the sub menu title is clicked, Default: undefined"
},
"a-menu-item-group/children": {
"type": "MenuItem[]",
"description": "sub-menu items, Default: "
},
"a-menu-item-group/title": {
"type": "string|slot",
"description": "title of the group, Default: "
},
"a-message/content": {
"type": "string| VNode",
"description": "content of the message, Default: -"
},
"a-message/duration": {
"type": "number",
"description": "time(seconds) before auto-dismiss, don't dismiss if set to 0, Default: 1.5"
},
"a-message/onClose": {
"type": "Function",
"description": "Specify a function that will be called when the message is closed, Default: -"
},
"a-modal/afterClose": {
"type": "function",
"description": "Specify a function that will be called when modal is closed completely., Default: -"
},
"a-modal/bodyStyle": {
"type": "object",
"description": "Body style for modal body element. Such as height, padding etc., Default: {}"
},
"a-modal/cancelText": {
"type": "string|slot",
"description": "Text of the Cancel button, Default: `Cancel`"
},
"a-modal/centered": {
"type": "Boolean",
"description": "Centered Modal, Default: `false`"
},
"a-modal/closable": {
"type": "boolean",
"description": "Whether a close (x) button is visible on top right of the modal dialog or not, Default: true"
},
"a-modal/closeIcon": {
"type": "VNode | slot",
"description": "custom close icon, Default: -"
},
"a-modal/confirmLoading": {
"type": "boolean",
"description": "Whether to apply loading visual effect for OK button or not, Default: false"
},
"a-modal/destroyOnClose": {
"type": "boolean",
"description": "Whether to unmount child components on onClose, Default: false"
},
"a-modal/footer": {
"type": "string|slot",
"description": "Footer content, set as `:footer=\"null\"` when you don't need default buttons, Default: OK and Cancel buttons"
},
"a-modal/forceRender": {
"type": "boolean",
"description": "Force render Modal, Default: false"
},
"a-modal/getContainer": {
"type": "(instance): HTMLElement",
"description": "Return the mount node for Modal, Default: () => document.body"
},
"a-modal/mask": {
"type": "Boolean",
"description": "Whether show mask or not., Default: true"
},
"a-modal/maskClosable": {
"type": "boolean",
"description": "Whether to close the modal dialog when the mask (area outside the modal) is clicked, Default: true"
},
"a-modal/maskStyle": {
"type": "object",
"description": "Style for modal's mask element., Default: {}"
},
"a-modal/okText": {
"type": "string|slot",
"description": "Text of the OK button, Default: `OK`"
},
"a-modal/okType": {
"type": "string",
"description": "Button `type` of the OK button, Default: `primary`"
},
"a-modal/okButtonProps": {
"type": "[ButtonProps](/components/button/#API)",
"description": "The ok button props, Default: -"
},
"a-modal/cancelButtonProps": {
"type": "[ButtonProps](/components/button/#API)",
"description": "The cancel button props, Default: -"
},
"a-modal/title": {
"type": "string|slot",
"description": "The modal dialog's title, Default: -"
},
"a-modal/visible": {
"type": "boolean",
"description": "Whether the modal dialog is visible or not, Default: false"
},
"a-modal/width": {
"type": "string|number",
"description": "Width of the modal dialog, Default: 520"
},
"a-modal/wrapClassName": {
"type": "string",
"description": "The class name of the container of the modal dialog, Default: -"
},
"a-modal/zIndex": {
"type": "Number",
"description": "The `z-index` of the Modal, Default: 1000"
},
"a-modal/dialogStyle": {
"type": "object",
"description": "Style of floating layer, typically used at least for adjusting the position., Default: -"
},
"a-modal/dialogClass": {
"type": "string",
"description": "className of floating layer., Default: -"
},
"a-modalmethod()/autoFocusButton": {
"type": "null|string: `ok` `cancel`",
"description": "Specify which button to autofocus, Default: `ok`"
},
"a-modalmethod()/cancelText": {
"type": "() => VNode",
"description": "Text of the Cancel button, Default: `Cancel`"
},
"a-modalmethod()/centered": {
"type": "Boolean",
"description": "Centered Modal, Default: `false`"
},
"a-modalmethod()/closable": {
"type": "boolean",
"description": "Whether a close (x) button is visible on top right of the modal dialog or not, Default: `false`"
},
"a-modalmethod()/class": {
"type": "string",
"description": "class of container, Default: -"
},
"a-modalmethod()/content": {
"type": "() => VNode",
"description": "Content, Default: -"
},
"a-modalmethod()/icon": {
"type": "() => VNode",
"description": "custom icon (`Added in 1.14.0`), Default: -"
},
"a-modalmethod()/keyboard": {
"type": "Boolean",
"description": "Whether support press esc to close, Default: true"
},
"a-modalmethod()/mask": {
"type": "Boolean",
"description": "Whether show mask or not., Default: true"
},
"a-modalmethod()/maskClosable": {
"type": "Boolean",
"description": "Whether to close the modal dialog when the mask (area outside the modal) is clicked, Default: `false`"
},
"a-modalmethod()/okText": {
"type": "() => VNode",
"description": "Text of the OK button, Default: `OK`"
},
"a-modalmethod()/okType": {
"type": "string",
"description": "Button `type` of the OK button, Default: `primary`"
},
"a-modalmethod()/okButtonProps": {
"type": "[ButtonProps](/components/button)",
"description": "The ok button props, Default: -"
},
"a-modalmethod()/cancelButtonProps": {
"type": "[ButtonProps](/components/button)",
"description": "The cancel button props, Default: -"
},
"a-modalmethod()/title": {
"type": "() => VNode",
"description": "Title, Default: -"
},
"a-modalmethod()/width": {
"type": "string|number",
"description": "Width of the modal dialog, Default: 416"
},
"a-modalmethod()/zIndex": {
"type": "Number",
"description": "The `z-index` of the Modal, Default: 1000"
},
"a-modalmethod()/onCancel": {
"type": "function",
"description": "Specify a function that will be called when the user clicks the Cancel button. The parameter of this function is a function whose execution should include closing the dialog. You can also just return a promise and when the promise is resolved, the modal dialog will also be closed, Default: -"
},
"a-modalmethod()/onOk": {
"type": "function",
"description": "Specify a function that will be called when the user clicks the OK button. The parameter of this function is a function whose execution should include closing the dialog. You can also just return a promise and when the promise is resolved, the modal dialog will also be closed, Default: -"
},
"a-modalmethod()/appContext": {
"type": "vue instance",
"description": "The appContext of the popup is generally used to get the parent provider, such as the configuration of `ConfigProvider`, Default: -"
},
"a-pageheader/title": {
"type": "string|slot",
"description": "custom title text, Default: -"
},
"a-pageheader/subTitle": {
"type": "string|slot",
"description": "custom subTitle text, Default: -"
},
"a-pageheader/ghost": {
"type": "boolean",
"description": "PageHeader type, will change background color, Default: true"
},
"a-pageheader/avatar": {
"type": "[avatar props](/components/avatar/)",
"description": "Avatar next to the title bar, Default: -"
},
"a-pageheader/backIcon": {
"type": "string|slot",
"description": "custom back icon, if false the back icon will not be displayed, Default: ``"
},
"a-pageheader/tags": {
"type": "[Tag](/components/tag/)[] | [Tag](/components/tag/)",
"description": "Tag list next to title, Default: -"
},
"a-pageheader/extra": {
"type": "string|slot",
"description": "Operating area, at the end of the line of the title line, Default: -"
},
"a-pageheader/breadcrumb": {
"type": "[breadcrumb](/components/breadcrumb/)",
"description": "Breadcrumb configuration, Default: -"
},
"a-pageheader/footer": {
"type": "string|slot",
"description": "PageHeader's footer, generally used to render TabBar, Default: -"
},
"a-notification/bottom": {
"type": "string",
"description": "Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels)., Default: `24px`"
},
"a-notification/btn": {
"type": "VNode",
"description": "Customized close button, Default: -"
},
"a-notification/class": {
"type": "string",
"description": "Customized CSS class, Default: -"
},
"a-notification/description": {
"type": "string| VNode",
"description": "The content of notification box (required), Default: -"
},
"a-notification/duration": {
"type": "number",
"description": "Time in seconds before Notification is closed. When set to 0 or null, it will never be closed automatically, Default: 4.5"
},
"a-notification/getContainer": {
"type": "() => HTMLNode",
"description": "Return the mount node for Notification, Default: () => document.body"
},
"a-notification/icon": {
"type": "VNode",
"description": "Customized icon, Default: -"
},
"a-notification/key": {
"type": "string",
"description": "The unique identifier of the Notification, Default: -"
},
"a-notification/message": {
"type": "string|VNode",
"description": "The title of notification box (required), Default: -"
},
"a-notification/placement": {
"type": "string",
"description": "Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight`, Default: `topRight`"
},
"a-notification/style": {
"type": "Object | string",
"description": "Customized inline style, Default: -"
},
"a-notification/onClose": {
"type": "Function",
"description": "Specify a function that will be called when the close button is clicked, Default: -"
},
"a-notification/onClick": {
"type": "Function",
"description": "Specify a function that will be called when the notification is clicked, Default: -"
},
"a-notification/top": {
"type": "string",
"description": "Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels)., Default: `24px`"
},
"a-notification/closeIcon": {
"type": "VNode",
"description": "custom close icon, Default: -"
},
"a-pagination/current(v-model)": {
"type": "number",
"description": "current page number, Default: -"
},
"a-pagination/pageSize(v-model)": {
"type": "number",
"description": "number of data items per page, Default: -"
},
"a-pagination/defaultCurrent": {
"type": "number",
"description": "default initial page number, Default: 1"
},
"a-pagination/defaultPageSize": {
"type": "number",
"description": "default number of data items per page, Default: 10"
},
"a-pagination/disabled": {
"type": "boolean",
"description": "Disable pagination, Default: -"
},
"a-pagination/hideOnSinglePage": {
"type": "boolean",
"description": "Whether to hide pager on single page, Default: false"
},
"a-pagination/itemRender": {
"type": "(page, type: 'page' | 'prev' ",
"description": "to customize item innerHTML, Default: 'next', originalElement) => vNode \\"
},
"a-pagination/pageSizeOptions": {
"type": "string[]",
"description": "specify the sizeChanger options, Default: \\['10', '20', '30', '40']"
},
"a-pagination/showLessItems": {
"type": "boolean",
"description": "Show less page items, Default: false"
},
"a-pagination/showQuickJumper": {
"type": "boolean",
"description": "determine whether you can jump to pages directly, Default: false"
},
"a-pagination/showSizeChanger": {
"type": "boolean",
"description": "determine whether `pageSize` can be changed, Default: false"
},
"a-pagination/showTitle": {
"type": "boolean",
"description": "Show page item's title, Default: true"
},
"a-pagination/showTotal": {
"type": "Function(total, range)",
"description": "to display the total number and range, Default: -"
},
"a-pagination/simple": {
"type": "boolean",
"description": "whether to use simple mode, Default: -"
},
"a-pagination/size": {
"type": "string",
"description": "specify the size of `Pagination`, can be set to `small`, Default: \"\""
},
"a-pagination/total": {
"type": "number",
"description": "total number of data items, Default: 0"
},
"a-popover/content": {
"type": "string|slot",
"description": "Content of the card, Default: vNode"
},
"a-popover/title": {
"type": "string|slot",
"description": "Title of the card, Default: VNode"
},
"a-popconfirm/cancelText": {
"type": "string|slot",
"description": "text of the Cancel button, Default: `Cancel`"
},
"a-popconfirm/okText": {
"type": "string|slot",
"description": "text of the Confirm button, Default: `Confirm`"
},
"a-popconfirm/okType": {
"type": "string",
"description": "Button `type` of the Confirm button, Default: `primary`"
},
"a-popconfirm/title": {
"type": "string|slot",
"description": "title of the confirmation box, Default: -"
},
"a-popconfirm/icon": {
"type": "vNode|slot",
"description": "customize icon of confirmation, Default: <Icon type=\"exclamation-circle\" />"
},
"a-popconfirm/disabled": {
"type": "boolean",
"description": "is show popconfirm when click its childrenNode, Default: false"
},
"a-progress/format": {
"type": "function(percent, successPercent)",
"description": "The template function of the content, Default: (percent) => percent + `%`"
},
"a-progress/percent": {
"type": "number",
"description": "To set the completion percentage, Default: 0"
},
"a-progress/showInfo": {
"type": "boolean",
"description": "Whether to display the progress value and the status icon, Default: true"
},
"a-progress/status": {
"type": "string",
"description": "To set the status of the Progress, options: `success` `exception` `normal` `active`(line only), Default: -"
},
"a-progress/strokeColor": {
"type": "string",
"description": "The color of progress bar, Default: -"
},
"a-progress/strokeLinecap": {
"type": "`round` | `square`",
"description": "To set the style of the progress linecap, Default: `round`"
},
"a-progress/success": {
"type": "{ percent: number, strokeColor: string }",
"description": "Configs of successfully progress bar, Default: -"
},
"a-progress/trailColor": {
"type": "string",
"description": "The color of unfilled part, Default: -"
},
"a-progress/type": {
"type": "string",
"description": "To set the type, options: `line` `circle` `dashboard`, Default: `line`"
},
"a-radio/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-radio/checked(v-model)": {
"type": "boolean",
"description": "Specifies whether the radio is selected., Default: -"
},
"a-radio/disabled": {
"type": "boolean",
"description": "Disable radio, Default: false"
},
"a-radio/value": {
"type": "any",
"description": "According to value for comparison, to determine whether the selected, Default: -"
},
"a-radio-group/defaultValue": {
"type": "any",
"description": "Default selected value, Default: -"
},
"a-radio-group/disabled": {
"type": "boolean",
"description": "Disable all radio buttons, Default: false"
},
"a-radio-group/name": {
"type": "string",
"description": "The `name` property of all `input[type=\"radio\"]` children, Default: -"
},
"a-radio-group/options": {
"type": "string[] | Array<{ label: string value: string disabled?: boolean }>",
"description": "set children optional, Default: -"
},
"a-radio-group/size": {
"type": "`large` | `default` ",
"description": "size for radio button style, Default: `small`"
},
"a-radio-group/value(v-model)": {
"type": "any",
"description": "Used for setting the currently selected value., Default: -"
},
"a-radio-group/buttonStyle": {
"type": "`outline` | `solid`",
"description": "style type of radio button, Default: `outline`"
},
"a-radio-group/change": {
"type": "Function(e:Event)",
"description": "The callback function that is triggered when the state changes., Default: undefined"
},
"a-radio/blur()": {
"type": "",
"description": "remove focus, Default: undefined"
},
"a-radio/focus()": {
"type": "",
"description": "get focus, Default: undefined"
},
"a-rate/allowClear": {
"type": "boolean",
"description": "whether to allow clear when click again, Default: true"
},
"a-rate/allowHalf": {
"type": "boolean",
"description": "whether to allow semi selection, Default: false"
},
"a-rate/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-rate/character": {
"type": "String or slot=\"character\"",
"description": "custom character of rate, Default: ``"
},
"a-rate/count": {
"type": "number",
"description": "star count, Default: 5"
},
"a-rate/disabled": {
"type": "boolean",
"description": "read only, unable to interact, Default: false"
},
"a-rate/tooltips": {
"type": "string[]",
"description": "Customize tooltip by each character, Default: -"
},
"a-rate/value(v-model)": {
"type": "number",
"description": "current value, Default: -"
},
"a-result/title": {
"type": "string | VNode ",
"description": "title string, Default: #title"
},
"a-result/subTitle": {
"type": "string | VNode ",
"description": "subTitle string, Default: #subTitle"
},
"a-result/status": {
"type": "`'success'",
"description": "result status,decide icons and colors, Default: 'error'"
},
"a-result/icon": {
"type": "#icon",
"description": "custom back icon, Default: -"
},
"a-result/extra": {
"type": "#extra",
"description": "operating area, Default: -"
},
"a-skeleton/active": {
"type": "boolean",
"description": "Show animation effect, Default: false"
},
"a-skeleton/avatar": {
"type": "boolean | [SkeletonAvatarProps](#SkeletonAvatarProps)",
"description": "Show avatar placeholder, Default: false"
},
"a-skeleton/loading": {
"type": "boolean",
"description": "Display the skeleton when `true`, Default: -"
},
"a-skeleton/paragraph": {
"type": "boolean | [SkeletonParagraphProps](#SkeletonParagraphProps)",
"description": "Show paragraph placeholder, Default: true"
},
"a-skeleton/title": {
"type": "boolean | [SkeletonTitleProps](#SkeletonTitleProps)",
"description": "Show title placeholder, Default: true"
},
"a-skeleton-avatar-props/size": {
"type": "number | `large` ",
"description": "Set the size of avatar, Default: `small` \\"
},
"a-skeleton-avatar-props/shape": {
"type": "`circle` | `square`",
"description": "Set the shape of avatar, Default: -"
},
"a-skeleton-title-props/width": {
"type": "number | string",
"description": "Set the width of title, Default: -"
},
"a-skeleton-paragraph-props/rows": {
"type": "number",
"description": "Set the row count of paragraph, Default: -"
},
"a-skeleton-paragraph-props/width": {
"type": "number | string ",
"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, Default: Array VNode | v-slot",
"description": "Customize dropdown content, Default: -"
},
"a-select/dropdownStyle": {
"type": "object",
"description": "style of dropdown menu, Default: -"
},
"a-select/dropdownMenuStyle": {
"type": "object",
"description": "additional style applied to dropdown menu, Default: -"
},
"a-select/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-select/firstActiveValue": {
"type": "string|string[]",
"description": "Value of action option by default, Default: -"
},
"a-select/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-select/labelInValue": {
"type": "boolean",
"description": "whether to embed label in value, turn the format of value from `string` to `{key: string, label: vNodes}`, Default: false"
},
"a-select/maxTagCount": {
"type": "number",
"description": "Max tag count to show, Default: -"
},
"a-select/maxTagPlaceholder": {
"type": "slot/function(omittedValues)",
"description": "Placeholder for not showing tags, Default: -"
},
"a-select/maxTagTextLength": {
"type": "number",
"description": "Max text length to show, Default: -"
},
"a-select/mode": {
"type": "'multiple' | 'tags'",
"description": "Set mode of Select, Default: -"
},
"a-select/notFoundContent": {
"type": "string|slot",
"description": "Specify content to show when no result matches.., Default: 'Not Found'"
},
"a-select/optionFilterProp": {
"type": "string",
"description": "Which prop value of option will be used for filter if filterOption is true, Default: value"
},
"a-select/optionLabelProp": {
"type": "string",
"description": "Which prop value of option will render as content of select., Default: `value` for `combobox`, `children` for other modes"
},
"a-select/placeholder": {
"type": "string|slot",
"description": "Placeholder of select, Default: -"
},
"a-select/showSearch": {
"type": "boolean",
"description": "Whether show search input in single mode., Default: false"
},
"a-select/showArrow": {
"type": "boolean",
"description": "Whether to show the drop-down arrow, Default: true"
},
"a-select/size": {
"type": "string",
"description": "Size of Select input. `default` `large` `small`, Default: default"
},
"a-select/suffixIcon": {
"type": "VNode | slot",
"description": "The custom suffix icon, Default: -"
},
"a-select/removeIcon": {
"type": "VNode | slot",
"description": "The custom remove icon, Default: -"
},
"a-select/clearIcon": {
"type": "VNode | slot",
"description": "The custom clear icon, Default: -"
},
"a-select/menuItemSelectedIcon": {
"type": "VNode | slot",
"description": "The custom menuItemSelected icon, Default: -"
},
"a-select/tokenSeparators": {
"type": "string[]",
"description": "Separator used to tokenize on tag/multiple mode, Default: "
},
"a-select/value(v-model)": {
"type": "string|number",
"description": "Current selected option., Default: string\\[]\\"
},
"a-select/options": {
"type": "array<{value, label, [disabled, key, title]}>",
"description": "Data of the selectOption, manual construction work is no longer needed if this property has been set, Default: \\[]"
},
"a-select/option": {
"type": "v-slot:option=\"{value, label, [disabled, key, title]}\"",
"description": "custom render option by slot, Default: -"
},
"a-select/defaultOpen": {
"type": "boolean",
"description": "Initial open state of dropdown, Default: -"
},
"a-select/open": {
"type": "boolean",
"description": "Controlled open state of dropdown, Default: -"
},
"a-select/loading": {
"type": "Boolean",
"description": "indicate loading state, Default: false"
},
"a-select/blur()": {
"type": "",
"description": "Remove focus, Default: undefined"
},
"a-select/focus()": {
"type": "",
"description": "Get focus, Default: undefined"
},
"a-slider/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-slider/disabled": {
"type": "boolean",
"description": "If true, the slider will not be interactable., Default: false"
},
"a-slider/dots": {
"type": "boolean",
"description": "Whether the thumb can drag over tick only., Default: false"
},
"a-slider/included": {
"type": "boolean",
"description": "Make effect when `marks` not null，`true` means containment and `false` means coordinative, Default: true"
},
"a-slider/marks": {
"type": "object",
"description": "Tick mark of Slider, type of key must be `number`, and must in closed interval \\[min, max], each mark can declare its own style., Default: { number: string|VNode } or { number: { style: object, label: string\\"
},
"a-slider/max": {
"type": "number",
"description": "The maximum value the slider can slide to, Default: 100"
},
"a-slider/min": {
"type": "number",
"description": "The minimum value the slider can slide to., Default: 0"
},
"a-slider/range": {
"type": "boolean",
"description": "dual thumb mode, Default: false"
},
"a-slider/reverse": {
"type": "boolean",
"description": "reverse the component, Default: false"
},
"a-slider/step": {
"type": "number|null",
"description": "The granularity the slider can step through values. Must greater than 0, and be divided by (max - min) . When `marks` no null, `step` can be `null`., Default: 1"
},
"a-slider/tipFormatter": {
"type": "Function|null",
"description": "Slider will pass its value to `tipFormatter`, and display its value in Tooltip, and hide Tooltip when return value is null., Default: IDENTITY"
},
"a-slider/value(v-model)": {
"type": "number|number[]",
"description": "The value of slider. When `range` is `false`, use `number`, otherwise, use `[number, number]`, Default: "
},
"a-slider/vertical": {
"type": "Boolean",
"description": "If true, the slider will be vertical., Default: false"
},
"a-slider/tooltipPlacement": {
"type": "string",
"description": "Set Tooltip display position. Ref [`Tooltip`](/components/tooltip/)., Default: "
},
"a-slider/tooltipVisible": {
"type": "Boolean",
"description": "If true, Tooltip will show always, or it will not show anyway, even if dragging or hovering., Default: "
},
"a-slider/getTooltipPopupContainer": {
"type": "Function",
"description": "The DOM container of the Tooltip, the default behavior is to create a div element in body., Default: () => document.body"
},
"a-spin/delay": {
"type": "number (milliseconds)",
"description": "specifies a delay in milliseconds for loading state (prevent flush), Default: -"
},
"a-spin/indicator": {
"type": "vNode |slot",
"description": "vue node of the spinning indicator, Default: -"
},
"a-spin/size": {
"type": "string",
"description": "size of Spin, options: `small`, `default` and `large`, Default: `default`"
},
"a-spin/spinning": {
"type": "boolean",
"description": "whether Spin is spinning, Default: true"
},
"a-spin/tip": {
"type": "string",
"description": "customize description content when Spin has children, Default: -"
},
"a-spin/wrapperClassName": {
"type": "string",
"description": "className of wrapper when Spin has children, Default: -"
},
"a-statistic/decimalSeparator": {
"type": "string",
"description": "decimal separator, Default: ."
},
"a-statistic/formatter": {
"type": "v-slot |({value}) => VNode",
"description": "customize value display logic, Default: -"
},
"a-statistic/groupSeparator": {
"type": "string",
"description": "group separator, Default: ,"
},
"a-statistic/precision": {
"type": "number",
"description": "precision of input value, Default: -"
},
"a-statistic/prefix": {
"type": "string | v-slot",
"description": "prefix node of value, Default: -"
},
"a-statistic/suffix": {
"type": "string | v-slot",
"description": "suffix node of value, Default: -"
},
"a-statistic/title": {
"type": "string | v-slot",
"description": "Display title, Default: -"
},
"a-statistic/value": {
"type": "string | number",
"description": "Display value, Default: -"
},
"a-statistic/valueStyle": {
"type": "style",
"description": "Set value css style, Default: -"
},
"a-statistic-countdown/format": {
"type": "string",
"description": "Format as [moment](http://momentjs.com/), Default: 'HH:mm:ss'"
},
"a-statistic-countdown/prefix": {
"type": "string | v-slot",
"description": "prefix node of value, Default: -"
},
"a-statistic-countdown/suffix": {
"type": "string | v-slot",
"description": "suffix node of value, Default: -"
},
"a-statistic-countdown/title": {
"type": "string | v-slot",
"description": "Display title, Default: -"
},
"a-statistic-countdown/value": {
"type": "number | moment",
"description": "Set target countdown time, Default: -"
},
"a-statistic-countdown/valueStyle": {
"type": "style",
"description": "Set value css style, Default: -"
},
"a-statistic-countdown/finish": {
"type": "() => void",
"description": "Trigger when time's up, Default: -"
},
"a-space/align": {
"type": "`start` | `end` ",
"description": "Align items, Default: `center` \\"
},
"a-space/direction": {
"type": "`vertical` | `horizontal`",
"description": "The space direction, Default: `horizontal`"
},
"a-space/size": {
"type": "`small` | `middle` ",
"description": "The space size, Default: `large` \\"
},
"a-switch/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-switch/checked(v-model)": {
"type": "checkedValue | unCheckedValue",
"description": "determine whether the `Switch` is checked, Default: false"
},
"a-switch/checkedChildren": {
"type": "string|slot",
"description": "content to be shown when the state is checked, Default: "
},
"a-switch/disabled": {
"type": "boolean",
"description": "Disable switch, Default: false"
},
"a-switch/loading": {
"type": "boolean",
"description": "loading state of switch, Default: false"
},
"a-switch/size": {
"type": "string",
"description": "the size of the `Switch`, options: `default` `small`, Default: default"
},
"a-switch/unCheckedChildren": {
"type": "string|slot",
"description": "content to be shown when the state is unchecked, Default: "
},
"a-switch/checkedValue": {
"type": "boolean | string ",
"description": "value for checked state, Default: number"
},
"a-switch/unCheckedValue": {
"type": "boolean | string ",
"description": "value for unchecked state, Default: number"
},
"a-table/tableLayout": {
"type": "- | 'auto' ",
"description": "[table-layout](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout) attribute of table element, Default: 'fixed'"
},
"a-table/bordered": {
"type": "boolean",
"description": "Whether to show all table borders, Default: `false`"
},
"a-table/childrenColumnName": {
"type": "string",
"description": "The column contains children to display, Default: `children`"
},
"a-table/columns": {
"type": "array",
"description": "Columns of table [config](#Column), Default: -"
},
"a-table/components": {
"type": "object",
"description": "Override default table elements, Default: -"
},
"a-table/dataSource": {
"type": "any[]",
"description": "Data record array to be displayed, Default: -"
},
"a-table/defaultExpandAllRows": {
"type": "boolean",
"description": "Expand all rows initially, Default: `false`"
},
"a-table/defaultExpandedRowKeys": {
"type": "string[]",
"description": "Initial expanded row keys, Default: -"
},
"a-table/expandedRowKeys": {
"type": "string[]",
"description": "Current expanded row keys, Default: -"
},
"a-table/expandedRowRender": {
"type": "Function({record, index, indent, expanded}):VNode|v-slot",
"description": "Expanded container render for each row, Default: -"
},
"a-table/expandIcon": {
"type": "Function(props):VNode | #expandIcon=\"props\"",
"description": "Customize row expand Icon., Default: -"
},
"a-table/expandRowByClick": {
"type": "boolean",
"description": "Whether to expand row by clicking anywhere in the whole row, Default: `false`"
},
"a-table/expandIconColumnIndex": {
"type": "0",
"description": "The index of `expandIcon` which column will be inserted when `expandIconAsCell` is false, Default: "
},
"a-table/footer": {
"type": "Function(currentPageData)| v-slot",
"description": "Table footer renderer, Default: "
},
"a-table/indentSize": {
"type": "number",
"description": "Indent size in pixels of tree data, Default: 15"
},
"a-table/loading": {
"type": "boolean|[object](/components/spin)",
"description": "Loading status of table, Default: `false`"
},
"a-table/locale": {
"type": "object",
"description": "i18n text including filter, sort, empty text, etc, Default: filterConfirm: 'Ok' filterReset: 'Reset' emptyText: 'No Data'"
},
"a-table/pagination": {
"type": "object",
"description": "Config of pagination. You can ref table pagination [config](#pagination) or full [`pagination`](/components/pagination/) document, hide it by setting it to `false`, Default: "
},
"a-table/rowClassName": {
"type": "Function(record, index):string",
"description": "Row's className, Default: -"
},
"a-table/rowKey": {
"type": "string|Function(record, index):string",
"description": "Row's unique key, could be a string or function that returns a string, Default: `key`"
},
"a-table/rowSelection": {
"type": "object",
"description": "Row selection [config](#rowSelection), Default: null"
},
"a-table/scroll": {
"type": "{ x: number | true, y: number }",
"description": "Set horizontal or vertical scrolling, can also be used to specify the width and height of the scroll area. It is recommended to set a number for `x`, if you want to set it to `true`, you need to add style `.ant-table td { white-space: nowrap; }`., Default: -"
},
"a-table/showHeader": {
"type": "boolean",
"description": "Whether to show table header, Default: `true`"
},
"a-table/size": {
"type": "`default` | `middle` ",
"description": "Size of table, Default: `small` \\"
},
"a-table/title": {
"type": "Function(currentPageData)| v-slot",
"description": "Table title renderer, Default: "
},
"a-table/customHeaderRow": {
"type": "Function(column, index)",
"description": "Set props on per header row, Default: -"
},
"a-table/customRow": {
"type": "Function(record, index)",
"description": "Set props on per row, Default: -"
},
"a-table/getPopupContainer": {
"type": "(triggerNode) => HTMLElement",
"description": "the render container of dropdowns in table, Default: `() => TableHtmlElement`"
},
"a-table/transformCellText": {
"type": "Function({ text, column, record, index }) => any",
"description": "Data can be changed again before rendering. The default configuration of general user empty data. You can configured globally through [ConfigProvider](/components/config-provider-cn/), Default: -"
},
"a-steps/current(v-model)": {
"type": "number",
"description": "to set the current step, counting from 0. You can overwrite this state by using `status` of `Step`, support v-model after 1.5.0, Default: 0"
},
"a-steps/type": {
"type": "string",
"description": "Type of steps, can be set to one of the following values: `default`, `navigation`, Default: `default`"
},
"a-steps/direction": {
"type": "string",
"description": "to specify the direction of the step bar, `horizontal` and `vertical` are currently supported, Default: `horizontal`"
},
"a-steps/labelPlacement": {
"type": "string",
"description": "support vertial title and description, Default: `horizontal`"
},
"a-steps/progressDot": {
"type": "Boolean or slot=\"progressDot\" slot-scope=\"{index, status, title, description, prefixCls})\"",
"description": "Steps with progress dot style, customize the progress dot by setting a scoped slot. labelPlacement will be `vertical`, Default: false"
},
"a-steps/size": {
"type": "string",
"description": "to specify the size of the step bar, `default` and `small` are currently supported, Default: `default`"
},
"a-steps/status": {
"type": "string",
"description": "to specify the status of current step, can be set to one of the following values: `wait` `process` `finish` `error`, Default: `process`"
},
"a-steps/initial": {
"type": "number",
"description": "set the initial step, counting from 0, Default: 0"
},
"a-steps/change": {
"type": "(current) => void",
"description": "Trigger when Step is changed, Default: -"
},
"a-steps-step/description": {
"type": "string|slot",
"description": "description of the step, optional property, Default: -"
},
"a-steps-step/icon": {
"type": "string|slot",
"description": "icon of the step, optional property, Default: -"
},
"a-steps-step/status": {
"type": "string",
"description": "to specify the status. It will be automatically set by `current` of `Steps` if not configured. Optional values are: `wait` `process` `finish` `error`, Default: `wait`"
},
"a-steps-step/title": {
"type": "string|slot",
"description": "title of the step, Default: -"
},
"a-steps-step/subTitle": {
"type": "string|slot",
"description": "Subtitle of the step, Default: -"
},
"a-steps-step/disabled": {
"type": "boolean",
"description": "Disable click, Default: false"
},
"a-tabs/activeKey(v-model)": {
"type": "string",
"description": "Current TabPane's key, Default: -"
},
"a-tabs/animated": {
"type": "boolean ",
"description": "Whether to change tabs with animation. Only works while `tabPosition=\"top\"|\"bottom\"`, Default: {inkBar:boolean, tabPane:boolean}"
},
"a-tabs/defaultActiveKey": {
"type": "string",
"description": "Initial active TabPane's key, if `activeKey` is not set., Default: -"
},
"a-tabs/hideAdd": {
"type": "boolean",
"description": "Hide plus icon or not. Only works while `type=\"editable-card\"`, Default: `false`"
},
"a-tabs/size": {
"type": "`large` | `default` ",
"description": "preset tab bar size, Default: `small`"
},
"a-tabs/tabBarExtraContent": {
"type": "slot",
"description": "Extra content in tab bar, Default: -"
},
"a-tabs/tabBarStyle": {
"type": "object",
"description": "Tab bar style object, Default: -"
},
"a-tabs/tabPosition": {
"type": "`top` | `right` ",
"description": "Position of tabs, Default: `bottom` \\"
},
"a-tabs/type": {
"type": "`line` | `card` ",
"description": "Basic style of tabs, Default: `editable-card`"
},
"a-tabs/tabBarGutter": {
"type": "number",
"description": "The gap between tabs, Default: -"
},
"a-tabs-tab-pane/forceRender": {
"type": "boolean",
"description": "Forced render of content in tabs, not lazy render after clicking on tabs, Default: false"
},
"a-tabs-tab-pane/key": {
"type": "string",
"description": "TabPane's key, Default: -"
},
"a-tabs-tab-pane/tab": {
"type": "string|slot",
"description": "Show text in TabPane's head, Default: -"
},
"a-tag/closable": {
"type": "boolean",
"description": "Whether the Tag can be closed, Default: `false`"
},
"a-tag/closeIcon": {
"type": "VNode | #closeIcon",
"description": "Custom close icon, Default: -"
},
"a-tag/color": {
"type": "string",
"description": "Color of the Tag, Default: -"
},
"a-tag/icon": {
"type": "VNode | #icon",
"description": "Set the icon of tag, Default: -"
},
"a-tag/visible(v-model)": {
"type": "boolean",
"description": "Whether the Tag is closed or not, Default: `true`"
},
"a-tag/close": {
"type": "(e) => void",
"description": "Callback executed when tag is closed, Default: undefined"
},
"a-tag-checkable-tag/checked(v-model)": {
"type": "boolean",
"description": "Checked status of Tag, Default: `false`"
},
"a-tag-checkable-tag/change": {
"type": "(checked) => void",
"description": "Callback executed when Tag is checked/unchecked, Default: undefined"
},
"a-timepicker/addon": {
"type": "slot | slot-scope",
"description": "some addon to timepicker panel bottom, Default: -"
},
"a-timepicker/allowClear": {
"type": "boolean",
"description": "allow clearing text, Default: true"
},
"a-timepicker/autofocus": {
"type": "boolean",
"description": "get focus when component mounted, Default: false"
},
"a-timepicker/clearText": {
"type": "string",
"description": "clear tooltip of icon, Default: clear"
},
"a-timepicker/defaultOpenValue": {
"type": "[moment](http://momentjs.com/)",
"description": "default open panel value, used to set utcOffset,locale if value/defaultValue absent, Default: moment()"
},
"a-timepicker/defaultValue": {
"type": "[moment](http://momentjs.com/)",
"description": "to set default time, Default: -"
},
"a-timepicker/disabled": {
"type": "boolean",
"description": "determine whether the TimePicker is disabled, Default: false"
},
"a-timepicker/disabledHours": {
"type": "function()",
"description": "to specify the hours that cannot be selected, Default: -"
},
"a-timepicker/disabledMinutes": {
"type": "function(selectedHour)",
"description": "to specify the minutes that cannot be selected, Default: -"
},
"a-timepicker/disabledSeconds": {
"type": "function(selectedHour, selectedMinute)",
"description": "to specify the seconds that cannot be selected, Default: -"
},
"a-timepicker/format": {
"type": "string",
"description": "to set the time format, Default: \"HH:mm:ss\""
},
"a-timepicker/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-timepicker/hideDisabledOptions": {
"type": "boolean",
"description": "hide the options that can not be selected, Default: false"
},
"a-timepicker/hourStep": {
"type": "number",
"description": "interval between hours in picker, Default: 1"
},
"a-timepicker/inputReadOnly": {
"type": "boolean",
"description": "Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices), Default: false"
},
"a-timepicker/minuteStep": {
"type": "number",
"description": "interval between minutes in picker, Default: 1"
},
"a-timepicker/open(v-model)": {
"type": "boolean",
"description": "whether to popup panel, Default: false"
},
"a-timepicker/placeholder": {
"type": "string",
"description": "display when there's no value, Default: \"Select a time\""
},
"a-timepicker/popupClassName": {
"type": "string",
"description": "className of panel, Default: ''"
},
"a-timepicker/popupStyle": {
"type": "object",
"description": "style of panel, Default: -"
},
"a-timepicker/secondStep": {
"type": "number",
"description": "interval between seconds in picker, Default: 1"
},
"a-timepicker/suffixIcon": {
"type": "string | VNode ",
"description": "The custom suffix icon, Default: slot"
},
"a-timepicker/clearIcon": {
"type": "string | VNode ",
"description": "The custom clear icon, Default: slot"
},
"a-timepicker/use12Hours": {
"type": "boolean",
"description": "display as 12 hours format, with default format `h:mm:ss a`, Default: false"
},
"a-timepicker/value(v-model)": {
"type": "[moment](http://momentjs.com/)",
"description": "to set time, Default: -"
},
"a-timepicker/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-timepicker/valueFormat": {
"type": "string，[date formats](https://momentjs.com/docs/#/displaying/format/)",
"description": "optional, format of binding value. If not specified, the binding value will be a Date object, Default: -"
},
"a-timeline/pending": {
"type": "boolean|string",
"description": "Set the last ghost node's existence or its content, Default: slot"
},
"a-timeline/pendingDot": {
"type": "string|slot",
"description": "Set the dot of the last ghost node when pending is true, Default: ``"
},
"a-timeline/reverse": {
"type": "boolean",
"description": "reverse nodes or not, Default: false"
},
"a-timeline/mode": {
"type": "`left` | `alternate` ",
"description": "By sending `alternate` the timeline will distribute the nodes to the left and right., Default: `right`"
},
"a-timeline-item/color": {
"type": "string",
"description": "Set the circle's color to `blue`, `red`, `green` or other custom colors, Default: `blue`"
},
"a-timeline-item/dot": {
"type": "string|slot",
"description": "Customize timeline dot, Default: -"
},
"a-timeline-item/position": {
"type": "`left` | `right`",
"description": "Customize node position, Default: -"
},
"a-tooltip/title": {
"type": "string|slot",
"description": "The text shown in the tooltip, Default: -"
},
"a-tooltip/arrowPointAtCenter": {
"type": "boolean",
"description": "Whether the arrow is pointed at the center of target, Default: `false`"
},
"a-tooltip/autoAdjustOverflow": {
"type": "boolean",
"description": "Whether to adjust popup placement automatically when popup is off screen, Default: `true`"
},
"a-tooltip/color": {
"type": "string",
"description": "The background color, Default: -"
},
"a-tooltip/defaultVisible": {
"type": "boolean",
"description": "Whether the floating tooltip card is visible by default, Default: `false`"
},
"a-tooltip/getPopupContainer": {
"type": "Function(triggerNode)",
"description": "The DOM container of the tip, the default behavior is to create a `div` element in `body`., Default: () => document.body"
},
"a-tooltip/mouseEnterDelay": {
"type": "number",
"description": "Delay in seconds, before tooltip is shown on mouse enter, Default: 0.1"
},
"a-tooltip/mouseLeaveDelay": {
"type": "number",
"description": "Delay in seconds, before tooltip is hidden on mouse leave, Default: 0.1"
},
"a-tooltip/overlayClassName": {
"type": "string",
"description": "Class name of the tooltip card, Default: -"
},
"a-tooltip/overlayStyle": {
"type": "object",
"description": "Style of the tooltip card, Default: -"
},
"a-tooltip/placement": {
"type": "string",
"description": "The position of the tooltip relative to the target, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom`, Default: `top`"
},
"a-tooltip/trigger": {
"type": "`hover` | `focus` ",
"description": "Tooltip trigger mode, Default: `click` \\"
},
"a-tooltip/visible(v-model)": {
"type": "boolean",
"description": "Whether the floating tooltip card is visible or not, Default: `false`"
},
"a-tooltip/destroyTooltipOnHide": {
"type": "boolean",
"description": "Whether to destroy tooltip on hide, Default: false"
},
"a-tooltip/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-transfer/dataSource": {
"type": "[{key: string.isRequired,title: string.isRequired,description: string,disabled: bool}]",
"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: \\[]"
},
"a-transfer/disabled": {
"type": "boolean",
"description": "Whether disabled transfer, Default: false"
},
"a-transfer/filterOption": {
"type": "(inputValue, option): boolean",
"description": "A function to determine whether an item should show in search result list, Default: "
},
"a-transfer/footer": {
"type": "slot=\"footer\" slot-scope=\"props\"",
"description": "customize the progress dot by setting a scoped slot, Default: "
},
"a-transfer/lazy": {
"type": "object|boolean",
"description": "property of vc-lazy-load for lazy rendering items. Turn off it by set to `false`., Default: `{ height: 32, offset: 32 }`"
},
"a-transfer/listStyle": {
"type": "object",
"description": "A custom CSS style used for rendering the transfer columns., Default: "
},
"a-transfer/locale": {
"type": "object",
"description": "i18n text including filter, empty text, item unit, etc, Default: `{ itemUnit: 'item', itemsUnit: 'items', notFoundContent: 'The list is empty', searchPlaceholder: 'Search here' }`"
},
"a-transfer/operations": {
"type": "string[]",
"description": "A set of operations that are sorted from top to bottom., Default: \\['>', '<']"
},
"a-transfer/render": {
"type": "Function(record) | slot",
"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 element which is generated from that record. Also, it can return a plain object with `value` and `label`, `label` is a element and `value` is for title, Default: "
},
"a-transfer/selectedKeys": {
"type": "string[]",
"description": "A set of keys of selected items., Default: \\[]"
},
"a-transfer/showSearch": {
"type": "boolean",
"description": "If included, a search box is shown on each column., Default: false"
},
"a-transfer/showSelectAll": {
"type": "boolean",
"description": "Show select all checkbox on the header, Default: true"
},
"a-transfer/targetKeys": {
"type": "string[]",
"description": "A set of keys of elements that are listed on the right column., Default: \\[]"
},
"a-transfer/titles": {
"type": "string[]",
"description": "A set of titles that are sorted from left to right., Default: -"
},
"a-typography-text/code": {
"type": "boolean",
"description": "Code style, Default: false"
},
"a-typography-text/copyable": {
"type": "boolean | [copyable](#copyable)",
"description": "Whether to be copyable, customize it via setting an object, Default: false"
},
"a-typography-text/delete": {
"type": "boolean",
"description": "Deleted line style, Default: false"
},
"a-typography-text/disabled": {
"type": "boolean",
"description": "Disabled content, Default: false"
},
"a-typography-text/editable": {
"type": "boolean | [editable](#editable)",
"description": "If editable. Can control edit state when is object, Default: false"
},
"a-typography-text/ellipsis": {
"type": "boolean",
"description": "Display ellipsis when text overflows, Default: false"
},
"a-typography-text/keyboard": {
"type": "boolean",
"description": "Keyboard style, Default: false"
},
"a-typography-text/mark": {
"type": "boolean",
"description": "Marked style, Default: false"
},
"a-typography-text/strong": {
"type": "boolean",
"description": "Bold style, Default: false"
},
"a-typography-text/type": {
"type": "`secondary` | `success` ",
"description": "Content type, Default: `warning` \\"
},
"a-typography-text/underline": {
"type": "boolean",
"description": "Underlined style, Default: false"
},
"a-typography-text/content(v-model)": {
"type": "string",
"description": "When using ellipsis or editable, use content instead of children, Default: -"
},
"a-typography-title/code": {
"type": "boolean",
"description": "Code style, Default: false"
},
"a-typography-title/copyable": {
"type": "boolean | [copyable](#copyable)",
"description": "Whether to be copyable, customize it via setting an object, Default: false"
},
"a-typography-title/delete": {
"type": "boolean",
"description": "Deleted line style, Default: false"
},
"a-typography-title/disabled": {
"type": "boolean",
"description": "Disabled content, Default: false"
},
"a-typography-title/editable": {
"type": "boolean | [editable](#editable)",
"description": "If editable. Can control edit state when is object, Default: false"
},
"a-typography-title/ellipsis": {
"type": "boolean | [ellipsis](#ellipsis)",
"description": "Display ellipsis when text overflows, can configure rows and expandable by using object, Default: false"
},
"a-typography-title/level": {
"type": "number: 1, 2, 3, 4, 5",
"description": "Set content importance. Match with `h1`, `h2`, `h3`, `h4`, `h5`, Default: 1"
},
"a-typography-title/mark": {
"type": "boolean",
"description": "Marked style, Default: false"
},
"a-typography-title/type": {
"type": "`secondary` | `success` ",
"description": "Content type, Default: `warning` \\"
},
"a-typography-title/underline": {
"type": "boolean",
"description": "Underlined style, Default: false"
},
"a-typography-title/content(v-model)": {
"type": "string",
"description": "When using ellipsis or editable, use content instead of children, Default: -"
},
"a-typography-paragraph/code": {
"type": "boolean",
"description": "Code style, Default: false"
},
"a-typography-paragraph/copyable": {
"type": "boolean | [copyable](#copyable)",
"description": "Whether to be copyable, customize it via setting an object, Default: false"
},
"a-typography-paragraph/delete": {
"type": "boolean",
"description": "Deleted line style, Default: false"
},
"a-typography-paragraph/disabled": {
"type": "boolean",
"description": "Disabled content, Default: false"
},
"a-typography-paragraph/editable": {
"type": "boolean | [editable](#editable)",
"description": "If editable. Can control edit state when is object, Default: false"
},
"a-typography-paragraph/ellipsis": {
"type": "boolean | [ellipsis](#ellipsis)",
"description": "Display ellipsis when text overflows, can configure rows and expandable by using object, Default: false"
},
"a-typography-paragraph/mark": {
"type": "boolean",
"description": "Marked style, Default: false"
},
"a-typography-paragraph/strong": {
"type": "boolean",
"description": "Bold style, Default: false"
},
"a-typography-paragraph/type": {
"type": "`secondary` | `success` ",
"description": "Content type, Default: `warning` \\"
},
"a-typography-paragraph/underline": {
"type": "boolean",
"description": "Underlined style, Default: false"
},
"a-typography-paragraph/content(v-model)": {
"type": "string",
"description": "When using ellipsis or editable, use content instead of children, Default: -"
},
"a-tree/treeData": {
"type": "array",
"description": "treeNode of tree, please use `treeNodes` before v1.1.4, Default: -"
},
"a-tree/replaceFields": {
"type": "object",
"description": "Replace the title,key and children fields in treeNode with the corresponding fields in treeData, Default: { children:'children', title:'title', key:'key' }"
},
"a-tree/autoExpandParent": {
"type": "boolean",
"description": "Whether to automatically expand a parent treeNode, Default: true"
},
"a-tree/blockNode": {
"type": "boolean",
"description": "Whether treeNode fill remaining horizontal space, Default: false"
},
"a-tree/checkable": {
"type": "boolean",
"description": "Adds a `Checkbox` before the treeNodes, Default: false"
},
"a-tree/checkedKeys(v-model)": {
"type": "string[] | number[] \\",
"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., Default: {checked: string\\[] \\"
},
"a-tree/checkStrictly": {
"type": "boolean",
"description": "Check treeNode precisely; parent treeNode and children treeNodes are not associated, Default: false"
},
"a-tree/defaultExpandAll": {
"type": "boolean",
"description": "Whether to expand all treeNodes by default, Default: false"
},
"a-tree/disabled": {
"type": "bool",
"description": "whether disabled the tree, Default: false"
},
"a-tree/draggable": {
"type": "boolean",
"description": "Specifies whether this Tree is draggable (IE > 8), Default: false"
},
"a-tree/expandedKeys(v-model)": {
"type": "string[] | number[]",
"description": "(Controlled) Specifies the keys of the expanded treeNodes, Default: \\[]"
},
"a-tree/filterTreeNode": {
"type": "function(node)",
"description": "Defines a function to filter (highlight) treeNodes. When the function returns `true`, the corresponding treeNode will be highlighted, Default: -"
},
"a-tree/loadData": {
"type": "function(node)",
"description": "Load data asynchronously, Default: -"
},
"a-tree/loadedKeys": {
"type": "string[] | number[]",
"description": "(Controlled) Set loaded tree nodes. Need work with `loadData`, Default: \\[]"
},
"a-tree/multiple": {
"type": "boolean",
"description": "Allows selecting multiple treeNodes, Default: false"
},
"a-tree/selectable": {
"type": "boolean",
"description": "whether can be selected, Default: true"
},
"a-tree/selectedKeys(v-model)": {
"type": "string[] | number[]",
"description": "(Controlled) Specifies the keys of the selected treeNodes, Default: -"
},
"a-tree/showIcon": {
"type": "boolean",
"description": "Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true`, Default: false"
},
"a-tree/switcherIcon": {
"type": "slot",
"description": "customize collapse/expand icon of tree node, Default: -"
},
"a-tree/showLine": {
"type": "boolean",
"description": "Shows a connecting line, Default: false"
},
"a-tree/title": {
"type": "slot",
"description": "Title, Default: "
},
"a-tree-node/class": {
"type": "string",
"description": "className, Default: -"
},
"a-tree-node/style": {
"type": "string|object",
"description": "style, Default: -"
},
"a-tree-node/checkable": {
"type": "boolean",
"description": "When Tree is checkable, set TreeNode display Checkbox or not, Default: -"
},
"a-tree-node/disableCheckbox": {
"type": "boolean",
"description": "Disables the checkbox of the treeNode, Default: false"
},
"a-tree-node/disabled": {
"type": "boolean",
"description": "Disables the treeNode, Default: false"
},
"a-tree-node/icon": {
"type": "slot|slot-scope",
"description": "customize icon. When you pass component, whose render will receive full TreeNode props as component props, Default: -"
},
"a-tree-node/isLeaf": {
"type": "boolean",
"description": "Determines if this is a leaf node(effective when `loadData` is specified), Default: false"
},
"a-tree-node/key": {
"type": "string | number",
"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"
},
"a-tree-node/selectable": {
"type": "boolean",
"description": "Set whether the treeNode can be selected, Default: true"
},
"a-tree-node/title": {
"type": "string|slot",
"description": "Title, Default: slot-scope"
},
"a-tree-node/slots": {
"type": "object",
"description": "When using treeNodes, you can use this property to configure the properties that support the slot, such as `slots: { title: 'XXX'}`, Default: -"
},
"a-directory-tree/expandAction": {
"type": "string",
"description": "Directory open logic, optional `false` `'click'` `'dblclick'`, Default: click"
},
"a-upload/accept": {
"type": "string",
"description": "File types that can be accepted. See [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept), Default: -"
},
"a-upload/action": {
"type": "string|(file) => `Promise`",
"description": "Uploading URL, Default: -"
},
"a-upload/method": {
"type": "string",
"description": "http method of upload request, Default: 'post'"
},
"a-upload/directory": {
"type": "boolean",
"description": "support upload whole directory ([caniuse](https://caniuse.com/#feat=input-file-directory)), Default: false"
},
"a-upload/beforeUpload": {
"type": "(file, fileList) => `boolean",
"description": "Hook function which will be executed before uploading. Uploading will be stopped with `false` or a rejected Promise returned. **Warning：this function is not supported in IE9**。, Default: Promise`"
},
"a-upload/customRequest": {
"type": "Function",
"description": "override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest, Default: -"
},
"a-upload/data": {
"type": "object|function(file)",
"description": "Uploading params or function which can return uploading params., Default: -"
},
"a-upload/disabled": {
"type": "boolean",
"description": "disable upload button, Default: false"
},
"a-upload/fileList": {
"type": "object[]",
"description": "List of files that have been uploaded (controlled). Here is a common issue [#2423](https://github.com/ant-design/ant-design/issues/2423) when using it, Default: -"
},
"a-upload/headers": {
"type": "object",
"description": "Set request headers, valid above IE10., Default: -"
},
"a-upload/listType": {
"type": "string",
"description": "Built-in stylesheets, support for three types: `text`, `picture` or `picture-card`, Default: 'text'"
},
"a-upload/multiple": {
"type": "boolean",
"description": "Whether to support selected multiple file. `IE10+` supported. You can select multiple files with CTRL holding down while multiple is set to be true, Default: false"
},
"a-upload/name": {
"type": "string",
"description": "The name of uploading file, Default: 'file'"
},
"a-upload/previewFile": {
"type": "(file: File | Blob) => Promise",
"description": "Customize preview file logic, Default: -"
},
"a-upload/showUploadList": {
"type": "Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean }",
"description": "Whether to show default upload list, could be an object to specify `showPreviewIcon` and `showRemoveIcon` individually, Default: true"
},
"a-upload/supportServerRender": {
"type": "boolean",
"description": "Need to be turned on while the server side is rendering., Default: false"
},
"a-upload/withCredentials": {
"type": "boolean",
"description": "ajax upload with cookie sent, Default: false"
},
"a-upload/openFileDialogOnClick": {
"type": "boolean",
"description": "click open file dialog, Default: true"
},
"a-upload/remove": {
"type": "Function(file): `boolean",
"description": "A callback function, will be executed when removing file button is clicked, remove event will be prevented when return value is `false` or a Promise which resolve(false) or reject., Default: Promise`"
},
"a-upload/transformFile": {
"type": "Function(file): `string",
"description": "Customize transform file before request, Default: Blob"
}
}