vux README

The project's README from github.com/airyland/vux. As one markdown file: README.md.

Be Cool with Vue@^2.3.0 and WeUI.


Live Demo >>







Sponsors

Requirements

Docs

Quick Start

vux2 template is directly modified from Vue official webpack template.

npm install vue-cli -g
vue init airyland/vux2 projectPath

cd projectPath
npm install // or yarn
npm run dev // or yarn dev

Maintainers

Vux is Inspired or Powered By:

License

MIT

vux (airyland/vux)

Searching Database…

17.4K ·GitHub
What is this?Vux is a library of mobile UI components for Vue 2, based on WeUI — the design language used across WeChat's web pages.
Is this for native mobile apps or for mobile web pages?For mobile web: the components are Vue components you bundle with webpack into a web app, not native iOS or Android widgets.
How do I add Vux to a project?Start from the vux2 template, which is directly modified from Vue's official webpack template; docs are available in Chinese and English.
What do I need to have installed first?Vue ^2.3.0 (the .sync modifier is required), webpack ^2.0, and Node ^7.6 if you develop or build the library itself.
Does it work with Vue 3?No — Vux targets Vue 2 (^2.3.0 or newer) and the README says nothing about Vue 3 support, so plan it for Vue 2 projects.
Is Vux only useful inside WeChat?It is styled on WeUI, the look WeChat uses in its web views, so pages feel at home in WeChat — but the components are plain Vue components for any mobile web app.
Where does Vux draw its design inspiration from?Besides WeUI, the README credits FrozenUI, Ant Design Mobile, Ionic, SUI Mobile, XScroll and PhotoSwipe among its inspirations and building blocks.
Is the documentation available in English?Yes, docs come in Chinese and English, though the English version is still marked as a work in progress.
Creator
airyland
Size
32.6 MB
Stars
17.4K
Age
10y
Commits · 90 Days