基于 vue-skeleton-webpack-plugin 的骨架屏实战

网络编程 2024/11/15 佚名

3 2 1

前言

目前正在做的项目，登录是需要跳转到别人的页面的，导致重定向很多，需要优化一下白屏时间，所以就用到了骨架屏，但是这次用的骨架屏不是自动生成的，还是自己敲的样式，一步步来吧，先从简单的用起。

先上效果图：

什么是骨架屏

骨架屏，英文 Skeleton screen ，是指在页面开始渲染之前的白屏时间内，先让用户看到即将要展现页面的“骨架”，页面渲染完成之后再将它替换掉，起到一个从 白屏 → 渲染完成 过程中的过渡作用，它可以有效减少用户的感知时间，让用户“感觉上”认为打开页面比较快（相比较于完整的白屏时间）。

实现

本文主要围绕一个开源的 Webpack 插件 vue-skeleton-webpack-plugin ，来实现在 Vue 项目中加入骨架屏。

由于项目对骨架屏的需求不同，相应的代码也会不一样。本文所实现的骨架屏是 基于 Vue-cli 3.x 搭建的项目 ，根据的不同路由，显示不同的骨架屏，如需其他用法详见开源插件。

让我们开始吧:surfer:。

首先是安装插件：

npm install vue-skeleton-webpack-plugin

vue.config.js

安装完成后在 vue.config.js 中做如下配置：

const SkeletonWebpackPlugin = require('vue-skeleton-webpack-plugin')
module.exports = {
 configureWebpack: (config) => {
  config.plugins.push(new SkeletonWebpackPlugin({
   webpackConfig: {
    entry: {
     app: path.join(__dirname, './src/skeleton/skeleton.js')
    }
   },
   // SPA 下是压缩注入 HTML 的 JS 代码
   minimize: true,
   // 服务端渲染时是否需要输出信息到控制台
   quiet: true,
   // 根据路由显示骨架屏
   router: {
     mode: 'history',
     routes: [
      {
       path: '/',
       skeletonId: 'skeleton-home'
      },
      {
       path: '/message',
       skeletonId: 'skeleton-message'
      }
     ]
   }
  }
 },
 css: {
  // 使用 css 分离插件 mini-css-extract-plugin，不然骨架屏组件里的 <style> 不起作用，
  extract: true,
 }
}

其中 skeleton.js 是我们骨架屏的入口，我们过会再创建。先看来一下其中 router 这个配置项。

router的配置决定了我们各个路由路径所对应的骨架屏。

router.mode 填路由模式，两个值可选 history | hash.
router.routes 填路由数组，其中 path 对应着页面在 vue-router 中的 path ， skeletonId 是骨架屏的 id ，后面马上会说明。

skeleton.js

配置完成后，新建一个骨架屏的入口 skeleton.js。

// src/skeleton/skeleton.js
import Vue from 'vue'

// 引入的骨架屏组件
import skeletonHome from './skeleton/skeletonHome.vue'
import skeletonMessage from './skeleton/skeletonMessage.vue'

export default new Vue({
 components: {
  skeletonHome,
  skeletonMessage,
 },
 template: `
  <div>
   <skeletonHome id="skeleton-home" style="display:none"/>
   <skeletonMessage id="skeleton-message" style="display:none"/>
  </div>
 `
})

上面的代码中，引入的两个组件分别对应 首页（Home） 和 消息页（Message） 的骨架屏，其中组件的 id 对应之前在 vue.config.js 里 skeletonId 。

贴上其中一个骨架屏组件的代码：

// skeletonMessage.vue
<template>
 <div class="skeleton-block">
  <div class="sk-loanList-header-bg"></div>
  <s-messageItem/>
  <s-messageItem/>
  <s-messageItem/>
  <s-messageItem/>
 </div>
</template>

<script>
import messageItem from './components/s-messageListItem'
export default {
 name: 'skeletonMessage',
 components: {
  's-messageItem': messageItem
 }
}
</script>

<style scoped>
.skeleton-block {
 width:100%;
 height: 100vh;
}
.sk-loanList-header-bg {
 height:88px;
 background:#2954D0;
}
</style>

其实就是很普通的一个 Vue 组件，在组件里写自己想要的骨架屏的样式即可，可复用的地方还可以再分成组件。在路由里加上 skeletonMessage ，看一下效果：