- Ant Design of React
- v5.22.4Changelog
- Basic Usage
- Advanced
- Migration
- Other
FAQ
Here are the frequently asked questions about Ant Design and antd that you should look up before you ask in the community or create a new issue. We also maintain a FAQ issues label for common GitHub issues.
undefined
and null
in the controlled components of antd
?Yes. antd will treat undefined
as uncontrolled but null
as controlled component which means empty value of it.
As input element, React treats both undefined
and null
as uncontrolled. When the value
is converted from a valid value to undefined
or null
, the component is no longer controlled, which causes some unexpected cases.
But in antd, undefined
is treated as uncontrolled, and null
is used as an explicit empty value of controlled components. To deal with some cases (e.g. allowClear
) like clearing the value
when the value
is non-primitive. If you need a component controlled with the value
valid, just set the value
as null
.
Note: For options
in Select-like
components, it is strongly recommended not to use undefined
and null
as value
in option
. Please use string | number
as a valid value
in option
.
NOT RECOMMENDED. Internal API is not guaranteed to be compatible with future versions. It may be removed or changed in some versions. If you really need to use it, you should make sure these APIs are still valid when upgrading to a new version or just lock version for usage.
We are cautious when adding APIs because some APIs may not be abstract enough to become historical debt. For example, when there is a need to change the way of interaction, these poor abstractions may cause breaking changes. To avoid such problems, we recommend that new features be implemented through HOCs first.
Select Dropdown DatePicker TimePicker Popover Popconfirm
disappears when I click another popup component inside it. How do I resolve this?This is an old bug that has been fixed since v3.11.x
. If you're using an older version, you can use <Select getPopupContainer={trigger => trigger.parentElement}>
to render a component inside Popover. (Or other getXxxxContainer
props)
https://ant.design/components/select/#Select-props
Select Dropdown DatePicker TimePicker Popover Popconfirm
scrolling with the page?Use <Select getPopupContainer={trigger => trigger.parentElement}>
(API reference) to render a component inside the scroll area. If you need to config this globally in your application, try <ConfigProvider getPopupContainer={trigger => trigger.parentElement}>
(API reference)
And make sure that parentElement is position: relative
or position: absolute
.
See: customize-theme.
Menu
/Button
(etc.)'s style?While you can override a component's style, we don't recommend doing so. antd is not only a set of React components, but also a design specification as well.
antd will avoid breaking change in minor & patch version. You can safely do the following things:
And which you should avoid doing:
Please refer to Use custom date library.
defaultValue
dynamically.The defaultXxxx
(e.g. defaultValue
) of Input
/Select
(etc...) only works on the first render. It is a specification of React. Please read React's documentation.
antd use shallow compare of props to optimize performance. You should always pass the new object when updating the state. Please ref React's document
value
of an Input
/Select
(etc.) component, the value cannot be changed by user's action.Try onChange
to change value
, and please read React's documentation.
Try Space component to make them aligned.
Yes, antd is designed to help you develop a complete background application. To do so, we override some global styles for styling convenience, and currently these cannot be removed or changed. More info at https://github.com/ant-design/ant-design/issues/4331 .
Alternatively, follow the instructions in How to avoid modifying global styles?
antd
and antd
's dependencies in mainland China.To potentially solve this, try npm mirror china and cnpm.
dependencies.antd
as the git repository in package.json
, but it doesn't work.Please install antd
with either npm or yarn.
message
and notification
is lower case, but other components are capitalized. Is this a typo?No, message
is just a function, not a React Component, thus it is not a typo that it is in lower case.
antd
doesn't work well in mobile.Please check Ant Design Mobile as a possible solution, as antd
has not been optimized to work well on mobile. You can also try the react-component repositories which start with 'm-' 'rn-', which are also designed for mobile.
antd
supply standalone files like 'React'?Yes, you can import antd
with script tag, but we recommend using npm
to import antd
, as it is simple and easy to maintain.
If you need some features which should not be included in antd, try to extend antd's component with HOC. more
antd will have a strict discussion on the demand for new components to prevent API corruption and become historical debt. And it is also more inclined to provide atomic capabilities for APIs so that developers can customize the features they need more flexibly.
antd expose the basic component definitions. For the unexposed props, you can get them via the utility types provided by antd. For example:
import type { Checkbox, CheckboxProps, GetProp, GetProps, GetRef, Input } from 'antd';// Get Propstype CheckboxGroupProps = GetProps<typeof Checkbox.Group>;// Get Proptype CheckboxValue = GetProp<CheckboxProps, 'value'>;// Get Reftype InputRef = GetRef<typeof Input>;
Please check whether you have imported dayjs locale correctly.
import dayjs from 'dayjs';import 'dayjs/locale/zh-cn';dayjs.locale('zh-cn');
Please check whether there are two versions of dayjs installed.
npm ls dayjs
If you are using a mismatched version of dayjs with antd's dayjs in your project. That would be a problem cause locale not working.
You can configure nonce
by ConfigProvider.
mode
to DatePicker
/RangePicker
, why can I not select a year or month anymore?In a real world development, you may need a YearPicker
, MonthRangePicker
or WeekRangePicker
. You are trying to add mode
to DatePicker
/RangePicker
expected to implement those pickers. However, the DatePicker
/RangePicker
cannot be selected and the panels won't close now.
Like the explanation explains, this is because <DatePicker mode="year" />
does not equal the YearPicker
, nor is <RangePicker mode="month" />
equal to MonthRangePicker
. The mode
property was added to support showing time picker panel in DatePicker in antd 3.0, which simply controls the displayed panel, and won't change the original date picking behavior of DatePicker
/RangePicker
(for instance you will still need to click date cell to finish selection in a DatePicker
, whatever the mode
is).
Likewise, disabledDate
cannot work on year/month panels of <DatePicker mode="year/month" />
, but only on cells of date panel.
:::success{title=Workaround} You can refer to this article or this article, using mode
and onPanelChange
to encapsulate a YearPicker
or MonthRangePicker
for your needs.
Or you can simply upgrade to antd@4.0, in which we added more XxxPickers to meet those requirements, and disabledDate
could be effect on those pickers too. :::
prefixCls
on ConfigProvider?Static methods like message/notification/Modal.confirm are not using the same render tree as <Button />
, but rendered to independent DOM node created by ReactDOM.render
, which cannot access React context from ConfigProvider. Consider two solutions here:
Replace original usages with message.useMessage, notification.useNotification and Modal.useModal.
Use App.useApp to get message/notification/modal instance.
You should only access the API by official doc with ref. Directly access internal props
or state
is not recommended which will make your code strong coupling with current version. Any refactor will break your code like refactor with Hooks version, delete or rename internal props
or state
, adjust internal node constructor, etc.
open
prop?For historical reasons, the display names of the pop components are not uniform, and both open
and visible
are used. This makes the memory cost that non-tsx users encounter when developing. It also leads to ambiguity about what name to choose when adding a feature. So we want to unify the attribute name, you can still use the original visible
and it will still be backward compatible, but we will remove this attribute from the documentation as of v5.
:where
selector which not support old browser.Please ref dynamic theme document Legacy Browser Compatible part.
Same as above. You can adjust antd css priority to override. Related issue: #38794
Please ref document Shadow Dom Usage.
Config with SeedToken:
import { ConfigProvider } from 'antd';<ConfigProvider theme={{ token: { motion: false } }}><App /></ConfigProvider>;
Please ref dynamic theme document SSR part.
In the Ant Design Token system, colorPrimary
and colorInfo
are both Seed Token, so they are independent of each other. colorLink
is an Alias Token, inherits colorInfo
by default, and is independent of colorPrimary
.
Spelt | Usage | Pronunciation |
---|---|---|
✅ Ant Design | Capitalized with space, for the design language | - |
✅ antd | All lowercase, for the React UI library | |
✅ ant.design | For ant.design website url | - |
Here are some typical wrong examples:
https://opencollective.com/ant-design
setFieldsValue
method to report an error if the object type contains null
When we try to set the form value using the setFieldsValue
method in the form instance of the form component, if the passed object contains the type null, such as:
// This is not real world code, just for explainimport { Form } from 'antd';type Test = {value: string[] | null;};export default () => {const [form] = Form.useForm<Test>();form.setFieldsValue({value: null, // Error: Type "null" cannot be assigned to type "string[] | undefined".});};
If you encounter the above error, please check the current project tsconfig.json
contains the following configuration:
{"strictNullChecks": true}
The above problem occurs if strictNullChecks
is set to true
, If you can determine the project don't need this configuration (see strictNullChecks to judge whether need the configuration). You can try changing to false
to turn off the control strict check. However, if you do need to enable this feature, you can avoid this situation by using other types instead of null
when defining types
If you are using the App Router of Next.js, when you use the sub-components provided by some antd components, such as Select.Option
, Form.Item
, Typography.Title
, etc., you may get the following error:
Error: Cannot access .Option on the server. You cannot dot into a client module from a server component. You can only pass the imported name through.
Currently, this problem is waiting for Next.js to give an official solution. There are two workarounds as of now if you need to use sub-components in your page with the App Router:
Typography
component as an example. A wrapper component would look something like this:'use client';import React from 'react';import { Typography as OriginTypography } from 'antd';import type { LinkProps } from 'antd/es/typography/Link';import type { ParagraphProps } from 'antd/es/typography/Paragraph';import type { TextProps } from 'antd/es/typography/Text';import type { TitleProps } from 'antd/es/typography/Title';const Title = React.forwardRef<HTMLElement, TitleProps & React.RefAttributes<HTMLElement>>((props, ref) => <OriginTypography.Title ref={ref} {...props} />,);const Paragraph = React.forwardRef<HTMLElement, ParagraphProps & React.RefAttributes<HTMLElement>>((props, ref) => <OriginTypography.Paragraph ref={ref} {...props} />,);const Link = React.forwardRef<HTMLElement, LinkProps & React.RefAttributes<HTMLElement>>((props, ref) => <OriginTypography.Link ref={ref} {...props} />,);const Text = React.forwardRef<HTMLElement, TextProps & React.RefAttributes<HTMLElement>>((props, ref) => <OriginTypography.Text ref={ref} {...props} />,);export { Title, Link, Text, Paragraph };
use client
tag at the beginning of your page's source:'use client';// This is not real world code, just for explainexport default () => {return (<div className="App"><Form><Form.Item><Button type="primary">Button</Button></Form.Item></Form></div>);};