React Vant

📱 A mobile component library based on the React framework according to Vant.

🔥 Documentation (Domestic) 🌈 Documentation（GitHub）

🧑‍💻 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 and Parcel@2.
🌵 Modern browsers
🌝 Support SSR(nextjs, remix).

🖥 Environment Support

Edge	Firefox	Chrome	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:

# npm
npm i react-vant --save

# pnpm
pnpm add react-vant

🚀 Quick start

The following are some code examples of react-vant:

Code Snippet:

import ReactDOM from 'react-dom';
import { Button } from 'react-vant';

function App() {
  return <Button>Default Button</Button>;
}

ReactDOM.render(<App />, mountNode);

Code Examples:

For more information, please refer to QuickStart.

🤝 Contributing

Read our contributing guide and let's build a better react-vant together.

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. :)

👥 Contributors

Thanks goes to these wonderful people (emoji key):

_0x219 💻 📖 🚧	_TinsFox 💻 📖 🚧	_{Seth Yuan} 💻	_union-mall 💻	_{Tang Zhi} 💻	_yuegongzi 💻 📖	_周神 💻
_BiscuitCoder 🎨	_{WhiteSource Renovate} 📖 🛡️ 🔧	_{allcontributors[bot]} 🔧	_{dependabot[bot]} 📖 🛡️	_Cedong.Lee 🐛 🤔	_{xiaomao Feng} 🐛	_{xiaojingyuaner} 🐛
_{keep_wan} 🐛	_zhangYin 🐛 🤔	_Yann 🐛	_feifaneric 🐛	_FJHou 🐛	_{Nate Wang} 🐛	_rook1e 🐛
_chinieer 📖	_GangYHu 🐛	_Jungzl 💻	_{Tim Zhao} 📖	_野漫横江 🐛	_NoDocCat 🐛	_{zhong yiqun} 🐛
_KooFrank 🐛	_Songhn 🐛	_晚枫 🐛	_lxdaixin128 🐛	_zoujpxyz2017 🐛	_SingleShadow 🐛	_Lanten 📖
_{Alex Lu} 🐛