1 通过 Create Nuxt App 创建一个新项目
# npm
npx create-nuxt-app <project-name>
# or yarn
yarn create nuxt-app <project-name>
...
2 安装 @lbzui/vue
# npm
npm i @lbzui/vue -S
# or yarn
yarn add @lbzui/vue
3 引入 @lbzui/vue
// plugins/lbzui.js
import Vue from 'vue'
import LBZUI from '@lbzui/vue'
Vue.use(LBZUI, {
dense: false,
ripple: true
})
或按需引入组件(推荐地):
// plugins/lbzui.js
import Vue from 'vue'
import {
Backdrop,
Button,
Card,
Checkbox,
Dialog,
Divider,
Drawer,
EmptyState,
FAB,
Icon,
IconButton,
List,
ListItem,
Radio,
Snackbar,
State,
Switch,
Tab,
TabItem,
TopAppBar
} from '@lbzui/vue'
Vue.prototype.$lbzui = {
dense: false,
ripple: true
}
Vue.use(Backdrop)
Vue.use(Button)
Vue.use(Card)
Vue.use(Checkbox)
Vue.use(Dialog)
Vue.use(Divider)
Vue.use(Drawer)
Vue.use(EmptyState)
Vue.use(FAB)
Vue.use(Icon)
Vue.use(IconButton)
Vue.use(List)
Vue.use(ListItem)
Vue.use(Radio)
Vue.use(State)
Vue.use(Switch)
Vue.use(Tab)
Vue.use(TabItem)
Vue.use(TopAppBar)
Vue.prototype.$lbzSnackbar = Snackbar
在 nuxt.config.js 中添加它和 CSS 资源:
export default {
css: ['@lbzui/vue/lib/lbzui.css'],
plugins: ['~/plugins/lbzui.js'],
router: {
// globally configure `<router-link>` default active class for exact matches
linkExactActiveClass: 'lbz-is-activated'
},
build: {
transpile: ['@lbzui/vue']
}
}
4 构建 Material 主题
提醒:如果直接使用编译后的 CSS,可以跳过这一步。
主要是通过自定义布局网格、圆角边框半径、主题颜色等来创建自己的 Material 主题。
安装依赖包:
# npm
## Less (3.5.0+)
npm i less less-loader -D
npm i @nuxtjs/style-resources -D
## convert pixel units to rem units (optional)
npm i postcss-pxtorem -D
# or yarn
yarn add less less-loader @nuxtjs/style-resources postcss-pxtorem --dev
创建 assets/css/lbzui/index.less 并引入 CSS 资源:
@import 'normalize.css';
// all:
// @import '~@lbzui/vue/src/assets/css/index.less';
// or individual (recommended):
@import '~@lbzui/vue/src/assets/css/base.less';
@import '~@lbzui/vue/src/assets/css/utilities/aspect-ratio.less';
@import '~@lbzui/vue/src/assets/css/utilities/clearfix.less';
@import '~@lbzui/vue/src/assets/css/utilities/elevation.less';
@import '~@lbzui/vue/src/assets/css/utilities/layout-grid.less';
@import '~@lbzui/vue/src/assets/css/utilities/surface.less';
@import '~@lbzui/vue/src/assets/css/utilities/truncate.less';
@import '~@lbzui/vue/src/assets/css/utilities/typography.less';
@import '~@lbzui/vue/src/assets/css/components/backdrop.less';
@import '~@lbzui/vue/src/assets/css/components/button.less';
@import '~@lbzui/vue/src/assets/css/components/card.less';
@import '~@lbzui/vue/src/assets/css/components/checkbox.less';
@import '~@lbzui/vue/src/assets/css/components/dialog.less';
@import '~@lbzui/vue/src/assets/css/components/divider.less';
@import '~@lbzui/vue/src/assets/css/components/drawer.less';
@import '~@lbzui/vue/src/assets/css/components/empty-state.less';
@import '~@lbzui/vue/src/assets/css/components/fab.less';
@import '~@lbzui/vue/src/assets/css/components/icon.less';
@import '~@lbzui/vue/src/assets/css/components/icon-button.less';
@import '~@lbzui/vue/src/assets/css/components/list.less';
@import '~@lbzui/vue/src/assets/css/components/list-item.less';
@import '~@lbzui/vue/src/assets/css/components/radio.less';
@import '~@lbzui/vue/src/assets/css/components/snackbar.less';
@import '~@lbzui/vue/src/assets/css/components/state.less';
@import '~@lbzui/vue/src/assets/css/components/switch.less';
@import '~@lbzui/vue/src/assets/css/components/tab.less';
@import '~@lbzui/vue/src/assets/css/components/tab-item.less';
@import '~@lbzui/vue/src/assets/css/components/top-app-bar.less';
然后在 nuxt.config.js 中添加以下配置:
export default {
css: ['~assets/css/lbzui/index.less'],
// https://github.com/nuxt-community/style-resources-module
buildModules: ['@nuxtjs/style-resources'],
styleResources: {
less: [
// variables
// './node_modules/@lbzui/vue/src/assets/css/variables/_*.less',
'./node_modules/@lbzui/vue/src/assets/css/variables/_elevation.less',
// './node_modules/@lbzui/vue/src/assets/css/variables/_layout-grid.less',
'./assets/css/lbzui/_layout-grid.less', // your custom layout grid
'./node_modules/@lbzui/vue/src/assets/css/variables/_motion.less',
// './node_modules/@lbzui/vue/src/assets/css/variables/_shape.less',
'./assets/css/lbzui/_shape.less', // your custom shape
'./node_modules/@lbzui/vue/src/assets/css/variables/_state.less',
'./node_modules/@lbzui/vue/src/assets/css/variables/_surface.less',
// './node_modules/@lbzui/vue/src/assets/css/variables/_theme.less',
'./assets/css/lbzui/_theme.less', // your custom theme
'./node_modules/@lbzui/vue/src/assets/css/variables/_variables.less',
// mixins
'./node_modules/@lbzui/vue/src/assets/css/utilities/_*.less'
]
},
build: {
postcss: {
plugins: {
// https://github.com/cuth/postcss-pxtorem#options
'postcss-pxtorem': {
unitPrecision: 8,
propList: ['font', 'font-size', 'line-height']
}
},
preset: {
// change the postcss-preset-env settings
// https://github.com/csstools/postcss-preset-env#options
stage: 3,
autoprefixer: {
flexbox: 'no-2009',
grid: 'no-autoplace'
},
importFrom: [
// './node_modules/@lbzui/vue/src/assets/css/variables/variables.css'
'./assets/css/lbzui/variables.css' // your custom CSS Variables
]
}
}
}
}
5 如使用按钮组件
<template>
<lbz-button @click.stop="fclick">Hello world</lbz-button>
</template>
<script lang="ts">
import Vue from 'vue'
export default Vue.extend({
name: 'HelloWorld',
methods: {
fclick(e: MouseEvent): void {
alert('Hello @lbzui/vue!')
}
}
}
</script>
6 从 Google CDN 上加载 Roboto font、Material Icons(可选地)
// nuxt.config.js
export default {
head: {
link: [
{
rel: 'stylesheet',
href:
'https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap'
},
{
rel: 'stylesheet',
href:
'https://fonts.googleapis.com/icon?family=Material+Icons&display=block'
}
]
}
}