为Vue2集成UIkit

引言:Vue只是为咱们提供了一个很优秀的前端组件式开发框架,但单纯依靠Vue是作不出一个漂亮的网页应用的,甚至连“不难看”这个标准都达不到。这个时候借助界面框架UIkit可以很好地解决这一问题。
本文出自《Vue2实践揭秘》一书。css

  在实际开发中,还有不少经常使用组件,例如,分页、按钮、输入框、导航栏、日期/时间选择器、图片输入,等等。很明显的是这些组件的通用性已不仅仅存在于一个项目内,而是全部的项目都须要!这是个比拼开发速度的年代,咱们已经没有时间重复发明轮子了,最正确的选择是使用界面框架,例如Bootstrap、UIkit、Foundation等来代替这种大量的重复性极强的界面样式开发工做。html

UIkit

  Bootstrap已经有不少年历史了,在业界的应用也至关广泛,不管是前端开发或者后端开发,为了能快速作一个不算太难看的界面,它天然成为众多工程师的选择,包括我。多年下来,Bookstrap的改进实在是太缓慢了。不客气地说,它基本上就没让咱们这些用户感受它改进过,同质化严重,功能性组件一直不见增长,等等,都让咱们只能是痛并用着。
  UIkit给咱们带来了福音,不管从界面上的样式,仍是实用组件的数目,甚至到易用性来讲都要比Bootstrap好上一个层次。惟一的缺陷是它出生得比较晚,可选的主题样式资源很少,毕竟还须要时间让第三方社区来推进发展。但用它来作一个漂亮的交互性强的应用绝对是一个最佳的推荐方案。
  Vue社区上也有一些包装UIkit的库,如vuikit,但它的文档实在太少了,甚至从一开始的安装配套都作得很是差,基本上是脱离了UIkit的核心样式包和核心脚本编写的。虽然努力可嘉,但这种功能性复制的包建议仍是不要用,前端最耗不起的就是编译包的大小。每一个引入的第三方包咱们都得吝啬地测算一下得失,即便webpack能够用chuck来分包,但也不能滥用,不然加载速度缓慢就是破坏使用体验的最大因素。前端

安装

  虽然在AngularJS、React和Vue的项目中jQuery历来都是一个不受欢迎的库。首先是它编译出来后就很是大,并且影响咱们的MVVM思惟,容易由于图方便而又回到jQuery那种直接操控DOM的死路上去。但jQuery的强大在于它的普及性,几乎咱们能找到的不少优秀小组件都会有jQuery版本,甚至只有jQuery的版本。而UIkit正是其中一员,不能抗拒的话也只能学会享受。咱们得同时安装jQuery、UIkit两个库:vue

$ npm i jquery uikit -D

配置

  咱们须要将jQuery和UIkit的引用以及一些字体的引用配置添加到webpack中(UIkit内置引用了Fontawesome字体库),确保已安装了url-loader这个库,若是没有安装的话用如下指令进行安装:node

$ npm i url-loader --D

  在webpack.config.js的module.rules配置中加入字体引用配置:jquery

rules: [
    // ... 省略
    {        test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,        loader: 'url',        query: {            limit: 10000,            name: '[name].[hash:7].[ext]'
        }
    }
]

  固然,若是你采用vue-cli webpack模板来构造项目的话,能够跳过以上的配置。
  UIkit的运行主要依赖于一个主样式文件uikit.css、一个主题文件uikit.almost-flat.css(主题文件内置有三个可选项)和一个脚本文件uikit.js。使用UIkit时,须要在代码中同时import它们才能让webpack在编译时正确地引用。界面包都是全局性的,那么能够选择在main.js文件一开始加入引用:webpack

import 'jquery'import 'uikit'import 'uikit/dist/css/uikit.almost-flat.css'

  这样写就违反了在第2章工程化Vue.js开发中的一个配置约定,咱们不该该将“库”或“依赖包”以全路径方式引入到代码文件中,而应该用webpack的resolve配置项,用别名来代替全路径。如下是在webpack中配置UIkit的样式引用别名:web

resolve: {    alias: {        'vue$': 'vue/dist/vue',        'uikit-css$': 'uikit/dist/css/uikit.almost-flat.css'
    }
}

  在main.js代码内引入UIkit,代码就变为:vue-cli

import 'jquery'import 'uikit'import "uikit-css"

制做UIkit的Vue插件

  上述的写法仍是不够DRY,为了使用一个包就得引入多个不一样的依赖库,这种作法实在很难看,此时咱们能够选择一个Vue的最佳作法,就是用插件形式来包装这种零碎化的引入方式。在src根目录下新建一个uikit.js的文件,而后用Vue的插件格式来进行包装。如下代码中直接向Vue实例注入了UIkit的一些经常使用的帮助方法:npm

import 'jquery'import 'uikit'import 'uikit-css'export default (Vue, options) {    // 向实例注入UIkit的对话框类方法
    Vue.prototype.$ui = {
        alert: UIkit.modal.alert
        confirm: UIkit.modal.confirm,
        prompt: UIkit.modal.prompt,
        block: UIkit.modal.block
    }
}

  完成uikit.js的编写就能够改写main.js的内容了:

import UIkit from './uikit'Vue.use(UIKit)

  因为对Vue.prototype进行了扩展,那么就能够像vue-resource那样在每一个Vue实例内的this方法中注入一个$ui对象,用如下方法来显示简单的对话框:

methods: {
    delItem() {        this.$ui.confirm('您确认要删除如下的数据吗?', () => {            // 这里编写对数据进行删除的代码
        })
    }
}

  

       图片描述

  上述的confirm方法有一个明显的弱点,就是在回调时this上下文会指向window而不是Vue实例自己,这样的话对于编码的使用体验就不好了。咱们能够在插件内对confirm作一个修饰,将回调方法的this从新指向Vue实例:

Vue.prototype.$ui = {   // ... 省略
   confirm (question,callback,cancelCallback,options) {
        UIkit.confirm(question,        callback || callback.apply(this),
        cancelCallback || cancelCallback.apply(this),
        options)
   }

}

  apply函数是ECMA JavaScript的标准函数,用于更改调用方法上传递的上下文对象。上述代码就是将回调函数的上下文强制替换为当前的Vue实例,避免了回调上下文丢失而须要手工去定义变量,“hold住”原有this上下文的痛苦。

关于apply函数详细说明能够参考如下连接:https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Function/apply。

  如今的代码是否是感受干净多了?那么回过头来看Vue的插件,在这里面咱们不只能够像上述代码那样单纯地对Vue实例进行扩展,还能够进行更多的全局化的处理。固然这里的全局是指这个插件库被引入Vue并调用use方法后,例如,咱们能够将一些必要的组件或者指令混入插件方法内:

export default = (Vue, options) => {  // 1. 注入全局化的方法
  Vue.myGlobalMethod = () => {    // ...
  }  // 2. 进行必要组件的注册
  Vue.component('html-editor', { 
    HtmlEditor
  })  // 3. 注册一个全局化的指令标记
  Vue.directive('sortable', {
    bind (el, binding, vnode, oldVnode) {      // something logic ...
    }
    ...
  })  // 4. 注入一些组件的选项
  Vue.mixin({    created: function () {      // ...
    }
    ...
  })  // 5. 扩展实例
  Vue.prototype.$ui = {}

}

UIkit中的坑

  当运行以上的代码后,会很沮丧地发现浏览器中总会出现UI.$为空的异常,具体显示以下:

Type error UI.$ is undefined.

  我曾尝试过直接跳入UIkit的源代码中查找UI.$,这个变量实际上是对jQuery的一个内部引用,准确地说这是在引用jQuery的脚本后由jQuery注册到浏览器的window全局变量上的jQuery实例。估计是UIkit在生成加载代码时变量的映射与初始化顺序出现问题了。后来想了个办法,直接在webpack.config.js配置内对全局变量进行改写,具体代码以下:

plugins: [
        new webpack.ProvidePlugin({
            $: "jquery",            jQuery: "jquery",            "window.jQuery": "jquery",            "window.$": "jquery"
        })
]

  webpack.ProvidePlugin这个插件是用于JS代码加载后在window上注册全局变量的一个webpack插件,加入了以上的配置后程序就能正常运行了。最终幸运地从大坑中逃出生还!这样UIkit就被集成到咱们的Vue项目中来了。
  本文出自《Vue2实践揭秘》一书,点此连接可在博文视点官网查看此书。
                    图片描述
  想及时得到更多精彩文章,可在微信中搜索“博文视点”或者扫描下方二维码并关注。
                       图片描述

相关文章
相关标签/搜索