UNPKG

ant-design-vue

Version:

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

1,344 lines 125 kB
{ "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: `<Input />`" }, "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&lt;{key: string, tab: any, slots: {tab: 'XXX'}}&gt;", "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&lt;{ label: string value: string disabled?: boolean, indeterminate?: boolean, onChange?: function }>", "description": "Specifies options, you can customize `label` with slot = \"label\" slot-scope=\"option\", Default: \\[]" }, "a-checkbox/value(v-model)": { "type": "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&lt;`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&lt;`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 `<Col>`, 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 `<Col>`, 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<CustomIconComponentProps>", "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", "descript