antd
- Version 5.24.8
- Published
- 47.9 MB
- 49 dependencies
- MIT license
Install
npm i antd
yarn add antd
pnpm add antd
Overview
An enterprise-class UI design language and React components implementation
Index
Variables
- Affix
- Alert
- Anchor
- App
- AutoComplete
- Avatar
- BackTop
- Badge
- Breadcrumb
- Button
- Calendar
- Card
- Carousel
- Cascader
- Checkbox
- Col
- Collapse
- ColorPicker
- ConfigProvider
- DatePicker
- Descriptions
- Divider
- Drawer
- Dropdown
- Empty
- Flex
- FloatButton
- Form
- Grid
- Image
- Input
- InputNumber
- Layout
- List
- Mentions
- Menu
- message
- Modal
- notification
- Pagination
- Popconfirm
- Popover
- Progress
- QRCode
- Radio
- Rate
- Result
- Row
- Segmented
- Select
- Skeleton
- Slider
- Space
- Spin
- Splitter
- Statistic
- Steps
- Switch
- Table
- Tabs
- Tag
- theme
- Timeline
- TimePicker
- Tooltip
- Tour
- Transfer
- Tree
- TreeSelect
- Typography
- Upload
- version
- Watermark
Functions
Interfaces
ConfigProviderProps
- alert
- anchor
- autoInsertSpaceInButton
- avatar
- badge
- breadcrumb
- button
- calendar
- card
- carousel
- cascader
- checkbox
- children
- collapse
- colorPicker
- componentDisabled
- componentSize
- csp
- datePicker
- descriptions
- direction
- divider
- drawer
- dropdown
- dropdownMatchSelectWidth
- empty
- flex
- floatButtonGroup
- form
- getPopupContainer
- getTargetContainer
- iconPrefixCls
- image
- input
- inputNumber
- layout
- list
- locale
- mentions
- menu
- message
- modal
- notification
- pagination
- popconfirm
- popover
- popupMatchSelectWidth
- popupOverflow
- prefixCls
- progress
- radio
- rangePicker
- rate
- renderEmpty
- result
- segmented
- select
- skeleton
- slider
- space
- spin
- splitter
- statistic
- steps
- switch
- table
- tabs
- tag
- textArea
- theme
- timeline
- timePicker
- tooltip
- tour
- transfer
- tree
- treeSelect
- typography
- upload
- variant
- virtual
- warning
- wave
ModalFuncProps
- afterClose
- autoFocusButton
- bodyStyle
- cancelButtonProps
- cancelText
- centered
- className
- closeIcon
- content
- direction
- focusTriggerAfterClose
- footer
- getContainer
- icon
- keyboard
- mask
- maskClosable
- maskStyle
- maskTransitionName
- modalRender
- okButtonProps
- okCancel
- okText
- okType
- onCancel
- onOk
- open
- prefixCls
- rootClassName
- style
- title
- transitionName
- type
- visible
- width
- wrapClassName
- zIndex
ModalProps
- afterClose
- afterOpenChange
- bodyStyle
- cancelButtonProps
- cancelText
- centered
- children
- className
- classNames
- closeIcon
- confirmLoading
- destroyOnClose
- focusTriggerAfterClose
- forceRender
- getContainer
- keyboard
- loading
- mask
- maskClosable
- maskStyle
- maskTransitionName
- modalRender
- mousePosition
- okButtonProps
- okText
- okType
- onCancel
- onOk
- open
- prefixCls
- rootClassName
- style
- title
- transitionName
- visible
- width
- wrapClassName
- wrapProps
- zIndex
TableColumnType
- defaultFilteredValue
- defaultSortOrder
- filterDropdown
- filterDropdownOpen
- filterDropdownProps
- filterDropdownVisible
- filtered
- filteredValue
- filterIcon
- filterMode
- filterMultiple
- filterOnClose
- filterResetToDefaultFilteredValue
- filters
- filterSearch
- onFilter
- onFilterDropdownOpenChange
- onFilterDropdownVisibleChange
- responsive
- showSorterTooltip
- sortDirections
- sorter
- sortIcon
- sortOrder
- title
TreeProps
- autoExpandParent
- blockNode
- checkable
- checkedKeys
- checkStrictly
- children
- className
- defaultCheckedKeys
- defaultExpandAll
- defaultExpandedKeys
- defaultExpandParent
- defaultSelectedKeys
- disabled
- draggable
- expandedKeys
- filterAntTreeNode
- icon
- loadedKeys
- multiple
- prefixCls
- selectable
- selectedKeys
- showIcon
- showLine
- style
- switcherIcon
- switcherLoadingIcon
UploadProps
- accept
- action
- beforeUpload
- children
- className
- customRequest
- data
- defaultFileList
- directory
- disabled
- fileList
- headers
- iconRender
- id
- isImageUrl
- itemRender
- listType
- locale
- maxCount
- method
- multiple
- name
- onChange
- onDownload
- onDrop
- onPreview
- onRemove
- openFileDialogOnClick
- prefixCls
- previewFile
- progress
- rootClassName
- showUploadList
- style
- supportServerRender
- transformFile
- type
- withCredentials
Type Aliases
Variables
variable Affix
const Affix: React.ForwardRefExoticComponent<any>;
variable Alert
const Alert: any;
variable Anchor
const Anchor: any;
variable App
const App: any;
variable AutoComplete
const AutoComplete: CompoundedComponent;
variable Avatar
const Avatar: any;
variable BackTop
const BackTop: React.FC<BackTopProps>;
variable Badge
const Badge: any;
variable Breadcrumb
const Breadcrumb: { <T extends AnyObject = AnyObject>(props: BreadcrumbProps<T>): React.ReactElement< unknown, any >; Item: React.FC<BreadcrumbItemProps> & { __ANT_BREADCRUMB_ITEM: boolean }; Separator: React.FC<{ children?: React.ReactNode | undefined }> & { __ANT_BREADCRUMB_SEPARATOR: boolean; }; displayName: string;};
variable Button
const Button: any;
variable Calendar
const Calendar: any;
variable Card
const Card: CardInterface;
variable Carousel
const Carousel: React.ForwardRefExoticComponent<any>;
variable Cascader
const Cascader: (< OptionType extends DefaultOptionType = DefaultOptionType, ValueField extends keyof OptionType = keyof OptionType>( props: any) => React.ReactElement) & { displayName: string; SHOW_PARENT: typeof SHOW_PARENT; SHOW_CHILD: typeof SHOW_CHILD; Panel: typeof CascaderPanel; _InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel;};
variable Checkbox
const Checkbox: any;
variable Col
const Col: React.ForwardRefExoticComponent<any>;
variable Collapse
const Collapse: any;
variable ColorPicker
const ColorPicker: any;
variable ConfigProvider
const ConfigProvider: any;
variable DatePicker
const DatePicker: DatePickerType;
variable Descriptions
const Descriptions: any;
variable Divider
const Divider: React.FC<DividerProps>;
variable Drawer
const Drawer: any;
variable Dropdown
const Dropdown: any;
variable Empty
const Empty: any;
variable Flex
const Flex: React.ForwardRefExoticComponent<any>;
variable FloatButton
const FloatButton: any;
variable Form
const Form: CompoundedComponent;
variable Grid
const Grid: { useBreakpoint: typeof useBreakpoint };
variable Image
const Image: CompositionImage<ImageProps>;
variable Input
const Input: any;
variable InputNumber
const InputNumber: (<T extends ValueType = ValueType>( props: any) => React.ReactElement) & { displayName?: string; _InternalPanelDoNotUseOrYouWillBeFired: React.FC<InputNumberProps<ValueType>>;};
variable Layout
const Layout: any;
variable List
const List: CompoundedComponent;
variable Mentions
const Mentions: any;
variable Menu
const Menu: GenericComponent;
variable message
const message: MessageMethods & BaseMethods;
variable Modal
const Modal: any;
variable notification
const notification: NoticeMethods & BaseMethods;
variable Pagination
const Pagination: React.FC<PaginationProps>;
variable Popconfirm
const Popconfirm: any;
variable Popover
const Popover: any;
variable Progress
const Progress: React.ForwardRefExoticComponent<any>;
variable QRCode
const QRCode: React.FC<QRCodeProps>;
variable Radio
const Radio: any;
variable Rate
const Rate: React.ForwardRefExoticComponent<any>;
variable Result
const Result: ResultType;
variable Row
const Row: React.ForwardRefExoticComponent<any>;
variable Segmented
const Segmented: (<ValueType>(props: any) => ReturnType<typeof InternalSegmented>) & Pick<React.FC, 'displayName'>;
variable Select
const Select: (<ValueType = any, OptionType extends unknown = DefaultOptionType>( props: any) => React.ReactElement) & { displayName?: string; SECRET_COMBOBOX_MODE_DO_NOT_USE: string; Option: any; OptGroup: any; _InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel;};
variable Skeleton
const Skeleton: any;
variable Slider
const Slider: React.ForwardRefExoticComponent<any>;
variable Space
const Space: any;
variable Spin
const Spin: any;
variable Splitter
const Splitter: any;
variable Statistic
const Statistic: any;
variable Steps
const Steps: any;
variable Switch
const Switch: any;
variable Table
const Table: RefTable & { displayName?: string; SELECTION_COLUMN: typeof SELECTION_COLUMN; EXPAND_COLUMN: any; SELECTION_ALL: typeof SELECTION_ALL; SELECTION_INVERT: typeof SELECTION_INVERT; SELECTION_NONE: typeof SELECTION_NONE; Column: typeof Column; ColumnGroup: typeof ColumnGroup; Summary: any;};
variable Tabs
const Tabs: any;
variable Tag
const Tag: any;
variable theme
const theme: { defaultSeed: import('./interface').SeedToken; useToken: typeof useToken; defaultAlgorithm: typeof defaultAlgorithm; darkAlgorithm: any; compactAlgorithm: any; getDesignToken: ( config?: import('..').ThemeConfig ) => import('./interface').AliasToken; defaultConfig: { token: import('./interface').SeedToken; override: { override: import('./interface').SeedToken }; hashed: boolean; }; _internalContext: React.Context<DesignTokenProviderProps>;};
variable Timeline
const Timeline: any;
variable TimePicker
const TimePicker: any;
variable Tooltip
const Tooltip: any;
variable Tour
const Tour: any;
variable Transfer
const Transfer: { <RecordType extends TransferItem = TransferItem>( props: TransferProps<RecordType> ): React.ReactElement<unknown, any>; displayName: string; List: { <RecordType extends KeyWiseTransferItem>( props: TransferListProps<RecordType> ): React.JSX.Element; displayName: string; }; Search: React.FC<TransferSearchProps>; Operation: React.FC<TransferOperationProps>;};
variable Tree
const Tree: CompoundedComponent;
variable TreeSelect
const TreeSelect: CompoundedComponent;
variable Typography
const Typography: any;
variable Upload
const Upload: any;
variable version
const version: string;
variable Watermark
const Watermark: React.FC<WatermarkProps>;
Functions
function unstableSetRender
unstableSetRender: (render: RenderType) => void;
Deprecated
Set React render function for compatible usage. This is internal usage only compatible with React 19. And will be removed in next major version.
Interfaces
interface AffixProps
interface AffixProps {}
property children
children: React.ReactNode;
property className
className?: string;
property offsetBottom
offsetBottom?: number;
Triggered when the specified offset is reached from the bottom of the window
property offsetTop
offsetTop?: number;
Triggered when the specified offset is reached from the top of the window
property onChange
onChange?: (affixed?: boolean) => void;
Callback function triggered when fixed state changes
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property target
target?: () => Window | HTMLElement | null;
Set the element that Affix needs to listen to its scroll event, the value is a function that returns the corresponding DOM element
interface AffixRef
interface AffixRef {}
property updatePosition
updatePosition: ReturnType<typeof throttleByAnimationFrame>;
interface AlertProps
interface AlertProps {}
property action
action?: React.ReactNode;
property afterClose
afterClose?: () => void;
Trigger when animation ending of Alert
property banner
banner?: boolean;
property className
className?: string;
property closable
closable?: ClosableType;
Whether Alert can be closed
property closeIcon
closeIcon?: React.ReactNode;
property closeText
closeText?: React.ReactNode;
Deprecated
please use
closable.closeIcon
instead. Close text to show
property description
description?: React.ReactNode;
Additional content of Alert
property icon
icon?: React.ReactNode;
property id
id?: string;
property message
message?: React.ReactNode;
Content of Alert
property onClick
onClick?: React.MouseEventHandler<HTMLDivElement>;
property onClose
onClose?: React.MouseEventHandler<HTMLButtonElement>;
Callback when close Alert
property onMouseEnter
onMouseEnter?: React.MouseEventHandler<HTMLDivElement>;
property onMouseLeave
onMouseLeave?: React.MouseEventHandler<HTMLDivElement>;
property prefixCls
prefixCls?: string;
property role
role?: string;
https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#aria-role-attribute
property rootClassName
rootClassName?: string;
property showIcon
showIcon?: boolean;
Whether to show icon
property style
style?: React.CSSProperties;
property type
type?: 'success' | 'info' | 'warning' | 'error';
Type of Alert styles, options:
success
,info
,warning
,error
interface AnchorLinkProps
interface AnchorLinkProps extends AnchorLinkBaseProps {}
property children
children?: React.ReactNode;
interface AnchorProps
interface AnchorProps {}
property affix
affix?: boolean | Omit<AffixProps, 'offsetTop' | 'target' | 'children'>;
property bounds
bounds?: number;
property children
children?: React.ReactNode;
Deprecated
Please use
items
instead.
property className
className?: string;
property direction
direction?: AnchorDirection;
property getContainer
getContainer?: () => AnchorContainer;
property getCurrentAnchor
getCurrentAnchor?: (activeLink: string) => string;
Return customize highlight anchor
property items
items?: AnchorLinkItemProps[];
property offsetTop
offsetTop?: number;
property onChange
onChange?: (currentActiveLink: string) => void;
Listening event when scrolling change active link
property onClick
onClick?: ( e: React.MouseEvent<HTMLElement>, link: { title: React.ReactNode; href: string; }) => void;
property prefixCls
prefixCls?: string;
property replace
replace?: boolean;
property rootClassName
rootClassName?: string;
property showInkInFixed
showInkInFixed?: boolean;
property style
style?: React.CSSProperties;
property targetOffset
targetOffset?: number;
Scroll to target offset value, if none, it's offsetTop prop value or 0.
interface AppProps
interface AppProps<P = AnyObject> extends AppConfig {}
interface AutoCompleteProps
interface AutoCompleteProps< ValueType = any, OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType> extends Omit< InternalSelectProps<ValueType, OptionType>, 'loading' | 'mode' | 'optionLabelProp' | 'labelInValue' > {}
property dataSource
dataSource?: DataSourceItemType[];
Deprecated
Please use
options
instead
property dropdownClassName
dropdownClassName?: string;
Deprecated
Please use
popupClassName
instead
property dropdownMatchSelectWidth
dropdownMatchSelectWidth?: boolean | number;
Deprecated
Please use
popupMatchSelectWidth
instead
property popupClassName
popupClassName?: string;
property popupMatchSelectWidth
popupMatchSelectWidth?: boolean | number;
property status
status?: InputStatus;
interface AvatarProps
interface AvatarProps {}
property alt
alt?: string;
property children
children?: React.ReactNode;
property className
className?: string;
property crossOrigin
crossOrigin?: '' | 'anonymous' | 'use-credentials';
property draggable
draggable?: boolean | 'true' | 'false';
property gap
gap?: number;
property icon
icon?: React.ReactNode;
Icon to be used in avatar
property onClick
onClick?: (e?: React.MouseEvent<HTMLElement>) => void;
property onError
onError?: () => boolean;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property shape
shape?: 'circle' | 'square';
Shape of avatar, options:
circle
,square
property size
size?: AvatarSize;
property src
src?: React.ReactNode;
Src of image avatar
property srcSet
srcSet?: string;
Srcset of image avatar
property style
style?: React.CSSProperties;
interface BackTopProps
interface BackTopProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property duration
duration?: number;
property onClick
onClick?: React.MouseEventHandler<HTMLElement>;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property target
target?: () => HTMLElement | Window | Document;
property visibilityHeight
visibilityHeight?: number;
interface BadgeProps
interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {}
property children
children?: React.ReactNode;
property className
className?: string;
property classNames
classNames?: Partial<Record<SemanticName, string>>;
property color
color?: LiteralUnion<PresetColorKey>;
property count
count?: React.ReactNode;
Number to show in badge
property dot
dot?: boolean;
Whether to show red dot without number
property offset
offset?: [number | string, number | string];
property overflowCount
overflowCount?: number;
Max count to show
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property scrollNumberPrefixCls
scrollNumberPrefixCls?: string;
property showZero
showZero?: boolean;
property size
size?: 'default' | 'small';
property status
status?: PresetStatusColorType;
property style
style?: React.CSSProperties;
property styles
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
property text
text?: React.ReactNode;
property title
title?: string;
interface BreadcrumbItemProps
interface BreadcrumbItemProps extends SeparatorType {}
property children
children?: React.ReactNode;
property className
className?: string;
property dropdownProps
dropdownProps?: DropdownProps;
property href
href?: string;
property menu
menu?: Omit<MenuType, 'items'> & { items?: MenuItem[];};
property onClick
onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLSpanElement>;
property overlay
overlay?: DropdownProps['overlay'];
Deprecated
Please use
menu
instead
property prefixCls
prefixCls?: string;
interface BreadcrumbProps
interface BreadcrumbProps<T extends AnyObject = AnyObject> {}
property children
children?: React.ReactNode;
property className
className?: string;
property itemRender
itemRender?: ( route: ItemType, params: T, routes: ItemType[], paths: string[]) => React.ReactNode;
property items
items?: ItemType[];
property params
params?: T;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property routes
routes?: ItemType[];
Deprecated
Please use
items
instead
property separator
separator?: React.ReactNode;
property style
style?: React.CSSProperties;
interface ButtonProps
interface ButtonProps extends BaseButtonProps, MergedHTMLAttributes {}
property autoInsertSpace
autoInsertSpace?: boolean;
property href
href?: string;
property htmlType
htmlType?: ButtonHTMLType;
interface CalendarProps
interface CalendarProps<DateType> {}
property cellRender
cellRender?: (date: DateType, info: CellRenderInfo<DateType>) => React.ReactNode;
property className
className?: string;
property dateCellRender
dateCellRender?: (date: DateType) => React.ReactNode;
Deprecated
Please use cellRender instead.
property dateFullCellRender
dateFullCellRender?: (date: DateType) => React.ReactNode;
Deprecated
Please use fullCellRender instead.
property defaultValue
defaultValue?: DateType;
property disabledDate
disabledDate?: (date: DateType) => boolean;
property fullCellRender
fullCellRender?: ( date: DateType, info: CellRenderInfo<DateType>) => React.ReactNode;
property fullscreen
fullscreen?: boolean;
property headerRender
headerRender?: HeaderRender<DateType>;
property locale
locale?: typeof enUS;
property mode
mode?: CalendarMode;
property monthCellRender
monthCellRender?: (date: DateType) => React.ReactNode;
Deprecated
Please use cellRender instead.
property monthFullCellRender
monthFullCellRender?: (date: DateType) => React.ReactNode;
Deprecated
Please use fullCellRender instead.
property onChange
onChange?: (date: DateType) => void;
property onPanelChange
onPanelChange?: (date: DateType, mode: CalendarMode) => void;
property onSelect
onSelect?: (date: DateType, selectInfo: SelectInfo) => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property showWeek
showWeek?: boolean;
property style
style?: React.CSSProperties;
property validRange
validRange?: [DateType, DateType];
property value
value?: DateType;
interface CardProps
interface CardProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {}
property actions
actions?: React.ReactNode[];
property activeTabKey
activeTabKey?: string;
property bodyStyle
bodyStyle?: React.CSSProperties;
Deprecated
Please use
styles.body
instead
property bordered
bordered?: boolean;
Deprecated
Please use
variant
instead
property children
children?: React.ReactNode;
property className
className?: string;
property classNames
classNames?: Partial<Record<SemanticName, string>>;
property cover
cover?: React.ReactNode;
property defaultActiveTabKey
defaultActiveTabKey?: string;
property extra
extra?: React.ReactNode;
property headStyle
headStyle?: React.CSSProperties;
Deprecated
Please use
styles.header
instead
property hoverable
hoverable?: boolean;
property id
id?: string;
property loading
loading?: boolean;
property onTabChange
onTabChange?: (key: string) => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: CardSize;
property style
style?: React.CSSProperties;
property styles
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
property tabBarExtraContent
tabBarExtraContent?: React.ReactNode;
property tabList
tabList?: CardTabListType[];
property tabProps
tabProps?: TabsProps;
property title
title?: React.ReactNode;
property type
type?: CardType;
property variant
variant?: 'borderless' | 'outlined';
interface CarouselProps
interface CarouselProps extends Omit<Settings, 'dots' | 'dotsClass' | 'autoplay'> {}
property autoplay
autoplay?: | boolean | { dotDuration?: boolean; };
property children
children?: React.ReactNode;
property dotPosition
dotPosition?: DotPosition;
property dots
dots?: | boolean | { className?: string; };
property effect
effect?: CarouselEffect;
property id
id?: string;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property slickGoTo
slickGoTo?: number;
property style
style?: React.CSSProperties;
property waitForAnimate
waitForAnimate?: boolean;
interface CascaderProps
interface CascaderProps< OptionType extends DefaultOptionType = DefaultOptionType, ValueField extends keyof OptionType = keyof OptionType, Multiple extends boolean = boolean> extends Omit<RcCascaderProps<OptionType, ValueField, Multiple>, 'checkable'> {}
property autoClearSearchValue
autoClearSearchValue?: boolean;
property bordered
bordered?: boolean;
Deprecated
Use
variant
instead.
property disabled
disabled?: boolean;
property dropdownClassName
dropdownClassName?: string;
Deprecated
Please use
popupClassName
instead
property multiple
multiple?: Multiple;
property options
options?: OptionType[];
property placement
placement?: SelectCommonPlacement;
property popupClassName
popupClassName?: string;
property rootClassName
rootClassName?: string;
property showArrow
showArrow?: boolean;
Deprecated
showArrow
is deprecated which will be removed in next major version. It will be a default behavior, you can hide it by settingsuffixIcon
to null.
property size
size?: SizeType;
property status
status?: InputStatus;
property suffixIcon
suffixIcon?: React.ReactNode;
property variant
variant?: Variant;
5.13.0 "outlined"
interface CheckboxChangeEvent
interface CheckboxChangeEvent {}
property nativeEvent
nativeEvent: MouseEvent;
property preventDefault
preventDefault: () => void;
property stopPropagation
stopPropagation: () => void;
property target
target: CheckboxChangeEventTarget;
interface CheckboxOptionType
interface CheckboxOptionType<T = any> {}
interface CheckboxProps
interface CheckboxProps extends AbstractCheckboxProps<CheckboxChangeEvent> {}
property indeterminate
indeterminate?: boolean;
interface CollapsePanelProps
interface CollapsePanelProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property collapsible
collapsible?: CollapsibleType;
property disabled
disabled?: boolean;
Deprecated
Use
collapsible="disabled"
instead
property extra
extra?: React.ReactNode;
property forceRender
forceRender?: boolean;
property header
header: React.ReactNode;
property id
id?: string;
property key
key: string | number;
property prefixCls
prefixCls?: string;
property showArrow
showArrow?: boolean;
property style
style?: React.CSSProperties;
interface CollapseProps
interface CollapseProps extends Pick<RcCollapseProps, 'items'> {}
property accordion
accordion?: boolean;
手风琴效果
property activeKey
activeKey?: Array<string | number> | string | number;
property bordered
bordered?: boolean;
property children
children?: React.ReactNode;
Deprecated
use
items
instead
property className
className?: string;
property collapsible
collapsible?: CollapsibleType;
property defaultActiveKey
defaultActiveKey?: Array<string | number> | string | number;
property destroyInactivePanel
destroyInactivePanel?: boolean;
property expandIcon
expandIcon?: (panelProps: PanelProps) => React.ReactNode;
property expandIconPosition
expandIconPosition?: ExpandIconPosition;
property ghost
ghost?: boolean;
property onChange
onChange?: (key: string[]) => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: SizeType;
property style
style?: React.CSSProperties;
interface ColProps
interface ColProps extends React.HTMLAttributes<HTMLDivElement>, Partial<Record<Breakpoint, ColSpanType | ColSize>> {}
interface ConfigProviderProps
interface ConfigProviderProps {}
property alert
alert?: AlertConfig;
property anchor
anchor?: ComponentStyleConfig;
property autoInsertSpaceInButton
autoInsertSpaceInButton?: boolean;
Deprecated
Please use
{ button: { autoInsertSpace: boolean }}
instead
property avatar
avatar?: ComponentStyleConfig;
property badge
badge?: BadgeConfig;
property breadcrumb
breadcrumb?: ComponentStyleConfig;
property button
button?: ButtonConfig;
property calendar
calendar?: ComponentStyleConfig;
property card
card?: CardConfig;
property carousel
carousel?: ComponentStyleConfig;
property cascader
cascader?: CascaderConfig;
property checkbox
checkbox?: ComponentStyleConfig;
property children
children?: React.ReactNode;
property collapse
collapse?: CollapseConfig;
property colorPicker
colorPicker?: ComponentStyleConfig;
property componentDisabled
componentDisabled?: boolean;
property componentSize
componentSize?: SizeType;
property csp
csp?: CSPConfig;
property datePicker
datePicker?: DatePickerConfig;
property descriptions
descriptions?: ComponentStyleConfig;
property direction
direction?: DirectionType;
设置布局展示方向。 Set direction of layout. ltr
property divider
divider?: ComponentStyleConfig;
property drawer
drawer?: DrawerConfig;
property dropdown
dropdown?: ComponentStyleConfig;
property dropdownMatchSelectWidth
dropdownMatchSelectWidth?: boolean;
Deprecated
Please use
popupMatchSelectWidth
instead
property empty
empty?: EmptyConfig;
property flex
flex?: FlexConfig;
property floatButtonGroup
floatButtonGroup?: FloatButtonGroupConfig;
property form
form?: FormConfig;
property getPopupContainer
getPopupContainer?: (triggerNode?: HTMLElement) => HTMLElement;
property getTargetContainer
getTargetContainer?: () => HTMLElement | Window;
property iconPrefixCls
iconPrefixCls?: string;
property image
image?: ImageConfig;
property input
input?: InputConfig;
property inputNumber
inputNumber?: InputNumberConfig;
property layout
layout?: ComponentStyleConfig;
property list
list?: ListConfig;
property locale
locale?: Locale;
语言包配置,语言包可到
antd/locale
目录下寻找。 Language package setting, you can find the packages inantd/locale
.
property mentions
mentions?: MentionsConfig;
property menu
menu?: MenuConfig;
property message
message?: ComponentStyleConfig;
property modal
modal?: ModalConfig;
property notification
notification?: NotificationConfig;
property pagination
pagination?: PaginationConfig;
property popconfirm
popconfirm?: PopconfirmConfig;
property popover
popover?: PopoverConfig;
property popupMatchSelectWidth
popupMatchSelectWidth?: boolean;
property popupOverflow
popupOverflow?: PopupOverflow;
property prefixCls
prefixCls?: string;
property progress
progress?: ComponentStyleConfig;
property radio
radio?: ComponentStyleConfig;
property rangePicker
rangePicker?: RangePickerConfig;
property rate
rate?: ComponentStyleConfig;
property renderEmpty
renderEmpty?: RenderEmptyHandler;
property result
result?: ComponentStyleConfig;
property segmented
segmented?: ComponentStyleConfig;
property select
select?: SelectConfig;
property skeleton
skeleton?: ComponentStyleConfig;
property slider
slider?: ComponentStyleConfig;
property space
space?: SpaceConfig;
property spin
spin?: SpinConfig;
property splitter
splitter?: ComponentStyleConfig;
property statistic
statistic?: ComponentStyleConfig;
property steps
steps?: ComponentStyleConfig;
property switch
switch?: ComponentStyleConfig;
property table
table?: TableConfig;
property tabs
tabs?: TabsConfig;
property tag
tag?: TagConfig;
property textArea
textArea?: TextAreaConfig;
property theme
theme?: ThemeConfig;
property timeline
timeline?: ComponentStyleConfig;
property timePicker
timePicker?: TimePickerConfig;
property tooltip
tooltip?: TooltipConfig;
property tour
tour?: TourConfig;
property transfer
transfer?: TransferConfig;
property tree
tree?: ComponentStyleConfig;
property treeSelect
treeSelect?: TreeSelectConfig;
property typography
typography?: ComponentStyleConfig;
property upload
upload?: ComponentStyleConfig;
property variant
variant?: Variant;
property virtual
virtual?: boolean;
设置
false
时关闭虚拟滚动。 Close the virtual scrolling when settingfalse
. true
property warning
warning?: WarningContextProps;
property wave
wave?: WaveConfig;
Wave is special component which only patch on the effect of component interaction.
interface CountdownProps
interface CountdownProps extends StatisticProps {}
interface DescriptionsProps
interface DescriptionsProps {}
property bordered
bordered?: boolean;
property children
children?: React.ReactNode;
Deprecated
use
items
instead
property className
className?: string;
property classNames
classNames?: Partial<Record<SemanticName, string>>;
property colon
colon?: boolean;
property column
column?: number | Partial<Record<Breakpoint, number>>;
property contentStyle
contentStyle?: React.CSSProperties;
property extra
extra?: React.ReactNode;
property id
id?: string;
property items
items?: DescriptionsItemType[];
property labelStyle
labelStyle?: React.CSSProperties;
property layout
layout?: 'horizontal' | 'vertical';
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: 'middle' | 'small' | 'default';
property style
style?: React.CSSProperties;
property styles
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
property title
title?: React.ReactNode;
interface DividerProps
interface DividerProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property dashed
dashed?: boolean;
property orientation
orientation?: 'left' | 'right' | 'center' | 'start' | 'end';
center
property orientationMargin
orientationMargin?: string | number;
property plain
plain?: boolean;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property type
type?: 'horizontal' | 'vertical';
property variant
variant?: 'dashed' | 'dotted' | 'solid';
5.20.0 solid
interface DrawerProps
interface DrawerProps extends Omit<RcDrawerProps, 'maskStyle'>, Omit<DrawerPanelProps, 'prefixCls'> {}
property afterOpenChange
afterOpenChange?: (open: boolean) => void;
property afterVisibleChange
afterVisibleChange?: (open: boolean) => void;
Deprecated
Please use
afterOpenChange
instead
property classNames
classNames?: DrawerClassNames;
property open
open?: boolean;
property size
size?: sizeType;
property styles
styles?: DrawerStyles;
property visible
visible?: boolean;
Deprecated
Please use
open
instead
interface DropdownProps
interface DropdownProps {}
property align
align?: AlignType;
property arrow
arrow?: boolean | DropdownArrowOptions;
property autoAdjustOverflow
autoAdjustOverflow?: boolean | AdjustOverflow;
property autoFocus
autoFocus?: boolean;
property children
children?: React.ReactNode;
property className
className?: string;
property destroyPopupOnHide
destroyPopupOnHide?: boolean;
property disabled
disabled?: boolean;
property dropdownRender
dropdownRender?: (originNode: React.ReactNode) => React.ReactNode;
property forceRender
forceRender?: boolean;
property getPopupContainer
getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
property menu
menu?: MenuProps;
property mouseEnterDelay
mouseEnterDelay?: number;
property mouseLeaveDelay
mouseLeaveDelay?: number;
property onOpenChange
onOpenChange?: ( open: boolean, info: { source: 'trigger' | 'menu'; }) => void;
property onVisibleChange
onVisibleChange?: (open: boolean) => void;
Deprecated
Please use
onOpenChange
instead
property open
open?: boolean;
property openClassName
openClassName?: string;
property overlay
overlay?: React.ReactElement | OverlayFunc;
Deprecated
Please use
menu
instead
property overlayClassName
overlayClassName?: string;
property overlayStyle
overlayStyle?: React.CSSProperties;
property placement
placement?: Placement;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property transitionName
transitionName?: string;
property trigger
trigger?: ('click' | 'hover' | 'contextMenu')[];
property visible
visible?: boolean;
Deprecated
Please use
open
instead
interface DropDownProps
interface DropdownProps {}
property align
align?: AlignType;
property arrow
arrow?: boolean | DropdownArrowOptions;
property autoAdjustOverflow
autoAdjustOverflow?: boolean | AdjustOverflow;
property autoFocus
autoFocus?: boolean;
property children
children?: React.ReactNode;
property className
className?: string;
property destroyPopupOnHide
destroyPopupOnHide?: boolean;
property disabled
disabled?: boolean;
property dropdownRender
dropdownRender?: (originNode: React.ReactNode) => React.ReactNode;
property forceRender
forceRender?: boolean;
property getPopupContainer
getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
property menu
menu?: MenuProps;
property mouseEnterDelay
mouseEnterDelay?: number;
property mouseLeaveDelay
mouseLeaveDelay?: number;
property onOpenChange
onOpenChange?: ( open: boolean, info: { source: 'trigger' | 'menu'; }) => void;
property onVisibleChange
onVisibleChange?: (open: boolean) => void;
Deprecated
Please use
onOpenChange
instead
property open
open?: boolean;
property openClassName
openClassName?: string;
property overlay
overlay?: React.ReactElement | OverlayFunc;
Deprecated
Please use
menu
instead
property overlayClassName
overlayClassName?: string;
property overlayStyle
overlayStyle?: React.CSSProperties;
property placement
placement?: Placement;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property transitionName
transitionName?: string;
property trigger
trigger?: ('click' | 'hover' | 'contextMenu')[];
property visible
visible?: boolean;
Deprecated
Please use
open
instead
interface EmptyProps
interface EmptyProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property classNames
classNames?: Partial<Record<SemanticName, string>>;
property description
description?: React.ReactNode;
property image
image?: React.ReactNode;
property imageStyle
imageStyle?: React.CSSProperties;
Deprecated
Please use
styles={{ image: {} }}
instead
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property styles
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
interface FlexProps
interface FlexProps<P = AnyObject> extends React.HTMLAttributes<HTMLElement> {}
property align
align?: React.CSSProperties['alignItems'];
property children
children: React.ReactNode;
property component
component?: CustomComponent<P>;
property flex
flex?: React.CSSProperties['flex'];
property gap
gap?: React.CSSProperties['gap'] | SizeType;
property justify
justify?: React.CSSProperties['justifyContent'];
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property vertical
vertical?: boolean;
property wrap
wrap?: boolean | React.CSSProperties['flexWrap'];
interface FloatButtonGroupProps
interface FloatButtonGroupProps extends FloatButtonProps {}
interface FloatButtonProps
interface FloatButtonProps extends React.DOMAttributes<FloatButtonElement> {}
property 'aria-label'
'aria-label'?: React.HtmlHTMLAttributes<HTMLElement>['aria-label'];
property badge
badge?: FloatButtonBadgeProps;
property className
className?: string;
property description
description?: React.ReactNode;
property href
href?: string;
property htmlType
htmlType?: ButtonHTMLType;
5.21.0 button
property icon
icon?: React.ReactNode;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property shape
shape?: FloatButtonShape;
property style
style?: React.CSSProperties;
property target
target?: React.HTMLAttributeAnchorTarget;
property tooltip
tooltip?: TooltipProps['title'];
property type
type?: FloatButtonType;
interface FloatButtonRef
interface FloatButtonRef {}
property nativeElement
nativeElement: FloatButtonElement | null;
interface FormInstance
interface FormInstance<Values = any> extends RcFormInstance<Values> {}
property focusField
focusField: (name: NamePath) => void;
property getFieldInstance
getFieldInstance: (name: NamePath) => any;
property scrollToField
scrollToField: (name: NamePath, options?: ScrollOptions) => void;
interface FormItemProps
interface FormItemProps<Values = any> extends Omit<FormItemLabelProps, 'requiredMark'>, FormItemInputProps, RcFieldProps<Values> {}
property children
children?: ChildrenType<Values>;
property className
className?: string;
property fieldKey
fieldKey?: React.Key | React.Key[];
Deprecated
No need anymore
property hasFeedback
hasFeedback?: | boolean | { icons: FeedbackIcons; };
property hidden
hidden?: boolean;
property id
id?: string;
property initialValue
initialValue?: any;
property layout
layout?: FormItemLayout;
property messageVariables
messageVariables?: Record<string, string>;
property noStyle
noStyle?: boolean;
property prefixCls
prefixCls?: string;
property required
required?: boolean;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property tooltip
tooltip?: LabelTooltipType;
property validateStatus
validateStatus?: ValidateStatus;
interface FormListFieldData
interface FormListFieldData {}
interface FormListOperation
interface FormListOperation {}
interface FormProps
interface FormProps<Values = any> extends Omit<RcFormProps<Values>, 'form'> {}
property colon
colon?: boolean;
property disabled
disabled?: boolean;
property feedbackIcons
feedbackIcons?: FeedbackIcons;
property form
form?: FormInstance<Values>;
property hideRequiredMark
hideRequiredMark?: boolean;
Deprecated
Will warning in future branch. Pls use
requiredMark
instead.
property labelAlign
labelAlign?: FormLabelAlign;
property labelCol
labelCol?: ColProps;
property labelWrap
labelWrap?: boolean;
property layout
layout?: FormLayout;
property name
name?: string;
property prefixCls
prefixCls?: string;
property requiredMark
requiredMark?: RequiredMark;
property rootClassName
rootClassName?: string;
property scrollToFirstError
scrollToFirstError?: ScrollFocusOptions | boolean;
property size
size?: SizeType;
property variant
variant?: Variant;
property wrapperCol
wrapperCol?: ColProps;
interface InputNumberProps
interface InputNumberProps<T extends ValueType = ValueType> extends Omit<RcInputNumberProps<T>, 'prefix' | 'size' | 'controls'> {}
property addonAfter
addonAfter?: React.ReactNode;
property addonBefore
addonBefore?: React.ReactNode;
property bordered
bordered?: boolean;
Deprecated
Use
variant
instead.
property controls
controls?: | boolean | { upIcon?: React.ReactNode; downIcon?: React.ReactNode; };
property disabled
disabled?: boolean;
property prefix
prefix?: React.ReactNode;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: SizeType;
property status
status?: InputStatus;
property suffix
suffix?: React.ReactNode;
property variant
variant?: Variant;
5.13.0 "outlined"
interface InputProps
interface InputProps extends Omit< RcInputProps, | 'wrapperClassName' | 'groupClassName' | 'inputClassName' | 'affixWrapperClassName' | 'classes' > {}
property bordered
bordered?: boolean;
Deprecated
Use
variant="borderless"
instead.
property disabled
disabled?: boolean;
property rootClassName
rootClassName?: string;
property size
size?: SizeType;
property status
status?: InputStatus;
property variant
variant?: Variant;
5.13.0 "outlined"
index signature
[key: `data-${string}`]: string | undefined;
interface LayoutProps
interface BasicProps extends React.HTMLAttributes<HTMLDivElement> {}
property hasSider
hasSider?: boolean;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property suffixCls
suffixCls?: string;
interface ListProps
interface ListProps<T> {}
property bordered
bordered?: boolean;
property children
children?: React.ReactNode;
property className
className?: string;
property dataSource
dataSource?: T[];
property extra
extra?: React.ReactNode;
property footer
footer?: React.ReactNode;
property grid
grid?: ListGridType;
property header
header?: React.ReactNode;
property id
id?: string;
property itemLayout
itemLayout?: ListItemLayout;
property loading
loading?: boolean | SpinProps;
property loadMore
loadMore?: React.ReactNode;
property locale
locale?: ListLocale;
property pagination
pagination?: PaginationConfig | false;
property prefixCls
prefixCls?: string;
property renderItem
renderItem?: (item: T, index: number) => React.ReactNode;
property rootClassName
rootClassName?: string;
property rowKey
rowKey?: ((item: T) => React.Key) | keyof T;
property size
size?: ListSize;
property split
split?: boolean;
property style
style?: React.CSSProperties;
interface MentionProps
interface MentionProps extends Omit<RcMentionsProps, 'suffix'> {}
property loading
loading?: boolean;
property options
options?: MentionsOptionProps[];
property popupClassName
popupClassName?: string;
property rootClassName
rootClassName?: string;
property status
status?: InputStatus;
property variant
variant?: Variant;
5.13.0 "outlined"
interface MentionsProps
interface MentionsProps extends MentionProps {}
interface MenuItemProps
interface MenuItemProps extends Omit<RcMenuItemProps, 'title'> {}
interface MenuProps
interface MenuProps extends Omit<RcMenuProps, 'items' | '_internalComponents'> {}
property inlineIndent
inlineIndent?: number;
property items
items?: ItemType[];
property theme
theme?: MenuTheme;
interface MessageArgsProps
interface ArgsProps {}
property className
className?: string;
property content
content: React.ReactNode;
消息通知的内容,接收组件或者字符串 The content of the message notification, receiving component or string
property duration
duration?: number;
消息通知持续显示的时间 How long the message notification remains displayed
property icon
icon?: React.ReactNode;
property key
key?: string | number;
property onClick
onClick?: (e: React.MouseEvent<HTMLDivElement>) => void;
消息通知点击时的回调函数 Callback function when message notification is clicked
property onClose
onClose?: () => void;
消息通知关闭时进行调用的回调函数 The callback function called when the message notification is closed
property style
style?: React.CSSProperties;
property type
type?: NoticeType;
消息通知的类型,可以是 'info'、'success'、'error'、'warning' 或 'loading' The type of message notification, which can be 'info', 'success', 'error', 'warning' or 'loading'
interface ModalFuncProps
interface ModalFuncProps extends ModalCommonProps {}
property afterClose
afterClose?: () => void;
property autoFocusButton
autoFocusButton?: null | 'ok' | 'cancel';
property bodyStyle
bodyStyle?: React.CSSProperties;
Deprecated
Please use
styles.body
instead
property cancelButtonProps
cancelButtonProps?: ButtonProps;
property cancelText
cancelText?: React.ReactNode;
property centered
centered?: boolean;
property className
className?: string;
property closeIcon
closeIcon?: React.ReactNode;
property content
content?: React.ReactNode;
property direction
direction?: DirectionType;
property focusTriggerAfterClose
focusTriggerAfterClose?: boolean;
property footer
footer?: ModalProps['footer'];
property getContainer
getContainer?: string | HTMLElement | getContainerFunc | false;
property icon
icon?: React.ReactNode;
property keyboard
keyboard?: boolean;
property mask
mask?: boolean;
property maskClosable
maskClosable?: boolean;
property maskStyle
maskStyle?: React.CSSProperties;
Deprecated
Please use
styles.mask
instead
property maskTransitionName
maskTransitionName?: string;
property modalRender
modalRender?: (node: React.ReactNode) => React.ReactNode;
property okButtonProps
okButtonProps?: ButtonProps;
property okCancel
okCancel?: boolean;
property okText
okText?: React.ReactNode;
property okType
okType?: LegacyButtonType;
property onCancel
onCancel?: (...args: any[]) => any;
property onOk
onOk?: (...args: any[]) => any;
property open
open?: boolean;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property title
title?: React.ReactNode;
property transitionName
transitionName?: string;
property type
type?: 'info' | 'success' | 'error' | 'warn' | 'warning' | 'confirm';
property visible
visible?: boolean;
Deprecated
Please use
open
instead.
property width
width?: string | number;
property wrapClassName
wrapClassName?: string;
property zIndex
zIndex?: number;
interface ModalProps
interface ModalProps extends ModalCommonProps {}
property afterClose
afterClose?: () => void;
property afterOpenChange
afterOpenChange?: (open: boolean) => void;
Callback when the animation ends when Modal is turned on and off
property bodyStyle
bodyStyle?: React.CSSProperties;
Deprecated
Please use
styles.body
instead
property cancelButtonProps
cancelButtonProps?: ButtonProps;
property cancelText
cancelText?: React.ReactNode;
Text of the Cancel button
property centered
centered?: boolean;
Centered Modal
property children
children?: React.ReactNode;
property className
className?: string;
property classNames
classNames?: NonNullable<DialogProps['classNames']>;
property closeIcon
closeIcon?: React.ReactNode;
property confirmLoading
confirmLoading?: boolean;
Whether to apply loading visual effect for OK button or not
property destroyOnClose
destroyOnClose?: boolean;
property focusTriggerAfterClose
focusTriggerAfterClose?: boolean;
property forceRender
forceRender?: boolean;
Force render Modal
property getContainer
getContainer?: string | HTMLElement | getContainerFunc | false;
property keyboard
keyboard?: boolean;
property loading
loading?: boolean;
5.18.0
property mask
mask?: boolean;
property maskClosable
maskClosable?: boolean;
Whether to close the modal dialog when the mask (area outside the modal) is clicked
property maskStyle
maskStyle?: React.CSSProperties;
Deprecated
Please use
styles.mask
instead
property maskTransitionName
maskTransitionName?: string;
property modalRender
modalRender?: (node: React.ReactNode) => React.ReactNode;
property mousePosition
mousePosition?: MousePosition;
property okButtonProps
okButtonProps?: ButtonProps;
property okText
okText?: React.ReactNode;
Text of the OK button
property okType
okType?: LegacyButtonType;
Button
type
of the OK button
property onCancel
onCancel?: (e: React.MouseEvent<HTMLButtonElement>) => void;
Specify a function that will be called when a user clicks mask, close button on top right or Cancel button
property onOk
onOk?: (e: React.MouseEvent<HTMLButtonElement>) => void;
Specify a function that will be called when a user clicks the OK button
property open
open?: boolean;
Whether the modal dialog is visible or not
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property title
title?: React.ReactNode;
The modal dialog's title
property transitionName
transitionName?: string;
property visible
visible?: boolean;
Deprecated
Please use
open
instead.
property width
width?: string | number | Partial<Record<Breakpoint, string | number>>;
Width of the modal dialog
property wrapClassName
wrapClassName?: string;
property wrapProps
wrapProps?: any;
property zIndex
zIndex?: number;
interface NotificationArgsProps
interface ArgsProps {}
property actions
actions?: React.ReactNode;
property btn
btn?: React.ReactNode;
Deprecated
Please use
actions
instead
property className
className?: string;
property closable
closable?: ClosableType;
property closeIcon
closeIcon?: React.ReactNode;
property description
description?: React.ReactNode;
property duration
duration?: number | null;
property icon
icon?: React.ReactNode;
property key
key?: React.Key;
property message
message: React.ReactNode;
property onClick
onClick?: () => void;
property onClose
onClose?: () => void;
property pauseOnHover
pauseOnHover?: boolean;
property placement
placement?: NotificationPlacement;
property props
props?: DivProps;
property role
role?: 'alert' | 'status';
property showProgress
showProgress?: boolean;
property style
style?: React.CSSProperties;
property type
readonly type?: IconType;
interface PaginationProps
interface PaginationProps extends Omit<RcPaginationProps, 'showSizeChanger' | 'pageSizeOptions'> {}
property pageSizeOptions
pageSizeOptions?: (string | number)[];
string
type will be removed in next major version.
property responsive
responsive?: boolean;
property role
role?: string;
property rootClassName
rootClassName?: string;
property selectComponentClass
selectComponentClass?: any;
Deprecated
Not official support. Will be removed in next major version.
property showQuickJumper
showQuickJumper?: | boolean | { goButton?: React.ReactNode; };
property showSizeChanger
showSizeChanger?: boolean | SelectProps;
property size
size?: 'default' | 'small';
property totalBoundaryShowSizeChanger
totalBoundaryShowSizeChanger?: number;
interface PopconfirmProps
interface PopconfirmProps extends AbstractTooltipProps {}
property cancelButtonProps
cancelButtonProps?: ButtonProps;
property cancelText
cancelText?: React.ReactNode;
property description
description?: React.ReactNode | RenderFunction;
property disabled
disabled?: boolean;
property icon
icon?: React.ReactNode;
property okButtonProps
okButtonProps?: ButtonProps;
property okText
okText?: React.ReactNode;
property okType
okType?: LegacyButtonType;
property onCancel
onCancel?: (e?: React.MouseEvent<HTMLElement>) => void;
property onConfirm
onConfirm?: (e?: React.MouseEvent<HTMLElement>) => void;
property onOpenChange
onOpenChange?: ( open: boolean, e?: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLDivElement>) => void;
property onPopupClick
onPopupClick?: (e: React.MouseEvent<HTMLElement>) => void;
property showCancel
showCancel?: boolean;
property title
title: React.ReactNode | RenderFunction;
interface PopoverProps
interface PopoverProps extends AbstractTooltipProps {}
property content
content?: React.ReactNode | RenderFunction;
property onOpenChange
onOpenChange?: ( open: boolean, e?: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLDivElement>) => void;
property title
title?: React.ReactNode | RenderFunction;
interface ProgressProps
interface ProgressProps extends ProgressAriaProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property format
format?: (percent?: number, successPercent?: number) => React.ReactNode;
property gapDegree
gapDegree?: number;
property gapPosition
gapPosition?: 'top' | 'bottom' | 'left' | 'right';
property percent
percent?: number;
property percentPosition
percentPosition?: PercentPositionType;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property rounding
rounding?: (step: number) => number;
property showInfo
showInfo?: boolean;
property size
size?: | number | [number | string, number] | ProgressSize | { width?: number; height?: number; };
property status
status?: (typeof ProgressStatuses)[number];
property steps
steps?: | number | { count: number; gap: number; };
property strokeColor
strokeColor?: string | string[] | ProgressGradient;
property strokeLinecap
strokeLinecap?: 'butt' | 'square' | 'round';
property strokeWidth
strokeWidth?: number;
property style
style?: React.CSSProperties;
property success
success?: SuccessProps;
property successPercent
successPercent?: number;
Deprecated
Use
success
instead
property trailColor
trailColor?: string;
property type
type?: ProgressType;
property width
width?: number;
Deprecated
Use
size
instead
interface QRCodeProps
interface QRCodeProps extends QRProps, React.HTMLAttributes<HTMLDivElement> {}
property bordered
bordered?: boolean;
property className
className?: string;
property errorLevel
errorLevel?: 'L' | 'M' | 'Q' | 'H';
property icon
icon?: string;
property iconSize
iconSize?: | number | { width: number; height: number; };
property onRefresh
onRefresh?: () => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property status
status?: QRStatus;
property statusRender
statusRender?: (info: StatusRenderInfo) => ReactNode;
property type
type?: 'canvas' | 'svg';
interface RadioChangeEvent
interface RadioChangeEvent {}
property nativeEvent
nativeEvent: MouseEvent;
property preventDefault
preventDefault: () => void;
property stopPropagation
stopPropagation: () => void;
property target
target: RadioChangeEventTarget;
interface RadioGroupProps
interface RadioGroupProps extends AbstractCheckboxGroupProps {}
property block
block?: boolean;
property buttonStyle
buttonStyle?: RadioGroupButtonStyle;
property children
children?: React.ReactNode;
property defaultValue
defaultValue?: any;
property disabled
disabled?: boolean;
property id
id?: string;
property name
name?: string;
property onBlur
onBlur?: React.FocusEventHandler<HTMLDivElement>;
property onChange
onChange?: (e: RadioChangeEvent) => void;
property onFocus
onFocus?: React.FocusEventHandler<HTMLDivElement>;
property onMouseEnter
onMouseEnter?: React.MouseEventHandler<HTMLDivElement>;
property onMouseLeave
onMouseLeave?: React.MouseEventHandler<HTMLDivElement>;
property optionType
optionType?: RadioGroupOptionType;
property size
size?: SizeType;
property value
value?: any;
interface RadioProps
interface RadioProps extends AbstractCheckboxProps<RadioChangeEvent> {}
interface RateProps
interface RateProps extends RcRateProps {}
property rootClassName
rootClassName?: string;
property tooltips
tooltips?: Array<string>;
interface ResultProps
interface ResultProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property extra
extra?: React.ReactNode;
property icon
icon?: React.ReactNode;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property status
status?: ResultStatusType;
property style
style?: React.CSSProperties;
property subTitle
subTitle?: React.ReactNode;
property title
title?: React.ReactNode;
interface RowProps
interface RowProps extends React.HTMLAttributes<HTMLDivElement> {}
interface SegmentedProps
interface SegmentedProps<ValueType = RcSegmentedValue> extends Omit<RCSegmentedProps<ValueType>, 'size' | 'options'> {}
property block
block?: boolean;
Option to fit width to its parent's width
property options
options: SegmentedOptions<ValueType>;
property rootClassName
rootClassName?: string;
property shape
shape?: 'default' | 'round';
property size
size?: SizeType;
Option to control the display size
property vertical
vertical?: boolean;
interface SelectProps
interface SelectProps< ValueType = any, OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType> extends Omit< InternalSelectProps<ValueType, OptionType>, 'mode' | 'getInputElement' | 'getRawInputElement' | 'backfill' | 'placement' > {}
property dropdownClassName
dropdownClassName?: string;
Deprecated
Please use
popupClassName
instead
property dropdownMatchSelectWidth
dropdownMatchSelectWidth?: boolean | number;
Deprecated
Please use
popupMatchSelectWidth
instead
property mode
mode?: 'multiple' | 'tags';
property placement
placement?: SelectCommonPlacement;
property popupClassName
popupClassName?: string;
property popupMatchSelectWidth
popupMatchSelectWidth?: boolean | number;
property status
status?: InputStatus;
interface SiderProps
interface SiderProps extends React.HTMLAttributes<HTMLDivElement> {}
property breakpoint
breakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
property collapsed
collapsed?: boolean;
property collapsedWidth
collapsedWidth?: number | string;
property collapsible
collapsible?: boolean;
property defaultCollapsed
defaultCollapsed?: boolean;
property onBreakpoint
onBreakpoint?: (broken: boolean) => void;
property onCollapse
onCollapse?: (collapsed: boolean, type: CollapseType) => void;
property prefixCls
prefixCls?: string;
property reverseArrow
reverseArrow?: boolean;
property theme
theme?: SiderTheme;
property trigger
trigger?: React.ReactNode;
property width
width?: number | string;
property zeroWidthTriggerStyle
zeroWidthTriggerStyle?: React.CSSProperties;
interface SkeletonProps
interface SkeletonProps {}
property active
active?: boolean;
property avatar
avatar?: SkeletonAvatarProps | boolean;
property children
children?: React.ReactNode;
property className
className?: string;
property loading
loading?: boolean;
property paragraph
paragraph?: SkeletonParagraphProps | boolean;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property round
round?: boolean;
property style
style?: React.CSSProperties;
property title
title?: SkeletonTitleProps | boolean;
interface SliderSingleProps
interface SliderSingleProps extends SliderBaseProps {}
property defaultValue
defaultValue?: number;
property handleStyle
handleStyle?: React.CSSProperties;
Deprecated
Please use
styles.handle
instead
property onAfterChange
onAfterChange?: (value: number) => void;
Deprecated
Please use
onChangeComplete
instead
property onChange
onChange?: (value: number) => void;
property onChangeComplete
onChangeComplete?: (value: number) => void;
property railStyle
railStyle?: React.CSSProperties;
Deprecated
Please use
styles.rail
instead
property range
range?: false;
property trackStyle
trackStyle?: React.CSSProperties;
Deprecated
Please use
styles.track
instead
property value
value?: number;
interface SpaceProps
interface SpaceProps extends React.HTMLAttributes<HTMLDivElement> {}
property align
align?: 'start' | 'end' | 'center' | 'baseline';
property className
className?: string;
property classNames
classNames?: { item: string;};
property direction
direction?: 'horizontal' | 'vertical';
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: SpaceSize | [SpaceSize, SpaceSize];
property split
split?: React.ReactNode;
property style
style?: React.CSSProperties;
property styles
styles?: { item: React.CSSProperties;};
property wrap
wrap?: boolean;
interface SpinProps
interface SpinProps {}
property children
children?: React.ReactNode;
Children of Spin
property className
className?: string;
Additional class name of Spin
property delay
delay?: number;
Specifies a delay in milliseconds for loading state (prevent flush)
property fullscreen
fullscreen?: boolean;
Display a backdrop with the
Spin
component
property indicator
indicator?: SpinIndicator;
React node of the spinning indicator
property percent
percent?: number | 'auto';
property prefixCls
prefixCls?: string;
Customize prefix class name
property rootClassName
rootClassName?: string;
Additional root class name of Spin
property size
size?: SpinSize;
Size of Spin, options:
small
,default
andlarge
property spinning
spinning?: boolean;
Whether Spin is spinning
property style
style?: React.CSSProperties;
Style of Spin
property tip
tip?: React.ReactNode;
Customize description content when Spin has children
property wrapperClassName
wrapperClassName?: string;
The className of wrapper when Spin has children
interface SplitterProps
interface SplitterProps {}
property className
className?: string;
property layout
layout?: 'horizontal' | 'vertical';
property lazy
lazy?: boolean;
property onResize
onResize?: (sizes: number[]) => void;
property onResizeEnd
onResizeEnd?: (sizes: number[]) => void;
property onResizeStart
onResizeStart?: (sizes: number[]) => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
interface StepProps
interface StepProps {}
property className
className?: string;
property description
description?: React.ReactNode;
property disabled
disabled?: boolean;
property icon
icon?: React.ReactNode;
property onClick
onClick?: React.MouseEventHandler<HTMLElement>;
property status
status?: 'wait' | 'process' | 'finish' | 'error';
property style
style?: React.CSSProperties;
property subTitle
subTitle?: React.ReactNode;
property title
title?: React.ReactNode;
interface StepsProps
interface StepsProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property current
current?: number;
property direction
direction?: 'horizontal' | 'vertical';
property iconPrefix
iconPrefix?: string;
property initial
initial?: number;
property items
items?: StepProps[];
property labelPlacement
labelPlacement?: 'horizontal' | 'vertical';
property onChange
onChange?: (current: number) => void;
property percent
percent?: number;
property prefixCls
prefixCls?: string;
property progressDot
progressDot?: boolean | ProgressDotRender;
property responsive
responsive?: boolean;
property rootClassName
rootClassName?: string;
property size
size?: 'default' | 'small';
property status
status?: 'wait' | 'process' | 'finish' | 'error';
property style
style?: React.CSSProperties;
property type
type?: 'default' | 'navigation' | 'inline';
interface SubMenuProps
interface SubMenuProps extends Omit<SubMenuType, 'ref' | 'key' | 'children' | 'label'> {}
interface SwitchProps
interface SwitchProps {}
property autoFocus
autoFocus?: boolean;
property checked
checked?: boolean;
property checkedChildren
checkedChildren?: React.ReactNode;
property className
className?: string;
property defaultChecked
defaultChecked?: boolean;
property defaultValue
defaultValue?: boolean;
Alias for
defaultChecked
. 5.12.0
property disabled
disabled?: boolean;
property id
id?: string;
property loading
loading?: boolean;
property onChange
onChange?: SwitchChangeEventHandler;
property onClick
onClick?: SwitchClickEventHandler;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property size
size?: SwitchSize;
property style
style?: React.CSSProperties;
property tabIndex
tabIndex?: number;
property title
title?: string;
property unCheckedChildren
unCheckedChildren?: React.ReactNode;
property value
value?: boolean;
Alias for
checked
. 5.12.0
interface TableColumnGroupType
interface ColumnGroupType<RecordType = AnyObject> extends Omit<ColumnType<RecordType>, 'dataIndex'> {}
property children
children: ColumnsType<RecordType>;
interface TableColumnProps
interface ColumnProps<RecordType = AnyObject> extends ColumnType<RecordType> {}
property children
children?: null;
interface TableColumnType
interface ColumnType<RecordType = AnyObject> extends Omit<RcColumnType<RecordType>, 'title'> {}
property defaultFilteredValue
defaultFilteredValue?: FilterValue | null;
property defaultSortOrder
defaultSortOrder?: SortOrder;
property filterDropdown
filterDropdown?: | React.ReactNode | ((props: FilterDropdownProps) => React.ReactNode);
property filterDropdownOpen
filterDropdownOpen?: boolean;
Deprecated
Please use
filterDropdownProps.open
instead. 4.23.0
property filterDropdownProps
filterDropdownProps?: CoverableDropdownProps;
Can cover
<Dropdown>
props 5.22.0
property filterDropdownVisible
filterDropdownVisible?: boolean;
Deprecated
Please use
filterDropdownProps.open
instead.
property filtered
filtered?: boolean;
property filteredValue
filteredValue?: FilterValue | null;
property filterIcon
filterIcon?: React.ReactNode | ((filtered: boolean) => React.ReactNode);
property filterMode
filterMode?: 'menu' | 'tree';
property filterMultiple
filterMultiple?: boolean;
property filterOnClose
filterOnClose?: boolean;
property filterResetToDefaultFilteredValue
filterResetToDefaultFilteredValue?: boolean;
property filters
filters?: ColumnFilterItem[];
property filterSearch
filterSearch?: FilterSearchType<ColumnFilterItem>;
property onFilter
onFilter?: (value: React.Key | boolean, record: RecordType) => boolean;
property onFilterDropdownOpenChange
onFilterDropdownOpenChange?: (visible: boolean) => void;
Deprecated
Please use
filterDropdownProps.onOpenChange
instead. 4.23.0
property onFilterDropdownVisibleChange
onFilterDropdownVisibleChange?: (visible: boolean) => void;
Deprecated
Please use
filterDropdownProps.onOpenChange
instead
property responsive
responsive?: Breakpoint[];
property showSorterTooltip
showSorterTooltip?: boolean | SorterTooltipProps;
property sortDirections
sortDirections?: SortOrder[];
property sorter
sorter?: | boolean | CompareFn<RecordType> | { compare?: CompareFn<RecordType>; /** Config multiple sorter order priority */ multiple?: number; };
property sortIcon
sortIcon?: (props: { sortOrder: SortOrder }) => React.ReactNode;
property sortOrder
sortOrder?: SortOrder;
property title
title?: ColumnTitle<RecordType>;
interface TablePaginationConfig
interface TablePaginationConfig extends PaginationProps {}
property position
position?: TablePaginationPosition[];
interface TableProps
interface TableProps<RecordType = AnyObject> extends Omit< RcTableProps<RecordType>, | 'transformColumns' | 'internalHooks' | 'internalRefs' | 'data' | 'columns' | 'scroll' | 'emptyText' > {}
property bordered
bordered?: boolean;
property columns
columns?: ColumnsType<RecordType>;
property dataSource
dataSource?: RcTableProps<RecordType>['data'];
property dropdownPrefixCls
dropdownPrefixCls?: string;
property getPopupContainer
getPopupContainer?: GetPopupContainer;
property loading
loading?: boolean | SpinProps;
property locale
locale?: TableLocale;
property onChange
onChange?: ( pagination: TablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult<RecordType> | SorterResult<RecordType>[], extra: TableCurrentDataSource<RecordType>) => void;
property pagination
pagination?: false | TablePaginationConfig;
property rootClassName
rootClassName?: string;
property rowSelection
rowSelection?: TableRowSelection<RecordType>;
property scroll
scroll?: RcTableProps<RecordType>['scroll'] & { scrollToFirstRowOnChange?: boolean;};
property showSorterTooltip
showSorterTooltip?: boolean | SorterTooltipProps;
property size
size?: SizeType;
property sortDirections
sortDirections?: SortOrder[];
property virtual
virtual?: boolean;
interface TabsProps
interface TabsProps extends Omit<RcTabsProps, 'editable'> {}
property addIcon
addIcon?: React.ReactNode;
property centered
centered?: boolean;
property children
children?: React.ReactNode;
property hideAdd
hideAdd?: boolean;
property indicatorSize
indicatorSize?: GetIndicatorSize;
Deprecated
Please use
indicator={{ size: ... }}
instead
property more
more?: MoreProps;
property moreIcon
moreIcon?: React.ReactNode;
property onEdit
onEdit?: ( e: React.MouseEvent | React.KeyboardEvent | string, action: 'add' | 'remove') => void;
property removeIcon
removeIcon?: React.ReactNode;
property rootClassName
rootClassName?: string;
property size
size?: SizeType;
property type
type?: TabsType;
interface TagProps
interface TagProps extends React.HTMLAttributes<HTMLSpanElement> {}
property bordered
bordered?: boolean;
property className
className?: string;
property closable
closable?: ClosableType;
Advised to use closeIcon instead.
property closeIcon
closeIcon?: React.ReactNode;
property color
color?: LiteralUnion<PresetColorType | PresetStatusColorType>;
property icon
icon?: React.ReactNode;
property onClose
onClose?: (e: React.MouseEvent<HTMLElement>) => void;
property prefixCls
prefixCls?: string;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
property visible
visible?: boolean;
Deprecated
visible
will be removed in next major version.
interface ThemeConfig
interface ThemeConfig {}
property algorithm
algorithm?: MappingAlgorithm | MappingAlgorithm[];
用于修改 Seed Token 到 Map Token 的算法。 Modify the algorithms of theme. defaultAlgorithm
property components
components?: ComponentsConfig;
用于修改各个组件的 Component Token 以及覆盖该组件消费的 Alias Token。 Modify Component Token and Alias Token applied to components.
property cssVar
cssVar?: | { /** * @descCN css 变量的前缀 * @descEN Prefix for css variable. * @default ant */ prefix?: string; /** * @descCN 主题的唯一 key,版本低于 react@18 时需要手动设置。 * @descEN Unique key for theme, should be set manually < react@18. */ key?: string; } | boolean;
通过
cssVar
配置来开启 CSS 变量模式,这个配置会被继承。 Enable CSS variable mode throughcssVar
configuration, This configuration will be inherited. false 5.12.0
property hashed
hashed?: boolean;
是否开启
hashed
属性。如果你的应用中只存在一个版本的 antd,你可以设置为false
来进一步减小样式体积。 Whether to enable thehashed
attribute. If there is only one version of antd in your application, you can setfalse
to reduce the bundle size. true 5.0.0
property inherit
inherit?: boolean;
是否继承外层
ConfigProvider
中配置的主题。 Whether to inherit the theme configured in the outer layerConfigProvider
. true
property token
token?: Partial<AliasToken>;
用于修改 Design Token。 Modify Design Token.
interface TimelineItemProps
interface TimelineItemProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property color
color?: LiteralUnion<Color>;
property dot
dot?: React.ReactNode;
property key
key?: React.Key;
property label
label?: React.ReactNode;
property pending
pending?: boolean;
property position
position?: string;
property prefixCls
prefixCls?: string;
property style
style?: React.CSSProperties;
interface TimelineProps
interface TimelineProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property items
items?: TimelineItemProps[];
property mode
mode?: 'left' | 'alternate' | 'right';
property pending
pending?: React.ReactNode;
指定最后一个幽灵节点是否存在或内容
property pendingDot
pendingDot?: React.ReactNode;
property prefixCls
prefixCls?: string;
property reverse
reverse?: boolean;
property rootClassName
rootClassName?: string;
property style
style?: React.CSSProperties;
interface TimePickerProps
interface TimePickerProps extends Omit<PickerTimeProps<Dayjs>, 'picker'> {}
property addon
addon?: () => React.ReactNode;
property popupClassName
popupClassName?: string;
property rootClassName
rootClassName?: string;
property status
status?: InputStatus;
interface TimeRangePickerProps
interface TimeRangePickerProps extends Omit<RangePickerTimeProps<Dayjs>, 'picker'> {}
property popupClassName
popupClassName?: string;
interface TourProps
interface TourProps extends Omit<RCTourProps, 'renderPanel'> {}
property current
current?: number;
property indicatorsRender
indicatorsRender?: (current: number, total: number) => ReactNode;
property prefixCls
prefixCls?: string;
property steps
steps?: TourStepProps[];
property type
type?: 'default' | 'primary';
interface TourStepProps
interface TourStepProps extends RCTourStepProps {}
property cover
cover?: ReactNode;
property indicatorsRender
indicatorsRender?: (current: number, total: number) => ReactNode;
property nextButtonProps
nextButtonProps?: { children?: ReactNode; onClick?: () => void; className?: string; style?: React.CSSProperties;};
property prevButtonProps
prevButtonProps?: { children?: ReactNode; onClick?: () => void; className?: string; style?: React.CSSProperties;};
property type
type?: 'default' | 'primary';
interface TransferProps
interface TransferProps<RecordType = any> {}
property children
children?: (props: TransferCustomListBodyProps<RecordType>) => React.ReactNode;
property className
className?: string;
property dataSource
dataSource?: RecordType[];
property disabled
disabled?: boolean;
property filterOption
filterOption?: ( inputValue: string, item: RecordType, direction: TransferDirection) => boolean;
property footer
footer?: ( props: TransferListProps<RecordType>, info?: { direction: TransferDirection; }) => React.ReactNode;
property listStyle
listStyle?: ((style: ListStyle) => CSSProperties) | CSSProperties;
property locale
locale?: Partial<TransferLocale>;
property onChange
onChange?: ( targetKeys: TransferKey[], direction: TransferDirection, moveKeys: TransferKey[]) => void;
property oneWay
oneWay?: boolean;
property onScroll
onScroll?: ( direction: TransferDirection, e: React.SyntheticEvent<HTMLUListElement>) => void;
property onSearch
onSearch?: (direction: TransferDirection, value: string) => void;
property onSelectChange
onSelectChange?: ( sourceSelectedKeys: TransferKey[], targetSelectedKeys: TransferKey[]) => void;
property operations
operations?: string[];
property operationStyle
operationStyle?: CSSProperties;
property pagination
pagination?: PaginationType;
property prefixCls
prefixCls?: string;
property render
render?: TransferRender<RecordType>;
property rootClassName
rootClassName?: string;
property rowKey
rowKey?: (record: RecordType) => TransferKey;
property selectAllLabels
selectAllLabels?: SelectAllLabel[];
property selectedKeys
selectedKeys?: TransferKey[];
property selectionsIcon
selectionsIcon?: React.ReactNode;
property showSearch
showSearch?: boolean | TransferSearchOption;
property showSelectAll
showSelectAll?: boolean;
property status
status?: InputStatus;
property style
style?: React.CSSProperties;
property targetKeys
targetKeys?: TransferKey[];
property titles
titles?: React.ReactNode[];
interface TreeNodeProps
interface AntTreeNodeProps {}
property checkable
checkable?: boolean;
property checked
checked?: boolean;
property children
children?: React.ReactNode;
property className
className?: string;
property disableCheckbox
disableCheckbox?: boolean;
property disabled
disabled?: boolean;
property eventKey
eventKey?: Key;
property expanded
expanded?: boolean;
property icon
icon?: TreeIcon;
property isLeaf
isLeaf?: boolean;
property key
key?: Key;
property loading
loading?: boolean;
property selectable
selectable?: boolean;
property selected
selected?: boolean;
property title
title?: React.ReactNode | ((data: DataNode) => React.ReactNode);
index signature
[customProp: string]: any;
interface TreeProps
interface TreeProps<T extends BasicDataNode = DataNode> extends Omit< RcTreeProps<T>, | 'prefixCls' | 'showLine' | 'direction' | 'draggable' | 'icon' | 'switcherIcon' > {}
property autoExpandParent
autoExpandParent?: boolean;
Whether to automatically expand the parent node
property blockNode
blockNode?: boolean;
property checkable
checkable?: boolean;
Whether to support selection
property checkedKeys
checkedKeys?: | Key[] | { checked: Key[]; halfChecked: Key[]; };
(Controlled) Tree node with checked checkbox
property checkStrictly
checkStrictly?: boolean;
Node selection in Checkable state is fully controlled (the selected state of parent and child nodes is no longer associated)
property children
children?: React.ReactNode;
property className
className?: string;
property defaultCheckedKeys
defaultCheckedKeys?: Key[];
Tree node with checkbox checked by default
property defaultExpandAll
defaultExpandAll?: boolean;
Expand all tree nodes by default
property defaultExpandedKeys
defaultExpandedKeys?: Key[];
Expand the specified tree node by default
property defaultExpandParent
defaultExpandParent?: boolean;
Expand the corresponding tree node by default
property defaultSelectedKeys
defaultSelectedKeys?: Key[];
Tree node selected by default
property disabled
disabled?: boolean;
whether to disable the tree
property draggable
draggable?: DraggableFn | boolean | DraggableConfig;
Set the node to be draggable (IE>8)
property expandedKeys
expandedKeys?: Key[];
(Controlled) Expand the specified tree node
property filterAntTreeNode
filterAntTreeNode?: (node: AntTreeNode) => boolean;
Click on the tree node to trigger
property icon
icon?: TreeIcon;
property loadedKeys
loadedKeys?: Key[];
property multiple
multiple?: boolean;
Whether to support multiple selection
property prefixCls
prefixCls?: string;
property selectable
selectable?: boolean;
property selectedKeys
selectedKeys?: Key[];
(Controlled) Set the selected tree node
property showIcon
showIcon?: boolean;
property showLine
showLine?: | boolean | { showLeafIcon: boolean | TreeLeafIcon; };
property style
style?: React.CSSProperties;
property switcherIcon
switcherIcon?: SwitcherIcon;
property switcherLoadingIcon
switcherLoadingIcon?: React.ReactNode;
interface TreeSelectProps
interface TreeSelectProps<ValueType = any, OptionType extends DataNode = DataNode> extends React.AriaAttributes, Omit< RcTreeSelectProps<ValueType, OptionType>, | 'showTreeIcon' | 'treeMotion' | 'mode' | 'getInputElement' | 'backfill' | 'treeLine' | 'switcherIcon' > {}
property bordered
bordered?: boolean;
Deprecated
Use
variant
instead.
property disabled
disabled?: boolean;
property dropdownClassName
dropdownClassName?: string;
Deprecated
Please use
popupClassName
instead
property dropdownMatchSelectWidth
dropdownMatchSelectWidth?: boolean | number;
Deprecated
Please use
popupMatchSelectWidth
instead
property placement
placement?: SelectCommonPlacement;
property popupClassName
popupClassName?: string;
property popupMatchSelectWidth
popupMatchSelectWidth?: boolean | number;
property rootClassName
rootClassName?: string;
property showArrow
showArrow?: boolean;
Deprecated
showArrow
is deprecated which will be removed in next major version. It will be a default behavior, you can hide it by settingsuffixIcon
to null.
property size
size?: SizeType;
property status
status?: InputStatus;
property suffixIcon
suffixIcon?: React.ReactNode;
property switcherIcon
switcherIcon?: | SwitcherIcon | RcTreeSelectProps<ValueType, OptionType>['switcherIcon'];
property treeLine
treeLine?: TreeProps['showLine'];
property variant
variant?: Variant;
5.13.0 "outlined"
interface UploadFile
interface UploadFile<T = any> extends ProgressAriaProps {}
property crossOrigin
crossOrigin?: React.ImgHTMLAttributes<HTMLImageElement>['crossOrigin'];
property error
error?: any;
property fileName
fileName?: string;
property lastModified
lastModified?: number;
property lastModifiedDate
lastModifiedDate?: Date;
property linkProps
linkProps?: any;
property name
name: string;
property originFileObj
originFileObj?: RcFile;
property percent
percent?: number;
property preview
preview?: string;
property response
response?: T;
property size
size?: number;
property status
status?: UploadFileStatus;
property thumbUrl
thumbUrl?: string;
property type
type?: string;
property uid
uid: string;
property url
url?: string;
property xhr
xhr?: T;
interface UploadProps
interface UploadProps<T = any> extends Pick<RcUploadProps, 'capture' | 'hasControlInside'> {}
property accept
accept?: string;
property action
action?: | string | ((file: RcFile) => string) | ((file: RcFile) => PromiseLike<string>);
property beforeUpload
beforeUpload?: ( file: RcFile, fileList: RcFile[]) => BeforeUploadValueType | Promise<BeforeUploadValueType>;
property children
children?: React.ReactNode;
property className
className?: string;
property customRequest
customRequest?: (options: RcCustomRequestOptions<T>) => void;
property data
data?: | Record<string, unknown> | (( file: UploadFile<T> ) => Record<string, unknown> | Promise<Record<string, unknown>>);
property defaultFileList
defaultFileList?: Array<UploadFile<T>>;
property directory
directory?: boolean;
property disabled
disabled?: boolean;
property fileList
fileList?: Array<UploadFile<T>>;
property headers
headers?: HttpRequestHeader;
property iconRender
iconRender?: (file: UploadFile<T>, listType?: UploadListType) => React.ReactNode;
property id
id?: string;
property isImageUrl
isImageUrl?: (file: UploadFile<T>) => boolean;
property itemRender
itemRender?: ItemRender<T>;
property listType
listType?: UploadListType;
property locale
locale?: UploadLocale;
property maxCount
maxCount?: number;
Config max count of
fileList
. Will replace current one whenmaxCount
is 1
property method
method?: 'POST' | 'PUT' | 'PATCH' | 'post' | 'put' | 'patch';
property multiple
multiple?: boolean;
property name
name?: string;
property onChange
onChange?: (info: UploadChangeParam<UploadFile<T>>) => void;
property onDownload
onDownload?: (file: UploadFile<T>) => void;
property onDrop
onDrop?: (event: React.DragEvent<HTMLDivElement>) => void;
property onPreview
onPreview?: (file: UploadFile<T>) => void;
property onRemove
onRemove?: (file: UploadFile<T>) => void | boolean | Promise<void | boolean>;
property openFileDialogOnClick
openFileDialogOnClick?: boolean;
property prefixCls
prefixCls?: string;
property previewFile
previewFile?: PreviewFileHandler;
property progress
progress?: UploadListProgressProps;
property rootClassName
rootClassName?: string;
property showUploadList
showUploadList?: boolean | ShowUploadListInterface;
property style
style?: React.CSSProperties;
property supportServerRender
supportServerRender?: boolean;
property transformFile
transformFile?: TransformFileHandler;
Deprecated
Please use
beforeUpload
directly
property type
type?: UploadType;
property withCredentials
withCredentials?: boolean;
interface WatermarkProps
interface WatermarkProps {}
property children
children?: React.ReactNode;
property className
className?: string;
property content
content?: string | string[];
property font
font?: { color?: CanvasFillStrokeStyles['fillStyle']; fontSize?: number | string; fontWeight?: 'normal' | 'light' | 'weight' | number; fontStyle?: 'none' | 'normal' | 'italic' | 'oblique'; fontFamily?: string; textAlign?: CanvasTextAlign;};
property gap
gap?: [number, number];
property height
height?: number;
property image
image?: string;
property inherit
inherit?: boolean;
property offset
offset?: [number, number];
property rootClassName
rootClassName?: string;
property rotate
rotate?: number;
property style
style?: React.CSSProperties;
property width
width?: number;
property zIndex
zIndex?: number;
Type Aliases
type Breakpoint
type Breakpoint = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
type CalendarMode
type CalendarMode = 'year' | 'month';
type CascaderAutoProps
type CascaderAutoProps< OptionType extends DefaultOptionType = DefaultOptionType, ValueField extends keyof OptionType = keyof OptionType> = | (CascaderProps<OptionType, ValueField> & { multiple?: false; }) | (CascaderProps<OptionType, ValueField, true> & { multiple: true; });
type CascaderPanelAutoProps
type CascaderPanelAutoProps< OptionType extends DefaultOptionType = DefaultOptionType, ValueField extends keyof OptionType = keyof OptionType> = | (CascaderPanelProps<OptionType, ValueField> & { multiple?: false; }) | (CascaderPanelProps<OptionType, ValueField, true> & { multiple: true; });
type CascaderPanelProps
type CascaderPanelProps< OptionType extends DefaultOptionType = DefaultOptionType, ValueField extends keyof OptionType = keyof OptionType, Multiple extends boolean = boolean> = Pick<CascaderProps<OptionType, ValueField, Multiple>, PanelPickType>;
type ColorPickerProps
type ColorPickerProps = Omit< RcColorPickerProps, | 'onChange' | 'value' | 'defaultValue' | 'panelRender' | 'disabledAlpha' | 'onChangeComplete' | 'components'> & { mode?: ModeType | ModeType[]; value?: ColorValueType; defaultValue?: ColorValueType; children?: React.ReactNode; open?: boolean; disabled?: boolean; placement?: TriggerPlacement; trigger?: TriggerType; format?: ColorFormatType; defaultFormat?: ColorFormatType; allowClear?: boolean; presets?: PresetsItem[]; arrow?: | boolean | { pointAtCenter: boolean; }; panelRender?: ( panel: React.ReactNode, extra: { components: { Picker: FC; Presets: FC; }; } ) => React.ReactNode; showText?: boolean | ((color: AggregationColor) => React.ReactNode); size?: SizeType; styles?: { popup?: CSSProperties; popupOverlayInner?: CSSProperties; }; rootClassName?: string; disabledAlpha?: boolean; [key: `data-${string}`]: string; onOpenChange?: (open: boolean) => void; onFormatChange?: (format?: ColorFormatType) => void; onChange?: (value: AggregationColor, css: string) => void; onClear?: () => void; onChangeComplete?: (value: AggregationColor) => void; disabledFormat?: boolean;} & Pick< PopoverProps, 'getPopupContainer' | 'autoAdjustOverflow' | 'destroyTooltipOnHide' >;
type DatePickerProps
type DatePickerProps<ValueType = Dayjs | Dayjs> = PickerPropsWithMultiple< Dayjs, PickerProps<Dayjs>, ValueType>;
type DraggerProps
type DraggerProps = UploadProps & { height?: number;};
type GetProp
type GetProp< T extends React.ComponentType<any> | object, PropName extends keyof GetProps<T>> = NonNullable<GetProps<T>[PropName]>;
Get component props by component name
Example 1
import { Select } from 'antd';import type { GetProp, SelectProps } from 'antd';type SelectOption1 = GetProp<SelectProps, 'options'>[number];// ortype SelectOption2 = GetProp<typeof Select, 'options'>[number];const onChange: GetProp<typeof Select, 'onChange'> = (value, option) => {// Do something};5.13.0
type GetProps
type GetProps<T extends React.ComponentType<any> | object> = T extends React.ComponentType<infer P> ? P : T extends object ? T : never;
Get component props
Example 1
import { Checkbox } from 'antd'import type { GetProps } from 'antd';type CheckboxGroupProps = GetProps<typeof Checkbox.Group>5.13.0
type GetRef
type GetRef<T extends ReactRefComponent<any> | React.Component<any>> = T extends React.Component<any> ? T : T extends React.ComponentType<infer P> ? ExtractRefAttributesRef<P> : never;
Get component ref
Example 1
import { Input } from 'antd';import type { GetRef } from 'antd';type InputRef = GetRef<typeof Input>;5.13.0
type GlobalToken
type GlobalToken = GlobalTokenTypeUtil<ComponentTokenMap, AliasToken>;
Final token which contains the components level override
type MappingAlgorithm
type MappingAlgorithm = DerivativeFunc<SeedToken, MapToken>;
type MenuRef
type MenuRef = { menu: RcMenuRef | null; focus: (options?: FocusOptions) => void;};
type MenuTheme
type MenuTheme = 'light' | 'dark';
type QRPropsCanvas
type QRPropsCanvas = QRProps & React.CanvasHTMLAttributes<HTMLCanvasElement>;
type QRPropsSvg
type QRPropsSvg = QRProps & React.SVGAttributes<SVGSVGElement>;
type StatisticProps
type StatisticProps = HTMLAriaDataAttributes & StatisticReactProps;
type TableColumnsType
type ColumnsType<RecordType = AnyObject> = ( | ColumnGroupType<RecordType> | ColumnType<RecordType>)[];
type TagType
type TagType = typeof InternalTag & { CheckableTag: typeof CheckableTag;};
type TooltipProps
type TooltipProps = TooltipPropsWithTitle | TooltipPropsWithOverlay;
type TypographyProps
type TypographyProps = typeof OriginTypography & { Text: typeof Text; Link: typeof Link; Title: typeof Title; Paragraph: typeof Paragraph;};
Package Files (124)
- es/_util/responsiveObserver.d.ts
- es/_util/type.d.ts
- es/affix/index.d.ts
- es/alert/Alert.d.ts
- es/alert/index.d.ts
- es/anchor/Anchor.d.ts
- es/anchor/AnchorLink.d.ts
- es/anchor/index.d.ts
- es/app/App.d.ts
- es/app/index.d.ts
- es/auto-complete/AutoComplete.d.ts
- es/auto-complete/index.d.ts
- es/avatar/Avatar.d.ts
- es/avatar/index.d.ts
- es/back-top/index.d.ts
- es/badge/index.d.ts
- es/breadcrumb/Breadcrumb.d.ts
- es/breadcrumb/BreadcrumbItem.d.ts
- es/button/button.d.ts
- es/calendar/generateCalendar.d.ts
- es/calendar/index.d.ts
- es/card/Card.d.ts
- es/card/index.d.ts
- es/carousel/index.d.ts
- es/cascader/Panel.d.ts
- es/cascader/index.d.ts
- es/checkbox/Checkbox.d.ts
- es/checkbox/Group.d.ts
- es/checkbox/index.d.ts
- es/collapse/Collapse.d.ts
- es/collapse/CollapsePanel.d.ts
- es/color-picker/ColorPicker.d.ts
- es/color-picker/interface.d.ts
- es/config-provider/UnstableContext.d.ts
- es/config-provider/context.d.ts
- es/config-provider/index.d.ts
- es/date-picker/index.d.ts
- es/descriptions/index.d.ts
- es/divider/index.d.ts
- es/drawer/index.d.ts
- es/dropdown/dropdown.d.ts
- es/dropdown/index.d.ts
- es/empty/index.d.ts
- es/flex/index.d.ts
- es/flex/interface.d.ts
- es/float-button/FloatButton.d.ts
- es/float-button/interface.d.ts
- es/form/Form.d.ts
- es/form/FormItem/index.d.ts
- es/form/FormList.d.ts
- es/form/hooks/useForm.d.ts
- es/form/index.d.ts
- es/grid/col.d.ts
- es/grid/index.d.ts
- es/grid/row.d.ts
- es/image/index.d.ts
- es/index.d.ts
- es/input-number/index.d.ts
- es/input/Input.d.ts
- es/input/index.d.ts
- es/layout/Sider.d.ts
- es/layout/index.d.ts
- es/layout/layout.d.ts
- es/list/index.d.ts
- es/mentions/index.d.ts
- es/menu/MenuContext.d.ts
- es/menu/MenuItem.d.ts
- es/menu/SubMenu.d.ts
- es/menu/index.d.ts
- es/menu/menu.d.ts
- es/message/index.d.ts
- es/message/interface.d.ts
- es/modal/index.d.ts
- es/modal/interface.d.ts
- es/notification/index.d.ts
- es/notification/interface.d.ts
- es/pagination/Pagination.d.ts
- es/popconfirm/index.d.ts
- es/popover/index.d.ts
- es/progress/progress.d.ts
- es/qr-code/index.d.ts
- es/qr-code/interface.d.ts
- es/radio/index.d.ts
- es/radio/interface.d.ts
- es/rate/index.d.ts
- es/result/index.d.ts
- es/segmented/index.d.ts
- es/select/index.d.ts
- es/skeleton/Skeleton.d.ts
- es/slider/index.d.ts
- es/space/index.d.ts
- es/spin/index.d.ts
- es/splitter/index.d.ts
- es/splitter/interface.d.ts
- es/statistic/Countdown.d.ts
- es/statistic/Statistic.d.ts
- es/statistic/index.d.ts
- es/steps/index.d.ts
- es/switch/index.d.ts
- es/table/Column.d.ts
- es/table/InternalTable.d.ts
- es/table/Table.d.ts
- es/table/interface.d.ts
- es/tabs/index.d.ts
- es/tag/index.d.ts
- es/theme/index.d.ts
- es/theme/interface/cssinjs-utils.d.ts
- es/theme/interface/index.d.ts
- es/time-picker/index.d.ts
- es/timeline/Timeline.d.ts
- es/timeline/TimelineItem.d.ts
- es/tooltip/index.d.ts
- es/tour/index.d.ts
- es/tour/interface.d.ts
- es/transfer/index.d.ts
- es/tree-select/index.d.ts
- es/tree/Tree.d.ts
- es/tree/index.d.ts
- es/typography/index.d.ts
- es/upload/Dragger.d.ts
- es/upload/index.d.ts
- es/upload/interface.d.ts
- es/version/version.d.ts
- es/watermark/index.d.ts
Dependencies (49)
- @ant-design/colors
- @ant-design/cssinjs
- @ant-design/cssinjs-utils
- @ant-design/fast-color
- @ant-design/icons
- @ant-design/react-slick
- @babel/runtime
- @rc-component/color-picker
- @rc-component/mutate-observer
- @rc-component/qrcode
- @rc-component/tour
- @rc-component/trigger
- classnames
- copy-to-clipboard
- dayjs
- rc-cascader
- rc-checkbox
- rc-collapse
- rc-dialog
- rc-drawer
- rc-dropdown
- rc-field-form
- rc-image
- rc-input
- rc-input-number
- rc-mentions
- rc-menu
- rc-motion
- rc-notification
- rc-pagination
- rc-picker
- rc-progress
- rc-rate
- rc-resize-observer
- rc-segmented
- rc-select
- rc-slider
- rc-steps
- rc-switch
- rc-table
- rc-tabs
- rc-textarea
- rc-tooltip
- rc-tree
- rc-tree-select
- rc-upload
- rc-util
- scroll-into-view-if-needed
- throttle-debounce
Dev Dependencies (174)
- @ant-design/compatible
- @ant-design/happy-work-theme
- @ant-design/tools
- @ant-design/v5-patch-for-react-19
- @antfu/eslint-config
- @antv/g6
- @biomejs/biome
- @codecov/webpack-plugin
- @codesandbox/sandpack-react
- @dnd-kit/core
- @dnd-kit/modifiers
- @dnd-kit/sortable
- @dnd-kit/utilities
- @emotion/css
- @emotion/react
- @emotion/server
- @eslint-react/eslint-plugin
- @ianvs/prettier-plugin-sort-imports
- @inquirer/prompts
- @madccc/duplicate-package-checker-webpack-plugin
- @microflash/rehype-figure
- @npmcli/run-script
- @octokit/rest
- @prettier/sync
- @qixian.cs/github-contributors-list
- @size-limit/file
- @stackblitz/sdk
- @testing-library/dom
- @testing-library/jest-dom
- @testing-library/react
- @testing-library/user-event
- @types/adm-zip
- @types/ali-oss
- @types/cli-progress
- @types/css-tree
- @types/fs-extra
- @types/gtag.js
- @types/http-server
- @types/isomorphic-fetch
- @types/jest
- @types/jest-axe
- @types/jest-environment-puppeteer
- @types/jest-image-snapshot
- @types/jquery
- @types/jsdom
- @types/lodash
- @types/minimist
- @types/node
- @types/nprogress
- @types/pixelmatch
- @types/pngjs
- @types/prismjs
- @types/progress
- @types/react
- @types/react-copy-to-clipboard
- @types/react-dom
- @types/react-highlight-words
- @types/react-resizable
- @types/semver
- @types/spinnies
- @types/tar
- @types/throttle-debounce
- @types/warning
- adm-zip
- ali-oss
- antd-img-crop
- antd-style
- antd-token-previewer
- axios
- chalk
- cheerio
- circular-dependency-plugin
- cli-progress
- cross-env
- cross-fetch
- css-tree
- csstree-validator
- cypress-image-diff-html-report
- dekko
- dotenv
- dumi
- dumi-plugin-color-chunk
- env-paths
- eslint
- eslint-plugin-compat
- eslint-plugin-jest
- eslint-plugin-jsx-a11y
- eslint-plugin-react-hooks
- eslint-plugin-react-refresh
- fast-glob
- fs-extra
- gh-pages
- github-slugger
- glob
- html2sketch
- http-server
- husky
- identity-obj-proxy
- immer
- is-ci
- isomorphic-fetch
- jest
- jest-axe
- jest-canvas-mock
- jest-environment-jsdom
- jest-environment-node
- jest-image-snapshot
- jest-puppeteer
- jquery
- jsdom
- jsonml-to-react-element
- jsonml.js
- lint-staged
- lodash
- lunar-typescript
- lz-string
- minimist
- mockdate
- node-fetch
- node-notifier
- open
- ora
- p-all
- package-manager-detector
- pixelmatch
- pngjs
- prettier
- pretty-format
- prismjs
- puppeteer
- rc-footer
- rc-tween-one
- rc-virtual-list
- react
- react-copy-to-clipboard
- react-countup
- react-dom
- react-draggable
- react-fast-marquee
- react-highlight-words
- react-icons
- react-infinite-scroll-component
- react-intersection-observer
- react-resizable
- react-router-dom
- react-scan
- react-sticky-box
- regenerator-runtime
- rehype-stringify
- remark
- remark-cli
- remark-gfm
- remark-lint
- remark-lint-no-undefined-references
- remark-preset-lint-recommended
- remark-rehype
- rimraf
- runes2
- semver
- sharp
- simple-git
- size-limit
- spinnies
- tar
- tar-fs
- terser
- tsx
- typedoc
- typescript
- vanilla-jsoneditor
- vanilla-tilt
- webpack
- webpack-bundle-analyzer
- xhr-mock
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/antd
.
- Markdown[](https://www.jsdocs.io/package/antd)
- HTML<a href="https://www.jsdocs.io/package/antd"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 21348 ms. - Missing or incorrect documentation? Open an issue for this package.