ant-design/docs/react/use-with-vite.en-US.md
Kiryll Ye eec67ad62d
docs: Update use-with-vite.en-US.md (#49366)
fix documentation misconception.

Signed-off-by: Kiryll Ye <kiryll.e@gmail.com>
2024-06-12 14:26:10 +08:00

2.0 KiB

group order title
title
Basic Usage
2 Usage with Vite

Vite is one of the best React application development tools. Let's use antd within it.

Install and Initialization

Before all start, you may need install yarn or pnpm or bun.

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 antd-demo install dependencies and start it.

$ cd antd-demo
$ npm install
$ npm run dev

Open the browser at http://localhost:5173/. It renders a header saying Vite + React on the page.

Import antd

Below is the default directory structure.

├── public
│   └── vite.svg
├── src
│   └── assets
│       └── react.svg
│   ├── App.css
│   ├── App.js
│   ├── index.css
│   ├── main.js
│   └── logo.svg
├── index.html
├── package.json
└── vite.config.ts

Now we install antd from yarn or npm or pnpm or bun.

Modify src/App.js, import Button component from antd.

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

const App = () => (
  <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 Vite at its User Guide.

We are successfully running antd components now, go build your own application!