vant 2.13.4 → 2.13.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +179 -0
- package/package.json +7 -7
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="logo" src="https://fastly.jsdelivr.net/npm/@vant/assets/logo.png" width="120" height="120" style="margin-bottom: 10px;">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Vant</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">A lightweight, customizable Vue UI library for mobile web apps.</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<img src="https://img.shields.io/npm/v/vant?style=flat-square" alt="npm version" />
|
|
11
|
+
<img src="https://img.shields.io/codecov/c/github/youzan/vant/main.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
|
12
|
+
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://vant-ui.github.io/vant">Documentation</a>
|
|
17
|
+
|
|
18
|
+
·
|
|
19
|
+
|
|
20
|
+
<a href="https://vant.pro/vant/">Documentation (backup)</a>
|
|
21
|
+
|
|
22
|
+
·
|
|
23
|
+
|
|
24
|
+
<a href="./README.zh-CN.md">中文介绍</a>
|
|
25
|
+
</p>
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- 🚀 1KB Component average size (min+gzip)
|
|
32
|
+
- 🚀 80+ High quality components
|
|
33
|
+
- 🚀 Zero third-party dependencies
|
|
34
|
+
- 💪 90%+ Unit test coverage
|
|
35
|
+
- 💪 Written in TypeScript
|
|
36
|
+
- 📖 Extensive documentation and demos
|
|
37
|
+
- 📖 Provide Sketch and Axure design resources
|
|
38
|
+
- 🍭 Support Vue 2 & Vue 3
|
|
39
|
+
- 🍭 Support Nuxt 2 & Nuxt 3, provide [Vant Module](https://github.com/vant-ui/vant-nuxt) for Nuxt
|
|
40
|
+
- 🍭 Support Tree Shaking
|
|
41
|
+
- 🍭 Support Custom Theme
|
|
42
|
+
- 🍭 Support Accessibility (still improving)
|
|
43
|
+
- 🍭 Support Dark Mode
|
|
44
|
+
- 🍭 Support SSR
|
|
45
|
+
- 🌍 Support i18n, built-in 30+ languages
|
|
46
|
+
|
|
47
|
+
## Install
|
|
48
|
+
|
|
49
|
+
Using `npm` to install:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# install latest Vant for Vue 3 project
|
|
53
|
+
npm i vant
|
|
54
|
+
|
|
55
|
+
# install Vant 2 for Vue 2 project
|
|
56
|
+
npm i vant@latest-v2
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Using `yarn`, `pnpm`, or `bun`:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# with yarn
|
|
63
|
+
yarn add vant
|
|
64
|
+
|
|
65
|
+
# with pnpm
|
|
66
|
+
pnpm add vant
|
|
67
|
+
|
|
68
|
+
# with Bun
|
|
69
|
+
bun add vant
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Scaffold
|
|
73
|
+
|
|
74
|
+
It is recommended to use [Rsbuild](https://github.com/web-infra-dev/rsbuild) to create a scaffold project.
|
|
75
|
+
|
|
76
|
+
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.
|
|
77
|
+
|
|
78
|
+
You can create a Rsbuild project with the following command:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npm create rsbuild@latest
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
|
|
85
|
+
|
|
86
|
+
## Quickstart
|
|
87
|
+
|
|
88
|
+
```js
|
|
89
|
+
import { createApp } from 'vue';
|
|
90
|
+
// 1. Import the components you need
|
|
91
|
+
import { Button } from 'vant';
|
|
92
|
+
// 2. Import the components style
|
|
93
|
+
import 'vant/lib/index.css';
|
|
94
|
+
|
|
95
|
+
const app = createApp();
|
|
96
|
+
|
|
97
|
+
// 3. Register the components you need
|
|
98
|
+
app.use(Button);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
See more in [Quickstart](https://vant-ui.github.io/vant/#/en-US/quickstart).
|
|
102
|
+
|
|
103
|
+
## Browser Support
|
|
104
|
+
|
|
105
|
+
Vant 2 supports modern browsers and Android >= 4.0、iOS >= 8.0.
|
|
106
|
+
|
|
107
|
+
Vant 3/4 supports modern browsers and Chrome >= 51、iOS >= 10.0 (same as Vue 3).
|
|
108
|
+
|
|
109
|
+
## Official Ecosystem
|
|
110
|
+
|
|
111
|
+
| Project | Description |
|
|
112
|
+
| --- | --- |
|
|
113
|
+
| [vant-weapp](https://github.com/vant-ui/vant-weapp) | WeChat MiniProgram UI |
|
|
114
|
+
| [vant-demo](https://github.com/vant-ui/vant-demo) | Collection of Vant demos |
|
|
115
|
+
| [vant-cli](https://github.com/vant-ui/vant/tree/main/packages/vant-cli) | Scaffold for UI library |
|
|
116
|
+
| [vant-icons](https://github.com/vant-ui/vant/tree/main/packages/vant-icons) | Vant icons |
|
|
117
|
+
| [vant-touch-emulator](https://github.com/vant-ui/vant/tree/main/packages/vant-touch-emulator) | Using vant in desktop browsers |
|
|
118
|
+
| [vant-nuxt](https://github.com/vant-ui/vant-nuxt) | Vant module for Nuxt |
|
|
119
|
+
|
|
120
|
+
## Community Ecosystem
|
|
121
|
+
|
|
122
|
+
| Project | Description |
|
|
123
|
+
| --- | --- |
|
|
124
|
+
| [3lang3/react-vant](https://github.com/3lang3/react-vant) | React mobile UI Components based on Vant |
|
|
125
|
+
| [vant-aliapp](https://github.com/ant-move/Vant-Aliapp) | Alipay MiniProgram UI |
|
|
126
|
+
| [vant-theme](https://github.com/Aisen60/vant-theme) | Online theme preview built on Vant UI |
|
|
127
|
+
| [@antmjs/vantui](https://github.com/antmjs/vantui) | Mobile UI Components based on Vant, supporting Taro and React |
|
|
128
|
+
| [Taroify](https://github.com/mallfoundry/taroify) | Taroify is the Taro version of Vant |
|
|
129
|
+
| [vant-playground](https://github.com/LadyChatterleyLover/vant-playground) | Vant Playground |
|
|
130
|
+
| [sfc-playground-vant](https://github.com/zhixiaoqiang/sfc-playground-vant) | Vant Playground |
|
|
131
|
+
| [vue3-h5-template](https://github.com/yulimchen/vue3-h5-template) | Mobile project template based on Vant |
|
|
132
|
+
| [vue3-vant-mobile](https://github.com/easy-temps/vue3-vant-mobile) | Mobile project template based on Vant |
|
|
133
|
+
| [vscode-common-intellisense](https://github.com/Simon-He95/vscode-common-intellisense) | A VS Code extension that provides better intellisense to Vant developers |
|
|
134
|
+
| [nuxt-vant-mobile](https://github.com/easy-temps/nuxt-vant-mobile) | Nuxt _⁴_ project template based on Vant, out of the box |
|
|
135
|
+
|
|
136
|
+
## Links
|
|
137
|
+
|
|
138
|
+
- [Documentation](https://vant-ui.github.io/vant/)
|
|
139
|
+
- [Documentation (backup)](https://vant.pro/vant/)
|
|
140
|
+
- [Changelog](https://vant-ui.github.io/vant/#/en-US/changelog)
|
|
141
|
+
- [Discussions](https://github.com/vant-ui/vant/discussions)
|
|
142
|
+
|
|
143
|
+
## Preview
|
|
144
|
+
|
|
145
|
+
You can scan the following QR code to access the demo：
|
|
146
|
+
|
|
147
|
+
<img src="https://fastly.jsdelivr.net/npm/@vant/assets/preview-qrcode.png" width="220" height="220" >
|
|
148
|
+
|
|
149
|
+
## Core Team
|
|
150
|
+
|
|
151
|
+
Core contributors of Vant and Vant Weapp:
|
|
152
|
+
|
|
153
|
+
| [](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/) |
|
|
154
|
+
| :-: | :-: | :-: | :-: | :-: | :-: |
|
|
155
|
+
| [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/) |
|
|
156
|
+
|
|
157
|
+
| [](https://github.com/Lindysen/) | [](https://github.com/JakeLaoyu/) | [](https://github.com/landluck/) | [](https://github.com/wjw-gavin/) | [](https://github.com/inottn/) | [](https://github.com/zhousg/) |
|
|
158
|
+
| :-: | :-: | :-: | :-: | :-: | :-: |
|
|
159
|
+
| [Lindysen](https://github.com/Lindysen/) | [JakeLaoyu](https://github.com/JakeLaoyu/) | [landluck](https://github.com/landluck/) | [wjw-gavin](https://github.com/wjw-gavin/) | [inottn](https://github.com/inottn/) | [zhousg](https://github.com/zhousg/) |
|
|
160
|
+
|
|
161
|
+
## All Contributors
|
|
162
|
+
|
|
163
|
+
Thanks to the following friends for their contributions to Vant:
|
|
164
|
+
|
|
165
|
+
<a href="https://github.com/vant-ui/vant/graphs/contributors">
|
|
166
|
+
<img src="https://opencollective.com/vant/contributors.svg?width=890&button=false" alt="contributors">
|
|
167
|
+
</a>
|
|
168
|
+
|
|
169
|
+
## Contribution Guide
|
|
170
|
+
|
|
171
|
+
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
|
|
172
|
+
|
|
173
|
+
## Start On Web IDE
|
|
174
|
+
|
|
175
|
+
[https://github.dev/youzan/vant](https://github.dev/youzan/vant)
|
|
176
|
+
|
|
177
|
+
## LICENSE
|
|
178
|
+
|
|
179
|
+
Vant is [MIT](https://github.com/youzan/vant/blob/main/LICENSE) licensed.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vant",
|
|
3
|
-
"version": "2.13.
|
|
3
|
+
"version": "2.13.5",
|
|
4
4
|
"description": "Mobile UI Components built on Vue",
|
|
5
5
|
"main": "lib/vant.cjs.js",
|
|
6
6
|
"module": "es/index.mjs",
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
"components"
|
|
48
48
|
],
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@vant/popperjs": "
|
|
51
|
-
"@vant/use": "
|
|
50
|
+
"@vant/popperjs": "^1.3.0",
|
|
51
|
+
"@vant/use": "^1.6.0",
|
|
52
52
|
"@vue/shared": "^3.5.13"
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
@@ -56,10 +56,10 @@
|
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
58
|
"@types/node": "^22.10.1",
|
|
59
|
-
"@vant/area-data": "
|
|
60
|
-
"@vant/cli": "
|
|
61
|
-
"@vant/eslint-config": "
|
|
62
|
-
"@vant/icons": "
|
|
59
|
+
"@vant/area-data": "2.0.0",
|
|
60
|
+
"@vant/cli": "7.1.0",
|
|
61
|
+
"@vant/eslint-config": "4.0.0",
|
|
62
|
+
"@vant/icons": "3.0.2",
|
|
63
63
|
"@vitejs/plugin-vue": "^5.2.1",
|
|
64
64
|
"@vitejs/plugin-vue-jsx": "^4.1.1",
|
|
65
65
|
"@vitest/coverage-istanbul": "^2.1.6",
|