Skip to content

3lang3/react-vant

Repository files navigation

English | 简体中文

logo

React Vant

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

npm version npm download renovate discussions rcdoc license

🔥 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

IE / Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari for iOS
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

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

🙏 Thanks

Vant - Thanks to the Vant team for years of continuous maintenance, allowing me to stand on the shoulders of giants.

Zan Design - Thanks for the careful production of YouZan Design Experience Center.

📜 License

MIT ⓒ 3lang3