/vant

Lightweight Mobile UI Components built on Vue

Primary LanguageJavaScriptMIT LicenseMIT

logo

Mobile UI Components built on Vue

Build Status NPM Download NPM Version NPM License PRs Welcome Automated Release Notes by gren

Features

  • 60+ Reusable components
  • 95% Unit test coverage
  • Extensive documentation and demos
  • Support babel-plugin-import
  • Support Custom Theme
  • Support i18n
  • Support TS
  • Support SSR

Install

# Using npm
npm i @femessage/vant -S

# Using yarn
yarn add @femessage/vant

Tips: Please install Vant 3.0 for Vue 3 projects, see issue#7035

Quickstart

import Vue from 'vue';
import { Button } from '@femessage/vant';
import '@femessage/vant/lib/index.css';

Vue.use(Button);

See more in Quickstart.

Development

# local dev and preview site
yarn dev

# using eslint to check code style
yarn lint

# run unit test
yarn test

# build lib
yarn build:lib

# build site
yarn build:site

# publish lib to npm
yarn release

# publish site to github pages
yarn release:site

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Browser Support

Modern browsers and Android 4.0+, iOS 7+.

Links

LICENSE

MIT