test/ant-design
1
0
Fork 0
mirror of https://gitee.com/ant-design/ant-design.git synced 2024-11-30 02:59:04 +08:00
Code Issues Actions 68 Packages Projects Releases Wiki Activity
d85d827a4c
ant-design/docs/react/faq.zh-CN.md
二货爱吃白萝卜 e7aa014c31
chore: Add type util (#46923) 
* docs: init

* chore: all types

* docs: faq

* chore: fix lint
2024-01-11 15:55:58 +08:00

19 KiB
Raw Blame History

group order title
title
其他
2 FAQ

以下整理了一些 Ant Design 社区常见的问题和官方答复，在提问之前建议找找有没有类似的问题。此外我们也维护了一个反馈较多 FAQ issues 标签 亦可参考。

undefined 和 null 在 antd 的受控组件中有区别吗？

有区别。antd 约定：undefined 是非受控的标志，null 作为显式的受控空值。

在输入元素中，React 认为 undefined 和 null 都属于非受控的标志。当 value 由非空值转化为 undefined 或 null 时，组件不再受控，这通常是一些意外情况发生的原因。

但在 antd 中，我们定义 undefined 为非受控的标志，而 null 则作为显式的受控空值。为的是处理 value 为复杂数据类型时的清空（如 allowClear）置 value 为空值等场景。如果需要让组件受控且希望将 value 置为空值，请将 value 设置为 null。

注意：对于类 Select 组件的 options，我们强烈不建议使用 undefined 和 null 作为 option 中的 value，请使用 string | number 作为 option 的 value。

官方文档中没有提供的隐藏 API 我可以使用吗？

不推荐。对内接口不保证兼容性，它很可能在某个版本中因重构而移除。如果你确实需要使用，需自行确保版本升级时隐藏接口仍旧可用，或者锁定版本。

为何新增 API 请求需要严格讨论？

我们在添加 API 时十分谨慎，因为一些 API 可能不够抽象从而变成历史债务。例如当需要对交互方式进行更改，这些不良抽象可能会引发 Breaking Change。为了避免诸如此类问题，我们推荐新功能优先通过 HOC 实现。

当我点击 Select Dropdown DatePicker TimePicker Popover Popconfirm 内的另一个 popup 组件时它会消失，如何解决？

该问题在 3.11.0 后已经解决。如果你仍在使用旧版本，你可以通过 <Select getPopupContainer={trigger => trigger.parentElement}> 来在 Popover 中渲染组件，或者使用其他的 getXxxxContainer 参数。

可以参考 Select 属性

相关 issue：#3487 #3438

Select Dropdown DatePicker TimePicker Popover Popconfirm 会跟随滚动条上下移动？

使用 <Select getPopupContainer={trigger => trigger.parentElement}>（API 文档）来将组件渲染到滚动区域内，或者使用其他的 getXxxxContainer 参数。如果需要全局解决这个问题，可以使用 <ConfigProvider getPopupContainer={trigger => trigger.parentElement}>（API 文档）

并且保证 parentElement 是 position: relative 或 position: absolute。

相关 issue：#3487 #3438

如何修改 Ant Design 的默认主题？

可以参考定制主题。

如何修改 Ant Design 组件的默认样式？

你可以覆盖它们的样式，但是我们不推荐这么做。antd 是一系列 React 组件，但同样是一套设计规范。

如何避免升级导致的破坏性变更？

antd 在 minor 和 patch 版本迭代中会避免引入破坏性变更，遵从以下原则会确保不会破坏你的代码：

  • 使用出现在官方 Demo 中的写法
  • FAQ 中出现的解法，包含代码片段以及 codesandbox 示例、issue 中当前版本标记 FAQ label 的

而下述变更则需要开发者自行校验：

  • 特定场景的错误用法，BUG as Feature（例如 Tabs 下直接包 div 的用法）
  • 可以通过正常用法实现功能需求却魔改的

如何使用其他时间日期库如 Moment.js？

可以参考使用自定义日期库。

当我动态改变 defaultValue 的时候它并没有生效。

Input/Select 等的 defaultXxxx（例如 defaultValue）只有在第一次渲染的时候有效，这是 React 的规范，请阅读 React 的文档。

为什么修改组件传入的对象或数组属性组件不会更新？

antd 内部会对 props 进行浅比较实现性能优化。当状态变更，你总是应该传递一个新的对象。具体请参考 React 的文档

当我设置了 Input/Select 等的 value 时它就无法修改了。

尝试使用 onChange 来改变 value，请参考 React 的文档。

多个组件放一排时没有垂直对齐怎么办？

尝试使用 Space 组件来使他们对齐。

antd 覆盖了我的全局样式！

是的，antd 在设计的时候就是用来开发一个完整的应用的，为了方便，我们覆盖了一些全局样式，现在还不能移除，想要了解更多请追踪 这个 issue，或者参考这个教程 How to avoid modifying global styles?

我没法安装 antd 和 antd 的依赖，顺便提一句，我在中国大陆。

那啥，试试 npmmirror 国内镜像 和 cnpm。

我在 package.json 里将 dependencies.antd 添加到了 git repository 中，但是没有用。

当然没用了，请使用 npm 安装 antd。

message 和 notification 是小写的，但是其他的组件都是首字母大写的，这是手滑吗？

不，因为 message 是一个函数，而不是一个 React 组件。

antd 在移动端体验不佳。

请浏览 Ant Design Mobile 以了解详情，antd 并非针对移动端设计。你可以试试 react-component，其中带有 'm-' 'rn-' 前缀的库是为移动端设计的。

antd 是否有国内镜像？

有的，你可以访问 https://ant-design.antgroup.com/index-cn 或 https://ant-design.gitee.io/index-cn 。

产品/版本 地址
Ant Design 5.x https://ant-design.antgroup.com
https://ant-design.gitee.io
Ant Design 4.x https://4x-ant-design.antgroup.com
Ant Design 3.x https://ant-design-3x.gitee.io
Ant Design 2.x https://ant-design-2x.gitee.io
Ant Design 1.x https://ant-design-1x.gitee.io
Ant Design Pro https://ant-design-pro.gitee.io/
Ant Design Mobile https://ant-design-mobile.antgroup.com/zh
https://antd-mobile.gitee.io/
Ant Design Mini https://ant-design-mini.antgroup.com
https://antd-mobile.gitee.io/
Ant Design Charts https://ant-design-charts.antgroup.com
https://antd-mobile.gitee.io/
AntV https://antv.antgroup.com
Ant Motion https://ant-motion.gitee.io

antd 可以像 React 那样使用单文件引入吗？

可以，你可以用 script 标签引入。但是我们推荐使用 npm 来引入 antd，这样维护起来更简单方便。

在我的网络环境下没法获取到 icon 文件。

你应该自行部署 iconfont 文件到你的网络上，参考这个例子。 #1070

在 3.9.x 版本后，我们会使用 svg 图标，你就不用担心本地部署 iconfont 的问题了！

如何拓展 antd 的组件？

如果你需要一些 antd 没有包含的功能，你可以尝试通过 HOC 拓展 antd 的组件。 更多

如何获取未导出的属性定义？

antd 会透出基本组件定义。对于未透出属性，你可以通过 antd 提供的工具类型来获取。例如：

import type { Checkbox, CheckboxProps, GetProp, GetProps, GetRef, Input } from 'antd';

// Get Props
type CheckboxGroupProps = GetProps<typeof Checkbox.Group>;

// Get Prop
type CheckboxValue = GetProp<CheckboxProps, 'value'>;

// Get Ref
type InputRef = GetRef<typeof Input>;

我的组件默认语言是英文的？如何切回中文的。

请尝试使用 ConfigProvider 组件来包裹你的应用。

如果日期组件的国际化仍未生效，请配置 dayjs.locale('zh-cn') 并检查你本地的 dayjs 版本和 antd 依赖的 dayjs 版本是否一致。

为什么时间类组件的国际化 locale 设置不生效？

请检查是否正确设置了 dayjs 语言包。

import 'dayjs/locale/zh-cn';

dayjs.locale('zh-cn');

如果还有问题，请检查是否有两个版本的 dayjs 共存？

npm ls dayjs

一般来说，如果项目中依赖的 dayjs 版本和 antd 依赖的 dayjs 版本 无法兼容（semver 无法匹配，比如项目中的 dayjs 版本写死且较低），则会导致使用两个不同版本的 dayjs 实例，这样也会导致国际化失效。

开启了 Content Security Policy (CSP) 如何处理动态样式？

你可以通过 ConfigProvider 来配置 nonce 属性。

当我指定了 DatePicker/RangePicker 的 mode 属性后，点击后无法选择年份/月份？

在业务开发中，你可能有年份选择，月份范围选择，周范围选择等需求，此时你给现有组件增加了 mode 属性，却发现无法进行点击选择行为，面板也不会关闭。如果给面板添加 disabledDate 也不会相应禁用对应的年/月/周。

就像 这个回复 里解释的一样，这是因为 <DatePicker mode="year" /> 不等于 YearPicker，<RangePicker mode="month" /> 不等于 MonthRangePicker。 mode 属性是在 antd 3.0 时，为了控制面板展现状态而添加的属性，以支持展示时间面板等需求而添加的。mode 只会简单的改变当前显示的面板，不会修改默认的交互行为（比如 DatePicker 依然是点击日才会完成选择并关闭面板）。

同样的，disabledDate 对于任何 <DatePicker /> 也只会针对日面板生效，并不会对 <DatePicker mode="year/month" /> 上的年/月面板生效。

解决办法

你可以参照 这篇文章 或者 这篇文章 里的做法，利用 mode 和 onPanelChange 等方法去封装一个 YearPicker 等组件。

另外我们已经在 antd@4.0 中直接添加了更多相关日期组件来支持这些需求，现在不再需要使用 mode="year|month"，而是直接可以用 YearPicker MonthPicker，并且 disabledDate 也可以正确作用于这些 Picker。

ConfigProvider 设置 prefixCls 后，message/notification/Modal.confirm 生成的节点样式丢失了？

message/notification/Modal.confirm 等静态方法不同于 <Button /> 的渲染方式，是单独渲染在 ReactDOM.render 生成的 DOM 树节点上，无法共享 ConfigProvider 提供的 context 信息。你有两种解决方式：

  1. 使用官方提供的 message.useMessage、notification.useNotification 和 Modal.useModal 来调用这些方法。

  2. 使用 App.useApp 直接调用 message、notification、modal 实例方法。

为什么我不应该通过 ref 访问组件内部的 props 和 state？

你通过 ref 获得引用时只应该使用文档提供的方法。直接读取组件内部的 props 和 state 不是一个好的设计，这会使你的代码与组件版本强耦合。任何重构都可能会使你的代码无法工作，其中重构包括且不仅限于改造成 Hooks 版本、移除 / 更名内部 props 与 state、调整内部 React 节点结构等等。

弹层类组件为什么要统一至 open 属性？

因为历史原因，弹层类组件展示命名并不统一，出现了 open 与 visible 都在使用的情况。这使得非 tsx 用户在开发时遭遇的记忆成本。同样导致新增 feature 时选择何种命名的模棱两可。因而我们希望统一该属性命名，你仍然可以使用原本的 visible 它仍然会向下兼容，但是从 v5 起我们将从文档中移除该属性。

动态样式有 :where 导致旧版浏览器不支持怎么办？

请参考动态主题文档 兼容旧版浏览器 部分内容。

CSS-in-JS 与 tailwindcss 优先级冲突？

同上，你可以调整 antd 样式优先级以覆盖。相关 issue: #38794

CSS-in-JS 如何与 Shadow DOM 一同使用？

请参考文档 Shadow Dom 场景 内容。

如何关闭组件动画

通过 SeedToken 可以很方便的实现：

import { ConfigProvider } from 'antd';

<ConfigProvider theme={{ token: { motion: false } }}>
  <App />
</ConfigProvider>;

如何支持 SSR？

请参考动态主题文档 服务端渲染 部分内容。

V5 中 colorPrimary 和 colorInfo 及 colorLink 之间是什么关系？

在 Ant Design Token 系统中 colorPrimary 和 colorInfo 同属于 基础变量（Seed Token），所以两者是互相独立的。colorLink 则属于 别名变量（Alias Token）, 默认继承 colorInfo 且和 colorPrimary 无关。

如何正确的拼写 Ant Design？

  • ✅ Ant Design：用空格分隔的首字母大写单词，指代设计语言。
  • ✅ antd：全小写，指代 React UI 组件库。
  • ✅ ant.design：特指 ant.design 网站网址。

下面是一些典型的错误例子：

  • ❌ AntD
  • ❌ Ant-D
  • ❌ antD
  • ❌ Antd
  • ❌ ant design
  • ❌ AntDesign
  • ❌ antdesign
  • ❌ Antdesign

你们有接受捐助的渠道吗，比如支付宝或者微信支付？

https://opencollective.com/ant-design

使用表单组件的 setFieldsValue 方法如果对象类型中含有 null 时 TS 类型报错

当我们尝试使用表单组件的表单实例当中的 setFieldsValue 方法设置表单值时，如果在传入的对象中包含有 null 类型，如：

// This is not real world code, just for explain
import { Form } from 'antd';

type Test = {
  value: string[] | null;
};

export default () => {
  const [form] = Form.useForm<Test>();

  form.setFieldsValue({
    value: null, // Error: 不能将类型“null”分配给类型“string[] | undefined”。
  });
};

如果你遇到上述报错，请检查当前项目的 tsconfig.json 中是否包含如下配置：

{
  "strictNullChecks": true
}

如果 strictNullChecks 的值被设置为 true 就会出现上述问题，如果你确定项目中可以不需要这个检测配置（查看strictNullChecks判断是否需要该配置），可以尝试改为 false 关闭控制严格检查功能。但如果你确实需要开启这个功能，那么，你可以在设计类型时，使用其他类型替代 null 以避免出现这种情况。

使用 Next.js 的 App Router 时 antd 组件报错

如果你在使用 Next.js 的 App Router，当你使用 antd 中某些组件提供的子组件，如：Select.Option、Form.Item、Typography.Title 等，可能会出现如下报错：

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.

目前这个问题需要等待 Next.js 官方给出解决方案，在此之前，如果你需要在使用 App router 的页面中使用子组件，目前有两种变通方法：

  • 创建一个包裹组件，提取所需的子组件并重新导出。以 Typography 组件为例，代码大概像这样：
'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" 指令，使页面完全由客户端渲染：
'use client';

// 非真实代码，仅做逻辑说明
export default () => (
  <div className="App">
    <Form>
      <Form.Item>
        <Button type="primary">Button</Button>
      </Form.Item>
    </Form>
  </div>
);