https://github.com/3lang3/react-vant-v1
https://github.com/3lang3/react-vant-v1
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/3lang3/react-vant-v1
- Owner: 3lang3
- License: mit
- Created: 2022-04-28T03:42:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T01:25:56.000Z (over 3 years ago)
- Last Synced: 2025-02-01T02:41:25.735Z (over 1 year ago)
- Language: TypeScript
- Size: 3.02 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
English | [็ฎไฝไธญๆ](https://github.com/3lang3/react-vant/blob/main/packages/react-vant/README.zh-CN.md)
React Vant
๐ฑ A mobile component library based on the React framework according to Vant.
๐ฅ Documentation (Domestic)
ย
๐ Documentation๏ผGitHub๏ผ
## โจ Feature
- ๐ The average component size is less than 1KB๏ผmin+gzip๏ผ.
- ๐ 60+ 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](https://github.com/3lang3/react-vant-template/tree/main/template/nextjs).
## ๐ฅ 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:
View some screenshots.
## ๐ฆ Install
Recommended **pin** version:
```bash
# npm
npm i react-vant -S -E
# pnpm
pnpm i react-vant -S -E
```
## ๐ Quick start
The following are some code examples of react-vant:
#### Code Snippet:
```jsx
import ReactDOM from 'react-dom';
import { Button } from 'react-vant';
import 'react-vant/lib/index.css';
function App() {
return Default Button;
}
ReactDOM.render(, mountNode);
```
#### Code Examples:
- [Create React App](https://github.com/3lang3/react-vant-template/tree/main/template/create-react-app)
- [Umi](https://github.com/3lang3/react-vant-template/tree/main/template/umi)
- [Next.js](https://github.com/3lang3/react-vant-template/tree/main/template/nextjs)
- [Vite](https://github.com/3lang3/react-vant-template/tree/main/template/vite)
For more information, please refer to [QuickStart](https://3lang3.github.io/react-vant/#/zh-CN/).
## ๐ค Contributing
Read our contributing guide and let's build a better react-vant together.
We welcome all contributions. Please read our [CONTRIBUTING.md](https://3lang3.github.io/react-vant/#/zh-CN/contribution) first. You can submit any ideas as pull requests or as GitHub issues. :)
## ๐ญ Discuss
## ๐ฅ Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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
๐ป
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