ant-design/docs/react/use-in-typescript.zh-CN.md

131 lines
3.8 KiB
Markdown
Raw Normal View History

---
2019-12-17 22:25:28 +08:00
order: 5
title: 在 TypeScript 中使用
---
使用 `create-react-app` 一步步地创建一个 TypeScript 项目,并引入 antd。
> `antd` 基于最新稳定版本的 TypeScript`>=4.0.0`),请确保项目中使用匹配的版本。
---
## 安装和初始化
请确保电脑上已经安装了最新版的 [yarn](https://yarnpkg.com) 或者 [npm](https://www.npmjs.com/)。
使用 yarn 创建 [cra-template-typescript](https://github.com/facebook/create-react-app/tree/master/packages/cra-template-typescript) 项目。
```bash
$ yarn create react-app antd-demo-ts --template typescript
```
如果你使用的是 npm接下来我们都会用 yarn 作为例子,如果你习惯用 npm 也没问题)。
```bash
$ npx create-react-app antd-demo-ts --template typescript
```
然后我们进入项目并启动。
```bash
$ cd antd-demo-ts
$ yarn start
```
此时浏览器会访问 http://localhost:3000/ ,看到 `Welcome to React` 的界面就算成功了。
## 引入 antd
```bash
$ yarn add antd
```
修改 `src/App.tsx`,引入 antd 的按钮组件。
```tsx
import React from 'react';
import type { FC } from 'react';
import { Button } from 'antd';
2022-11-18 14:23:50 +08:00
import 'antd/dist/reset.css';
import './App.css';
const App: FC = () => (
<div className="App">
<Button type="primary">Button</Button>
</div>
);
export default App;
```
重新启动 `yarn start`,现在你应该能看到页面上已经有了 antd 的蓝色按钮组件,接下来就可以继续选用其他组件开发应用了。其他开发流程你可以参考 create-react-app 的[官方文档](https://create-react-app.dev/docs/getting-started#creating-a-typescript-app)。
`antd` 使用 TypeScript 书写并提供了完整的定义,你可以享受组件属性输入建议和定义检查的功能。
![](https://gw.alipayobjects.com/zos/antfincdn/26L5vPoLug/8d7da796-175e-40af-8eea-e7031ba09f9f.png)
> 注意不要安装 `@types/antd`。
## 高级配置
这个例子在实际开发中还有一些优化的空间,比如无法进行主题配置。
此时我们需要对 create-react-app 的默认配置进行自定义,这里我们使用 [craco](https://github.com/gsoft-inc/craco) (一个对 create-react-app 进行自定义配置的社区解决方案)。
现在我们安装 craco 并修改 `package.json` 里的 `scripts` 属性。
```bash
$ yarn add @craco/craco
```
```diff
/* package.json */
"scripts": {
2019-01-30 15:03:11 +08:00
- "start": "react-scripts start",
- "build": "react-scripts build",
- "test": "react-scripts test",
+ "start": "craco start",
+ "build": "craco build",
+ "test": "craco test",
}
```
然后在项目根目录创建一个 `craco.config.js` 用于修改默认配置。
```js
/* craco.config.js */
module.exports = {
// ...
};
```
### 自定义主题
参考 [配置主题](/docs/react/customize-theme),通过 ConfigProvider 进行主题配置:
2022-11-16 23:38:38 +08:00
```tsx
import React from 'react';
import { ConfigProvider } from 'antd';
export default () => (
<ConfigProvider
theme={{
token: {
colorPrimary: '#00b96b',
},
2022-11-16 23:38:38 +08:00
}}
>
<MyApp />
</ConfigProvider>
);
```
2019-01-31 17:23:49 +08:00
## 其他方案
2019-01-31 17:17:24 +08:00
如果你已经按照 [在 create-react-app 中使用](/docs/react/use-with-create-react-app) 初始化了环境,可以参考官方文档里的 [Adding TypeScript](https://create-react-app.dev/docs/adding-typescript) 配置 TypeScript 开发环境。
2019-05-16 13:27:46 +08:00
2019-01-31 17:23:49 +08:00
- [Create React apps (with Typescript and antd) with no build configuration](https://github.com/SZzzzz/react-scripts-ts-antd)
- [react-app-rewire-typescript](https://github.com/lwd-technology/react-app-rewire-typescript)
2019-01-31 17:23:49 +08:00
- [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin)
2019-01-31 17:17:24 +08:00
- [Migrating from create-react-app-typescript to Create React App](https://vincenttunru.com/migrate-create-react-app-typescript-to-create-react-app/)