前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >扩展 Vue 组件

扩展 Vue 组件

作者头像
疯狂的技术宅
发布2019-03-28 10:31:19
1.7K0
发布2019-03-28 10:31:19
举报
文章被收录于专栏:京程一灯京程一灯

你是否在开发基于 Vue 的 app 时使用过具有相同属性甚至具有相同的 template 结构的组件?

这时,创建一个具有通用属性和 HTML 结构的 “基组件” 并以此扩展并创建出其 “子组件” 是一种比较好的做法。这种结构可以帮助你在你的代码中应用 DRY 原则(Don’t Repeat Yourself)并增强代码的可读性同时减少 bug 的产生。

Vue 提供了实现组件继承的功能,但你也需要为你的子组件添加一些特有的属性。

示例: 调查问卷

这里有一个使用 Vue.js 制作的调查问卷:

你可以很明显地注意到每一个问题都有一个与之相关的 input 类型:

  1. 文本输入
  2. 下拉选择
  3. 单选按钮

良好的工程结构应该将这些问题(不同的 input 类型)构建成不同的可复用的组件,根据上面的类型我给他们起了对应的名字:

  1. SurveyInputText
  2. SurveyInputSelect
  3. SurveyInputRadio

每一种问题或者说 input 类型对应一个不同的组件是有道理的,因为它们都需要有自己的专属标记(例如:vs) 并且它们都拥有特定的 props 属性, methods 属性等等... 然而,这些组件又有很多相同的地方:

  • 他们都有一个与之对应的问题
  • 他们都需要表单验证
  • 他们都需要错误状态的提示

等等。所以我认为这是扩展组件的一个最好的应用例子。

基组件

每一个子组件都会继承一个名为SurveyInputBase的单文件根组件,注意一下几点:

  • question 这个 prop 属性是每个扩展组件都通用的属性,我们也应该添加更多的通用属性,但是针对目前这个简单的例子,我们先只专注这一个属性。
  • 我们需要想办法把这个属性复制到任何从基组件扩展的组件上。
  • 我们需要想办法将不同输入表单的 HTML 结构插入到 template 标签之中。
代码语言:javascript
复制
<template>
  <div class="survey-base">
    <h4>{{ question }}</h4>
    <!--the appropriate input should go here-->
  </div>
</template>
<script>
  export default {
    props: [ 'question' ],
  }
</script>

继承组件选项

暂时先忘掉 template 标签吧,我们如何让每个子组件都继承基组件的 props 属性呢?每一个子组件既需要question这个 prop 属性,同时也要拥有自己私有的 props 属性:

我们可以通过引入这个基组件并且在子组件的extends选项里指向它来达到这个目的:

代码语言:javascript
复制
<template>
  <!--How to include the question here???-->
  <input :placeholder="placeholder">
</template>
<script>
  import SurveyInputBase from './SurveyInputBase.vue';
  export default {
    extends: SurveyInputBase,
    props: [ 'placeholder' ],
  }
</script>

打开 Vue Devtools, 我们可以看到通过 extends 选项子组件的确获得了来自基组件的 props 属性

合并策略

你可能会好奇,为什么子组件能继承 question 这个 prop 属性而不是覆盖它。实际上extends选项执行了一种合并策略,它会确保合并正确地执行。比如,如果 props 属性拥有不同的属性名, 很明显他们都会被包含在内,但是如果他们拥有相同的属性名, Vue 只会保留子组件的响应属性。

这个合并策略同样应用于其他选项,比如 methods, 计算属性以及生命周期钩子。 更多关于合并策略的内容可查看 vue 官方文档 不过如果你有需要,也可以制定自己的合并策略。

注意: 另外一种方式在组件里使用 mixin 属性。对于这个例子,我更倾向于使用 extends, 尽管如此,两种方式使用的合并策略有轻微的不同,使用extends使得组件自身的选项会比要扩展的基组件具有更高的优先级。

扩展模板

扩展组件的选项看起来很简单 — 那么模板(template)呢?

之前的合并策略并不适用于template选项. 我们要么完全继承自基组件, 要么重新定义template选项并覆盖它,那我们如何合并它呢?

我的解决方式是使用 Pug 预处理器. 它带有includeextends选项,所以它似乎很适合这种设计模式

基组件

首先,让我们把基组件的 template 转换成 Pug 的语法:

代码语言:javascript
复制
<template lang="pug">
  div.survey-base
    h4
    block input
</template>

注意以下几点:

  • 我们添加 lang="pug"到 template 标签是为了让 vue-loader 使用 pug 语法来处理我们的模板 (所以, 不要忘记添加 Pug 模块到你的工程目录,使用 npm i --save-dev pug 命令)
  • 我们使用 block input 来声明一个子组件可以扩展的块

所以这里就是比较麻烦的地方, 如果我们想要子组件去扩展这个模板,我们需要把它放进一个单独的文件里。

代码语言:javascript
复制
div.survey-base
  h4 {{ question }}
  block input

然后我们使用 include 引入这个文件,然后我们的基组件仍然是一个独立可用的组件。

代码语言:javascript
复制
<template lang="pug">
  include SurveyInputBase.pug
</template>
<script>
  export default {
    props: [ 'question' ]
  }
</script>

有点遗憾的是,这么做似乎违背了单文件组件的设定, 但是对于我们的例子,我认为是值得的. 或许你可以自定一个 webpack loader 来避免这个情况。

子组件

现在让我们来转换子组件的 template 为 Pug 语法:

代码语言:javascript
复制
<template lang="pug">
  extends SurveyInputBase.pug
  block input
    input(type="text" :placeholder="placeholder")
</template>
<script>
  import SurveyInputBase from './SurveyInputBase.vue';
  export default {
    extends: SurveyInputBase,
    props: [ 'placeholder' ],
  }
</script>

子组件使用了 Pug 的 extends 特性,因而包含了基组件的模板并且在input块中输出任何自定义模板结构 (类似于slots).

这是子组件有效地扩展了基组件并转化为常规的 HTML 后的样子:

代码语言:javascript
复制
<div class="survey-base">
  <h4>{{ question }}</h4>
  <input type="text" :placeholder="placeholder">
</div>

总结

运用上述策略我们可以构建出另外拥有私有属性和响应 HTML 结构的两个子组件 SurveyInputSelectSurveyInputRadio

如果之后我们在项目的主模板里引用它们:

代码语言:javascript
复制
<survey-input-text
  question="1. What is your name?"
  placeholder="e.g. John Smith"
></survey-input-text>

<survey-input-select
  question="2. What is your favorite UI framework?"
  :options="['React', 'Vue.js', 'Angular']"
></survey-input-select>

<survey-input-radio
  question="3. What backend do you use?"
  :options="['Node.js', 'Laravel', 'Ruby']"
  name="backend"
>
</survey-input-radio>

最终会被渲染成:

代码语言:javascript
复制
<div class="survey-base">
  <h4>1. What is your name?</h4>
  <input type="text" placeholder="e.g. John Smith">
</div>
<div class="survey-base">
  <h4>2. What is your favorite UI framework?</h4>
  <select>
    <option>React</option>
    <option>Vue.js</option>
    <option>Angular</option>
  </select>
</div>
<div class="survey-base">
  <h4>3. What backend do you use?</h4>
  <div><input type="radio" name="backend" value="Node.js">Node.js</div>
  <div><input type="radio" name="backend" value="Laravel">Laravel</div>
  <div><input type="radio" name="backend" value="Ruby">Ruby</div>
</div>

注意: 我们也可以用 SurveyInputBase 组件来示范, 因为它也可以独立运行, 但是在这个例子中是没有必要的。我认为这是要说明的重要的一点。

来源:http://www.zcfy.cc/article/extending-vuejs-components-vue-js-developers-medium-3974.html

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2017-08-17,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 京程一灯 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 示例: 调查问卷
  • 基组件
  • 继承组件选项
  • 合并策略
  • 扩展模板
  • 基组件
  • 子组件
  • 总结
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档