mint-ui README

The project's README from github.com/ElemeFE/mint-ui. As one markdown file: README.md.

Mint UI

Build Status npm NPM downloads JS gzip size CSS gzip size Join the chat at https://gitter.im/ElemeFE/mint-ui

Mobile UI elements for Vue 2.0

Installation

npm i mint-ui -S

# for Vue 1.x
npm i mint-ui@1 -S

Usage

Import all components.

import Vue from 'vue';
import Mint from 'mint-ui';
import 'mint-ui/lib/style.css';

Vue.use(Mint);

Or import specified component. (Use babel-plugin-component)

import { Cell, Checklist } from 'mint-ui';

Vue.component(Cell.name, Cell);
Vue.component(Checklist.name, Checklist);

Equals to

import Vue from 'vue';
import Mint from 'mint-ui';
import 'mint-ui/lib/style.css';

Vue.use(Mint);

// import specified component

import MtRadio from 'mint-ui/lib/radio';
import 'mint-ui/lib/radio/style.css';

Vue.component(MtRadio.name, MtRadio);

babel-plugin-component

Installation

npm i babel-plugin-component -D

Usage

.babelrc

{
  "plugins": ["other-plugin", ["component", [
    { "libraryName": "mint-ui", "style": true }
  ]]]
}

CDN

RawGit

NPMCDN

Development

npm run dev

Contribution

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

License

MIT

mint-ui (ElemeFE/mint-ui)

vue2
Searching Database…

16.4K ·GitHub
What is this?Mint UI is a set of ready-made mobile UI elements — interface components written for Vue 2.0 that you drop into a Vue app to build mobile web pages.
Is Mint UI a standalone app or something I add to my own project?It's a component library: you install it into a Vue project and import the components you want; by itself it doesn't run as an app.
How do I get it into a project?Install it from npm and register the components with Vue.use() — you can import all of them at once or only the ones you need; the README also lists CDN builds (RawGit and npmcdn) if you'd rather use a script tag.
What is babel-plugin-component, and do I need it?It's a helper for slimmer imports: it auto-imports each component's CSS file and enables modular per-component imports, configured in .babelrc. Optional, but handy when you only pick single components.
Does it work with Vue 3, or is it Vue 2 only?It's built for Vue 2.0 — the components target Vue 2, so a Vue 3 project would need a different UI kit.
Is this for native mobile apps, or for mobile web pages?Mobile web pages — these are Vue components rendered in the browser, so they go into a mobile website or webview, not a native iOS or Android app.
How heavy are its dependencies?Very light: besides Vue itself it only pulls in array-find-index, raf.js and vue-lazyload.
What are similar projects?vux, element, vuetify, vant, naive-ui, iview, vuestic-admin, mdb-ui-kit
Creator
ElemeFE
Size
3.3 MB
Stars
16.4K
Age
10y
Commits · 90 Days