- Ant Design of React
- v5.21.0Changelog
- Basic Usage
- Advanced
- Migration
- Other
Usage with create-react-app
create-react-app 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.
$ npx create-react-app antd-demo --template typescript
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.
Then we go inside project and start it.
$ cd antd-demo$ npm run start
Open the browser at http://localhost:3000/. It renders a header saying Welcome to React
on the page.
Below is the default directory structure.
├── 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
Now we install antd
from yarn or npm or pnpm.
$ npm install antd --save
Modify src/App.js
, import Button component from 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;
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.
Ref to the Customize Theme documentation. Modify theme with ConfigProvider:
import React from 'react';import { ConfigProvider } from 'antd';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.
Don't install
@types/antd
.
We are successfully running antd components now, go build your own application!