2016-12-22 14:24:50 +08:00
---
2023-08-04 19:27:38 +08:00
group:
title: Basic Usage
order: 1
2023-06-12 16:45:59 +08:00
title: Usage with create-react-app
2016-12-22 14:24:50 +08:00
---
2023-06-15 13:39:47 +08:00
[create-react-app ](https://create-react-app.dev/ ) is one of the best React application development tools, This article will try to use `create-react-app` to create a `TypeScript` project, and introduce antd.
> We build `antd` based on latest stable version of TypeScript (`>=5.0.0`), please make sure your project dependency matches it.
2016-12-22 14:24:50 +08:00
## Install and Initialization
2024-04-05 18:27:10 +08:00
Before all start, you may need install [yarn ](https://github.com/yarnpkg/yarn/ ) or [pnpm ](https://pnpm.io/ ) or [bun ](https://bun.sh/ ).
2016-12-22 14:24:50 +08:00
2024-04-05 18:27:10 +08:00
< InstallDependencies npm = '$ npx create-react-app antd-demo --template typescript' yarn = '$ yarn create react-app antd-demo --template typescript' pnpm = '$ pnpm create react-app antd-demo --template typescript' bun = '$ bun create react-app antd-demo --template typescript' > < / InstallDependencies >
2016-12-22 14:24:50 +08:00
2019-05-07 14:57:32 +08:00
The tool will create and initialize environment and dependencies automatically, please try config your proxy setting or use another npm registry if any network errors happen during it.
2016-12-22 14:24:50 +08:00
2023-06-12 16:45:59 +08:00
Then we go inside project and start it.
2016-12-22 14:24:50 +08:00
```bash
$ cd antd-demo
2023-06-15 13:39:47 +08:00
$ npm run start
2016-12-22 14:24:50 +08:00
```
2023-06-12 16:45:59 +08:00
Open the browser at http://localhost:3000/. It renders a header saying `Welcome to React` on the page.
2016-12-22 14:24:50 +08:00
## Import antd
2017-06-30 03:05:48 +08:00
Below is the default directory structure.
2016-12-22 14:24:50 +08:00
```
├── 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
```
2023-06-15 13:39:47 +08:00
Now we install `antd` from yarn or npm or pnpm.
2016-12-22 14:24:50 +08:00
2024-04-05 18:27:10 +08:00
< InstallDependencies npm = '$ npm install antd --save' yarn = '$ yarn add antd' pnpm = '$ pnpm install antd --save' bun = '$ bun add antd' > < / InstallDependencies >
2016-12-22 14:24:50 +08:00
Modify `src/App.js` , import Button component from `antd` .
2023-06-15 13:39:47 +08:00
```tsx
2023-06-12 16:45:59 +08:00
import React from 'react';
2024-04-05 18:27:10 +08:00
import { Button } from 'antd';
2016-12-22 14:24:50 +08:00
2023-06-15 13:39:47 +08:00
const App: React.FC = () => (
2019-12-15 22:25:56 +08:00
< div className = "App" >
< Button type = "primary" > Button< / Button >
< / div >
);
2016-12-22 14:24:50 +08:00
export default App;
```
2021-09-23 22:13:05 +08:00
OK, you should now see a blue primary button displayed on the page. Next you can choose any components of `antd` to develop your application. Visit other workflows of `create-react-app` at its [User Guide ](https://create-react-app.dev/docs/getting-started ).
2016-12-22 14:24:50 +08:00
2023-06-15 13:39:47 +08:00
### Customize Theme
Ref to the [Customize Theme documentation ](/docs/react/customize-theme ). Modify theme with ConfigProvider:
```tsx
import React from 'react';
2024-04-05 18:27:10 +08:00
import { ConfigProvider } from 'antd';
2023-06-15 13:39:47 +08:00
const App: React.FC = () => (
< ConfigProvider theme = {{ token: { colorPrimary: ' # 00b96b ' } } } >
< MyApp / >
< / ConfigProvider >
);
export default App;
```
`antd` is written in TypeScript with complete definitions, try out and enjoy the property suggestion and typing check.
![](https://gw.alipayobjects.com/zos/antfincdn/26L5vPoLug/8d7da796-175e-40af-8eea-e7031ba09f9f.png)
> Don't install `@types/antd`.
2019-12-15 22:25:56 +08:00
We are successfully running antd components now, go build your own application!