## ๐งโ๐ป Project Status
Due to personal reasons and limited energy, the project entered maintenance mode and no longer accepted new functions, only accepted PRs that fixed bugs.
## โจ Feature
- ๐ The average component size is less than 1KB๏ผmin+gzip๏ผ.
- ๐ 70+ high-quality components, covering mainstream mobile scenes.
- ๐ช Written in TypeScript, providing a complete type definition.
- ๐ Provide complete documentation and component examples.
- ๐จ Support theme customization, built-in 700+ theme designers.
- ๐ Support on-demand import and Tree Shaking.
- โก๏ธ Support [Vite](https://github.com/3lang3/react-vant-template/tree/main/template/vite) and Parcel@2.
- ๐ต Modern browsers
- ๐ Support SSR([nextjs](https://github.com/3lang3/react-vant-template/tree/main/next/nextjs), [remix](https://github.com/3lang3/react-vant-template/tree/main/next/remix)).
## ๐ฅ Environment Support
| [](http://godban.github.io/browsers-support-badges/) Edge | [](http://godban.github.io/browsers-support-badges/) Firefox | [](http://godban.github.io/browsers-support-badges/) Chrome | [](http://godban.github.io/browsers-support-badges/) Safari |
| --- | --- | --- | --- |
Support modern browsers and Chrome >= 51, iOS >= 10.0.
## ๐ฑ Preview
Scan the QR code on your mobile phone to access the demo:
## ๐ฆ Install
Recommended **pin** version:
```bash
# npm
npm i react-vant --save
# pnpm
pnpm add react-vant
```
## ๐ Quick start
The following are some code examples of react-vant:
#### Code Snippet:
```jsx
import ReactDOM from 'react-dom';
import { Button } from 'react-vant';
function App() {
return ;
}
ReactDOM.render(, mountNode);
```
#### Code Examples:
- [Create React App](https://github.com/3lang3/react-vant-template/tree/main/next/cra)
- [Umi](https://github.com/3lang3/react-vant-template/tree/main/next/umijs)
- [Next.js](https://github.com/3lang3/react-vant-template/tree/main/next/nextjs)
- [Remix](https://github.com/3lang3/react-vant-template/tree/main/next/remix)
- [Astro](https://github.com/3lang3/react-vant-template/tree/main/next/astro)
- [Vite](https://github.com/3lang3/react-vant-template/tree/main/next/vite)
For more information, please refer to [QuickStart](https://react-vant.3lang.dev/guide/quickstart).
## ๐ค Contributing
Read our contributing guide and let's build a better react-vant together.
We welcome all contributions. Please read our [CONTRIBUTING.md](https://react-vant.3lang.dev/guide/contribution) first. You can submit any ideas as pull requests or as GitHub issues. :)
## ๐ฅ Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## ๐ Thanks
[Vant](https://github.com/youzan/vant) - Thanks to the Vant team for years of continuous maintenance, allowing me to stand on the shoulders of giants.
[Zan Design](https://design.youzan.com/) - Thanks for the careful production of YouZan Design Experience Center.
## ๐ License
[MIT](./LICENSE) โ 3lang3