https://github.com/openwebf/vant-webf
Vue Vant@3 Library for WebF
https://github.com/openwebf/vant-webf
Last synced: about 1 year ago
JSON representation
Vue Vant@3 Library for WebF
- Host: GitHub
- URL: https://github.com/openwebf/vant-webf
- Owner: openwebf
- License: mit
- Created: 2022-11-18T08:08:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T01:12:17.000Z (about 2 years ago)
- Last Synced: 2025-03-26T04:21:36.826Z (about 1 year ago)
- Language: TypeScript
- Size: 103 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Vant
Lightweight Mobile UI Components built on Vue
π₯ ζζ‘£η½η«οΌε½ε
οΌ
Β
π ζζ‘£η½η«οΌGitHubοΌ
Β
π¨π³ δΈζηδ»η»
---
## Features
- π 1KB Component average size (min+gzip)
- π 70+ High quality components
- π Zero third-party dependencies
- πͺ 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 Accessibility (still improving)
- π Support Dark Mode (Requires upgrade to [Vant 4](https://vant-contrib.gitee.io/vant/v4/#/en-US/config-provider))
- π Support SSR
- π Support i18n, built-in 20+ languages
## Install
Using `npm` to install:
```bash
# install latest Vant for Vue 3 project
npm i vant
# install Vant 2 for Vue 2 project
npm i vant@latest-v2
```
Using `yarn` or `pnpm`:
```bash
# with yarn
yarn add vant
# with pnpm
pnpm add vant
```
## Quickstart
```js
import { createApp } from 'vue';
// 1. Import the components you need
import { Button } from 'vant';
// 2. Import the components style
import 'vant/lib/index.css';
const app = createApp();
// 3. Register the components you need
app.use(Button);
```
See more in [Quickstart](https://vant-ui.github.io/vant#/en-US/quickstart).
## Browser Support
Vant 2 supports modern browsers and Android >= 4.0γiOS >= 8.0.
Vant 3/4 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/3.x/packages/vant-cli) | Scaffold for UI library |
| [vant-icons](https://github.com/vant-ui/vant/tree/3.x/packages/vant-icons) | Vant icons |
| [vant-touch-emulator](https://github.com/vant-ui/vant/tree/3.x/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 |
| [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 |
| [sfc-playground-vant](https://github.com/zhixiaoqiang/sfc-playground-vant) | Try Vant in the Playground. Currently only Vant 3+ is supported |
## Links
- [Documentation](https://vant-ui.github.io/vant)
- [Changelog](https://vant-ui.github.io/vant#/en-US/changelog)
- [Discussions](https://github.com/vant-ui/vant/discussions)
## Preview
You can scan the following QR code to access the demoοΌ

## Core Team
Core contributors of Vant and Vant Weapp:
| [](https://github.com/chenjiahan/) | [](https://github.com/cookfront/) | [](https://github.com/w91/) | [](https://github.com/pangxie1991/) | [](https://github.com/rex-zsd/) | [](https://github.com/nemo-shen/) | [](https://github.com/Lindysen/) | [](https://github.com/JakeLaoyu/) |
| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| [chenjiahan](https://github.com/chenjiahan/) | [cookfront](https://github.com/cookfront/) | [wangnaiyi](https://github.com/w91/) | [pangxie](https://github.com/pangxie1991/) | [rex-zsd](https://github.com/rex-zsd/) | [nemo-shen](https://github.com/nemo-shen/) | [Lindysen](https://github.com/Lindysen/) | [JakeLaoyu](https://github.com/JakeLaoyu/) |
## All Contributors
Thanks to the following friends for their contributions to Vant:
## Contribution Guide
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
## LICENSE
[MIT](https://en.wikipedia.org/wiki/MIT_License)