vue-mobile

v1.4.27

Published

9 months ago

a simple UI framework based on Vue.

Downloads

120

0High
0Medium
0Low

zhaojintian

zhaotoday

vue-mobile uni-app ui-components mini-program

关于

简介

Vue Mobile 是一个基于 Vue 的移动端 UI 框架，为多端开发而生，支持发布到 Android、iOS、H5、以及各种小程序。

依赖框架

Uni App 框架。

技术栈

Vue、Vuex、ES6、Sass、PostCSS 等。

开发工具

HBuilderX IDE。

示例项目

https://github.com/zhaotoday/vue-mobile-template

使用

命令

# 安装
$ npm install vue-mobile --save

# 格式化代码
$ npm run format

# 校验代码
$ npm run lint

开发与构建

请参考 HBuilderX 的使用。

目录规范


|- apis                 API
|  |- public            前端 API
|     |- wx-users.js    微信用户 API
|  |- wx                微信端 API
|     |- wx-users.js    微信用户 API
|
|- assets               待编译的静态资源
|  |- images            图片（必须小于 40K）
|     |- components     组件图片
|        |- icon        icon 组件图片
|  |- styles            样式
|     |- global         全局样式
|     |- utils          Sass 工具
|        |- variables   Sass 变量
|
|- components           组件
|  |- icon              icon 组件
|     |- index.vue      icon 组件模板
|     |- script.js      icon 组件脚本
|     |- style.scss     icon 组件样式
|
|- mixins               混合
|
|- pages                页面
|  |- home              主页
|     |- index.vue      主页模板
|     |- script.js      主页脚本
|     |- style.scss     主页样式
|
|- plugins              插件
|
|- static               无需编译的静态资源
|  |- images            图片
|
|- store                Vuex 状态管理
|  |- modules           Vuex 状态管理模块拆分
|     |- public         前端状态管理
|        |- wx-users.js 微信用户状态管理
|     |- wx             微信端状态管理
|        |- wx-users.js 微信用户状态管理
|
|- utils                工具

定义 Sass 变量

可定义 CDN 地址/版本、本地图片地址、色值、组件相关 Sass 变量、自定义 Sass 变量等。

// CDN 地址
$cdn: "http://localhost:88";

// CDN 版本号
$cdn-version: 0.1;

// 图片地址
$image-url: "~@/assets/images";

// 色值
$colors: (
  white: white,
  black: black,
  ...
);

// button
$button-widths: 680px, 84px;

覆盖 Vue Mobile 内置组件默认的图片资源

请参考 Vue Mobile 图片目录结构，将图片放置在 assets/images/components/ 目录下。

注：需要修改 Sass 变量 $image-url，指向对应目录：$image-url: "~@/assets/images";

按需引用内置组件样式

assets/styles/global/components/index.scss

@import "~vue-mobile/assets/styles/global/components/avatar";
@import "~vue-mobile/assets/styles/global/components/button";
@import "~vue-mobile/assets/styles/global/components/close";
// ...

定义全局样式

在 assets/styles/global 目录下的 classes、 components、objects、reset 目录下新建样式文件并编写样式，在对应的 index.scss 引入样式文件。

按需引用并注册内置组件

main.js

// ...
import Checkbox from "vue-mobile/components/checkbox";
// ...
Vue.component("c-checkbox", Checkbox);
// ...

注：全局组件名称以 c- 开头。

代码示例

数据模型

apis/wx/wx-users.js

import { Rest } from "vue-mobile/@lr/utils/rest";
import { auth } from "vue-mobile/@lr/utils/auth";
import { consts } from "@/utils/consts";

export class WxUsersApi extends Rest {
  constructor() {
    super();

    this.baseUrl = consts.API_URL;
    this.headers = auth.getHeaders();
    this.path = "wx/wxUsers";
  }
}

页面

pages/home/index.vue

<template>
  <div class="p-home">
    home
  </div>
</template>

<script src="./script.js"></script>

<style lang="scss" src="./style.scss"></style>

pages/home/script.js

export default {};

pages/home/style.scss

@import "~@/assets/styles/utils/index.scss";

@include p(home) {
  // ...
}

组件

同页面。

Vuex 状态管理

store/modules/public/enums.js

import helpers from "jt-helpers";
import { publicEnumsApi } from "@/apis/public/enums";

const state = {
  data: {
    config: {
      version: "",
    },
  },
};

const types = helpers.keyMirror({
  SetData: null,
});

const mutations = {
  [types.SetData](state, data) {
    state.data = data;
  },
};

const actions = {
  async get({ commit }) {
    const res = await publicEnumsApi.get({});
    commit(types.SetData, res);
    return res;
  },
};

export default {
  namespaced: true,
  state,
  mutations,
  actions,
};

贴士

安装必要插件

请在 HBuilderX 上安装scss/sass编译插件。

忽略目录

忽略目录，便于查找源码。选中目录 -> 右键 -> Mark Directory as -> Excluded；

代码格式化

执行命令 npm run format。

识别项目别名

复制 alias.config.js 文件到项目根目录下；
WebStorm -> File -> Settings -> Languages & Frameworks -> JavaScript -> Webpack -> webpack configuration file 选择 alias.config.js；

使用 iconfont

在 iconfont 相应图标项目，点击 下方新 icon 来袭，点击更新代码，更新后将支持 WOFF2 格式；
复制代码到 /assets/styles/global/components/iconfont.scss，.c-iconfont 去掉样式 font-size: 16px;，添加样式 display: inline-block;；