ant-design/docs/react/use-with-create-react-app.zh-CN.md
MadCcc d9c7a0cc82
docs: react docs arrange (#44029)
* docs: react docs arrange

* chore: code clean

* docs: arrange docs en

* docs: update

* docs: update

* docs: update en doc

* docs: update
2023-08-04 19:27:38 +08:00

2.9 KiB
Raw Blame History

group order title
title
如何使用
1 在 create-react-app 中使用

create-react-app 是业界最优秀的 React 应用开发工具之一,本文会尝试使用 create-react-app 创建一个 TypeScript 项目,并引入 antd。

antd 基于最新稳定版本的 TypeScript>=5.0.0),请确保项目中使用匹配的版本。

安装和初始化

在开始之前,你可能需要安装 yarn 或者 pnpm

工具会自动初始化一个脚手架并安装 React 项目的各种必要依赖,如果在过程中出现网络问题,请尝试配置代理或使用其他 npm registry。

然后我们进入项目并启动。

$ cd antd-demo
$ npm run start

此时浏览器会访问 http://localhost:3000/ ,看到 Welcome to React 的界面就算成功了。

引入 antd

这是 create-react-app 生成的默认目录结构。

├── README.md
├── package.json
├── public
│   ├── favicon.ico
│   └── index.html
├── src
│   ├── App.css
│   ├── App.js
│   ├── App.test.js
│   ├── index.css
│   ├── index.js
│   └── logo.svg
└── yarn.lock

现在从 yarn 或 npm 或 pnpm 安装并引入 antd。

修改 src/App.js,引入 antd 的按钮组件。

import React from 'react';
import { Button } from 'antd';

const App: React.FC = () => (
  <div className="App">
    <Button type="primary">Button</Button>
  </div>
);

export default App;

好了,现在你应该能看到页面上已经有了 antd 的蓝色按钮组件,接下来就可以继续选用其他组件开发应用了。其他开发流程你可以参考 create-react-app 的官方文档

自定义主题

参考 配置主题,通过 ConfigProvider 进行主题配置:

import React from 'react';
import { ConfigProvider } from 'antd';

const App: React.FC = () => (
  <ConfigProvider theme={{ token: { colorPrimary: '#00b96b' } }}>
    <MyApp />
  </ConfigProvider>
);

export default App;

antd 使用 TypeScript 书写并提供了完整的定义,你可以享受组件属性输入建议和定义检查的功能。

注意不要安装 @types/antd

我们现在已经把 antd 组件成功运行起来了,开始开发你的应用吧!