mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
82 lines
3.1 KiB
Markdown
82 lines
3.1 KiB
Markdown
<div class="card">
|
|
<div class="van-doc-intro">
|
|
<img class="van-doc-intro__logo" style="width: 120px; height: 120px;" src="https://img01.yzcdn.cn/vant/logo.png">
|
|
<h2 style="margin: 0; font-size: 36px; line-height: 60px;">Vant</h2>
|
|
<p>Mobile UI Components built on Vue</p>
|
|
</div>
|
|
</div>
|
|
|
|
### Features
|
|
|
|
- 🚀 1KB Component average size (min+gzip)
|
|
- 🚀 65+ High quality components
|
|
- 💪 90%+ Unit test coverage
|
|
- 💪 Written in TypeScript
|
|
- 📖 Extensive documentation and demos
|
|
- 📖 Provide Sketch and Axure design resources
|
|
- 🍭 Support Vue 2 & Vue 3
|
|
- 🍭 Support Tree Shaking
|
|
- 🍭 Support Custom Theme
|
|
- 🍭 Support i18n
|
|
- 🌍 Support SSR
|
|
|
|
### Scaffold
|
|
|
|
It is recommended to use [Rsbuild](https://github.com/web-infra-dev/rsbuild) to create a scaffold project.
|
|
|
|
Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant.
|
|
|
|
You can create a Rsbuild project with the following command:
|
|
|
|
```bash
|
|
npm create rsbuild@latest
|
|
```
|
|
|
|
Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
|
|
|
|
### Quickstart
|
|
|
|
See in [Quickstart](#/en-US/quickstart).
|
|
|
|
### Contribution
|
|
|
|
Please make sure to read the [Contributing Guide](https://github.com/vant-ui/vant/blob/dev/.github/CONTRIBUTING.md) before making a pull request.
|
|
|
|
### Browser Support
|
|
|
|
Vant 2 supports modern browsers and Android >= 4.0、iOS >= 8.0.
|
|
|
|
Vant 3 supports modern browsers and Chrome >= 51、iOS >= 10.0 (same as Vue 3).
|
|
|
|
### Official Ecosystem
|
|
|
|
| Project | Description |
|
|
| --- | --- |
|
|
| [vant-weapp](https://github.com/vant-ui/vant-weapp) | WeChat MiniProgram UI |
|
|
| [vant-demo](https://github.com/vant-ui/vant-demo) | Collection of Vant demos |
|
|
| [vant-cli](https://github.com/vant-ui/vant/tree/dev/packages/vant-cli) | Scaffold for UI library |
|
|
| [vant-icons](https://github.com/vant-ui/vant/tree/dev/packages/vant-icons) | Vant icons |
|
|
| [vant-touch-emulator](https://github.com/vant-ui/vant/tree/dev/packages/vant-touch-emulator) | Using vant in desktop browsers |
|
|
|
|
### Community Ecosystem
|
|
|
|
| Project | Description |
|
|
| --- | --- |
|
|
| [3lang3/react-vant](https://github.com/3lang3/react-vant) | React mobile UI Components based on Vant |
|
|
| [mxdi9i7/vant-react](https://github.com/mxdi9i7/vant-react) | Mobile UI Components built on React and TS, inspired by Vant |
|
|
| [vant-aliapp](https://github.com/ant-move/Vant-Aliapp) | Alipay MiniProgram UI |
|
|
| [taroify](https://gitee.com/mallfoundry/taroify) | Vant Taro |
|
|
| [vant-theme](https://github.com/Aisen60/vant-theme) | Online theme preview built on Vant UI |
|
|
| [@antmjs/vantui](https://github.com/antmjs/vantui) | Mobile UI Components based on Vant, supporting Taro and React |
|
|
| [@formily/vant](https://github.com/formilyjs/vant) | Form solution based on Vant and Formily |
|
|
|
|
### Links
|
|
|
|
- [Feedback](https://github.com/vant-ui/vant/issues)
|
|
- [Changelog](#/en-US/changelog)
|
|
- [Gitter](https://gitter.im/vant-contrib/discuss?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
|
|
|
|
### LICENSE
|
|
|
|
[MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89)
|