学习笔记——自定义指令

介绍

对于之前的指令，如：v-html、v-model、v-for、……这些指令都是内置指令，是Vue内部提供好的指令，每个指令有着自己各自独立的功能。
与内置指令不同，我们自己封装的指令称为自定义指令。可以封装一些dom操作，扩展额外功能。

好处

在之前要使页面加载时，让元素获得焦点需要操作dom，即dom元素.focus

mounted () {
  this.$refs.inp.focus()
}

而这样，只能在当前页面中使用mounted，当另一个页面中也需要实现获得焦点的功能时，则需要再写一遍这段代码，比较繁琐。而自定义指令就很好解决了这个问题。

语法

全局注册语法

Vue.directive('指令名', {
    "inserted" (el) {
        // 可以对el标签，扩展额外功能
        el.focus()
    }
}

其中，inserted是指令生命周期钩子，表示当前指令所绑定的元素被添加到页面时，会自动调用。

形参el可以拿到指令绑定的元素，如在输入框中使用该指令，则el就是输入框元素。通过el.fous()就可以实现获得焦点功能。

局部注册语法

directives: {
  "指令名": {
    inserted () {
      // 可以对el标签，扩展额外功能
      el.focus()
    }
  }
}

注意

注在使用指令的时候，一定要先注册，再使用，否则会报错使用指令语法： v-指令名。如：<input type="text" v-focus/>
注册指令时不用加v-前缀，但使用时一定要加v-前缀

使用

<input v-指令名 type="text">

只要指令绑定了元素，那么当输入框被插入到页面中时，则会自动执行inserted钩子，即获得焦点。

示例代码

main.js 全局注册，所有组件可用

import Vue from 'vue'
import App from './App.vue'

Vue.config.productionTip = false

// 1.全局注册指令(所有组件都可以使用)
Vue.directive('focus', {
  // inserted会在指令所在元素插入到 DOM 中时调用
  // el为指令所绑定的元素
  inserted (el) {
    // 聚焦元素
    el.focus()
  }
})

new Vue({
  render: h => h(App),
}).$mount('#app')

APP.vue 局部注册，只有当前组件可用

<template>
  <div>
    <h1>自定义指令</h1>
    <input v-focus ref="inp" type="text">
    </div>
</template>

<script>


  export default {
    // mounted () {
    //   this.$refs.inp.focus()
    // }

    // 2.局部注册指令(当前组件内部使用)
    directives: {
      // 指令名: 指令配置项
      focus: {
        inserted (el) {
          el.focus()
        }
      }
    }
  }
</script>

<style>

</style>

指令的值

场景

假设我们有这样一个需求：实现一个color指令，当传入不同的颜色时，给标签设置对应的文字颜色。这时候，就需要用到自定义指令的值了。

语法

1.在绑定指令时，可以通过"等号"的形式为指令绑定具体的参数值。

<div v-color="color">我是内容</div>

2.通过 binding.value 可以拿到指令值，指令值修改会 触发 update 函数.

directives: {
  color: {
    inserted (el, binding) {
      el.style.color = binding.value
    },
    update (el, binding) {
      el.style.color = binding.value
    }
  }
}

binding是额外的配置项，它通过.value可以拿到指令值，这里通过el.style.color = binding.value将指令值（即传入的颜色）赋值给样式的颜色属性。

示例代码

<template>
  <div>
     <!--显示红色--> 
    <h2 v-color="color1">指令的值1测试</h2>
     <!--显示蓝色--> 
    <h2 v-color="color2">指令的值2测试</h2>
     <button @click="changeColory">
        改变第一个h2的颜色
    </button>
  </div>
</template>

<script>
export default {
  data () {
    return {
      color1: 'red',
      color2: 'blue'
    }
  },
  // 局部注册自定义指令
  directives: {
    color: {
      // 1.inserted提供的是元素被添加到页面中时的逻辑
      inserted (el, binding) {
        //binding.value 就是指令的值
        el.style.color = binding.value
      },
      // 2.update提供的是元素更新时的逻辑，指令的值修改时触发
      update (el, binding) {
        el.style.color = binding.value
      }
    }
  },
  methods: {
    changeColor() {
      this.color1 = 'green'; // 改变第一个h2的颜色为绿色
    }
  }
}
</script>

<style>

</style>

v-loading指令封装

用来控制加载中的效果。

场景

实际开发过程中，发送请求需要事件，在请求的数据未回来时，也就是加载时，页面会处于空白状态，使得用户体验非常不好。这时，我们就需要封装一个v-loading指令，实现加载中的效果。

分析

1.本质上loading效果就是一个蒙层，盖在了盒子上
2.数据请求中，开启loading状态，添加蒙层
3.数据请求完毕，关闭loading状态，移除蒙层

实现

1.准备一个 loading类，通过伪元素定位，设置宽高，实现蒙层0.
2.开启关闭 loading状态（添加移除蒙层），本质只需要添加移除类即可
3.结合自定义指令的语法进行封装复用

.loading:before {
  content: "";
  position: absolute;
  left: 0;
  top: 0;
  width: 100%;
  height: 100%;
  background: #fff url("./loading.gif") no-repeat center;
}

示例代码

<template>
  <div class="main">
    <div class="box" v-loading="isLoading">
      <ul>
        <li v-for="item in list" :key="item.id" class="news">
          <div class="left">
            <div class="title">{{ item.title }}</div>
            <div class="info">
              <span>{{ item.source }}</span>
              <span>{{ item.time }}</span>
            </div>
          </div>

          <div class="right">
            <img :src="item.img" alt="">
          </div>
        </li>
      </ul>
    </div> 

    <div class="box2" v-loading="isLoading2"></div>
  </div>
</template>

<script>
// 安装axios =>  yarn add axios || npm i axios
import axios from 'axios'

// 接口地址：http://hmajax.itheima.net/api/news
// 请求方式：get
export default {
  data () {
    return {
      list: [],
      isLoading: true,
      isLoading2: true
    }
  },
  async created () {
    // 1. 发送请求获取数据
    const res = await axios.get('http://hmajax.itheima.net/api/news')
    
    setTimeout(() => {
      // 2. 更新到 list 中，用于页面渲染 v-for
      this.list = res.data.data
      this.$nextTick(() => {
        this.isLoading = false;
      });
    }, 2000)
  },
  directives: {
    loading: {
      inserted (el, binding) {
        // 根据指令值判断台添加和移除蒙层，设置默认状态
        binding.value ? el.classList.add('loading') : el.classList.remove('loading')
      },
      updated (el, binding) {
        // 根据指令值判断台添加和移除蒙层，更新默认状态
        binding.value ? el.classList.add('loading') : el.classList.remove('loading')
      }
    }
  }
}
</script>

<style>
  // 准备类名loading，通过为元素提供遮罩层
.loading:before {
  content: '';
  position: absolute;
  left: 0;
  top: 0;
  width: 100%;
  height: 100%;
  background: #fff url('./loading.gif') no-repeat center;
}

.box2 {
  width: 400px;
  height: 400px;
  border: 2px solid #000;
  position: relative;
}



.box {
  width: 800px;
  min-height: 500px;
  border: 3px solid orange;
  border-radius: 5px;
  position: relative;
}
.news {
  display: flex;
  height: 120px;
  width: 600px;
  margin: 0 auto;
  padding: 20px 0;
  cursor: pointer;
}
.news .left {
  flex: 1;
  display: flex;
  flex-direction: column;
  justify-content: space-between;
  padding-right: 10px;
}
.news .left .title {
  font-size: 20px;
}
.news .left .info {
  color: #999999;
}
.news .left .info span {
  margin-right: 20px;
}
.news .right {
  width: 160px;
  height: 120px;
}
.news .right img {
  width: 100%;
  height: 100%;
  object-fit: cover;
}
</style>