[Vue Advanced] — Как добиться прозрачной передачи атрибутов компонентов?

Vue.js
[Vue Advanced] — Как добиться прозрачной передачи атрибутов компонентов?

Сцены

Много раз нам нужно основывать некоторыеUIФреймворк инкапсулирован дважды, вотElement UIНапример, инкапсулироватьInputКомпоненты выглядят так:

<!-- Input 组件 -->
<template>
  <div>
    <el-input v-model="myc"></el-input>
  </div>
</template>

В это время нам нужно убедиться, что снаружи можно установить напрямуюel-inputсвойства, такие какplaceholder,clearableПодождите, лучше быть прозрачным

установить напрямую

Первая реакция, которая приходит нам на ум, заключается в том, чтоpropsПередайте значение, а затем установите его одно за другим, как показано ниже:

<template>
  <div>
    <el-input v-model="myc"
      :placeholder="configProps.placeholder"
      :clearable="configProps.clearable"></el-input>
  </div>
</template>

Вышеперечисленное передается вprops——configProps, устанавливатьplaceholderиclearable

Однако этот код плохо читается, неудобен в сопровождении, и еще есть недостающие моменты.

Прохождение через v-bind="$attrs"

На самом деле мы ничего не объявляем внутри компонентаpropПри вызове компонента с передачей соответствующих атрибутов атрибуты будут напрямую переданы корневому узлу следующим образом:

<!-- Input 组件 -->
<template>
  <div class="hello input-con">
    <label>输入框:</label>
    <el-input ></el-input>
  </div>
</template>
<script>
export default {
  name: 'Input'
}
</script>

вызвать вышеуказанный компонент

<Input placeholder="我是默认值"
        :clearable="true"/> 

Итак, как я могу передать атрибут внутреннемуel-inputкомпонент, непосредственно кel-inputдобавить однуv-bind="$attrs"Вот и все.

Посмотрите на официальномvm.$attrsОпределение:

Содержит привязки атрибутов (кроме класса и стиля), которые не распознаются (и не получаются) как реквизиты в родительской области. Когда компонент не объявляет никаких реквизитов, все привязки родительской области (кроме класса и стиля) включаются сюда и могут быть переданы внутренним компонентам через v-bind="$attrs" - очень полезно при создании высокоуровневых компонентов.

Народный язык: при вызове компонента передайте свойства (classиstyleкроме), а не внутри компонентаpropsобъявлено вv-bind="$attrs"Передайте внутренний компонент этого компонента

Например, приведенный выше вызовInputкомпонент при передачеplaceholder,clearable,ПотомInputВнутри компонента нет объявленияplaceholder,clearableполучить эти дваprops, на этот раз черезv-bind="$attrs"Пропустить внутренние компонентыel-inputсередина

Конкретный пример кода выглядит следующим образом

<template>
  <div>
    <el-input v-bind="$attrs" ></el-input>
  </div>
</template>

Видимые результаты следующие:

Полный пример кода находится вcodesandboxВ, вы можете посмотреть его онлайн-простой v-bind="$attrs", предлагаю попробовать самому

Как прозрачно передавать динамические компоненты

Хотя вышеперечисленное может решить большинство проблем, но мои коллеги обнаружили, что это не может удовлетворить сцену, в основном потому, что он использует динамические компоненты.component. Его идея черезJSON Schemaформа с применением динамических компонентовcomponent, это отличная идея, я считаю, что многие компании должны иметь подобную практику сейчас.

Давайте посмотрим на его идею реализации:

<!-- 动态组件,根据 JSON 配置 调用 Input 或者 Select 组件等等 -->
<template>
  <div class="hello">
    <div v-for="(config, index) in configJsonArr" :key="config.type + index">
      <!-- 动态组件,根据配置中的 Type 来决定调用的是 Input 还是 Select -->
      <component :is="config.type" :configProps="config.props"></component>
    </div>
  </div>
</template>

<script>
import Input from './Input'
import Select from './Select'

export default {
  name: 'Config',
  components: {
    Input,
    Select
  },
  props: {
  	// 动态组件 JSON schema 的配置
    configJsonArr: {
      type: Array,
      required: true,
      default: () => []
    }
  }
}
</script>

вconfigJsonArrследующее:

[{
  type: 'Input',
  props: {
    placeholder: '我是默认值',
    clearable: true
  }
}, {
  type: 'Select',
  props: {
    placeholder: '我是默认值'
  }
}, {
  type: 'Input',
  props: {
    placeholder: '我是默认值',
    suffixIcon: 'el-icon-delete'
  }
}]

вInputКомпоненты выглядят так:

<template>
  <div class="hello input-con">
    <label>输入框:</label>
    <el-input ></el-input>
  </div>
</template>

<script>
export default {
  name: 'Input'
}
</script>

В это время, если мы непосредственноel-inputнастраиватьv-bind="$attrs"Нет, причина в свойствах, передаваемых динамическими компонентамиconfigPropsявляется объектом, а не деструктурированным свойством объекта, так что же делать?

Мы можем использовать функции рендеринга!

Функции рендеринга творят чудеса

Стыдно сказать, функции рендеринга раньше редко использовались(render), после того, как я пришел в новую компанию, я обнаружил, что она довольно часто используется здесь (все потрясающие), и я также изучил ее сам.

Как упоминалось выше, нет возможности деконструировать атрибуты в тегах и при рендеринге (render) функция может быть решена, сначала давайте получим общее представление о функции рендеринга, здесь в основном для справкиофициальная документация

Первый параметр в функции рендерингаcreateElement, который принимает следующие параметры (обратите внимание на первый и второй параметры):

Первый параметр может бытьHTMLимя тега, объект опций компонента илиresolveодин из вышеперечисленныхasyncфункция. Необходимые. Здесь мы монтируем нашуInputкомпоненты и т.д.

// @returns {VNode}
createElement(
  // {String | Object | Function}
  // 一个 HTML 标签名、组件选项对象,或者
  // resolve 了上述任何一种的一个 async 函数。必填项。
  'div',

  // {Object}
  // 一个与模板中 attribute 对应的数据对象。可选。
  {
    // (详情见下一节)
  },

  // {String | Array}
  // 子级虚拟节点 (VNodes),由 `createElement()` 构建而成,
  // 也可以使用字符串来生成“文本虚拟节点”。可选。
  [
    '先写一些文字',
    createElement('h1', '一则头条'),
    createElement(MyComponent, {
      props: {
        someProp: 'foobar'
      }
    })
  ]
)

Давайте снова сосредоточимся на втором параметреObject, мы можем использовать этоObjectУкажите соответствующее значение атрибута вclass,style,attrs(нормальныйHTML attribute), компонентыprops[Это значение атрибута, на котором мы сосредоточимся в этом выпуске].... детали следующим образом:

{
  // 与 `v-bind:class` 的 API 相同,
  // 接受一个字符串、对象或字符串和对象组成的数组
  'class': {
    foo: true,
    bar: false
  },
  // 与 `v-bind:style` 的 API 相同,
  // 接受一个字符串、对象,或对象组成的数组
  style: {
    color: 'red',
    fontSize: '14px'
  },
  // 普通的 HTML attribute
  attrs: {
    id: 'foo'
  },
  // 组件 prop
  props: {
    myProp: 'bar'
  },
  // DOM property
  domProps: {
    innerHTML: 'baz'
  },
  // 事件监听器在 `on` 内,
  // 但不再支持如 `v-on:keyup.enter` 这样的修饰器。
  // 需要在处理函数中手动检查 keyCode。
  on: {
    click: this.clickHandler
  },
  // 仅用于组件,用于监听原生事件,而不是组件内部使用
  // `vm.$emit` 触发的事件。
  nativeOn: {
    click: this.nativeClickHandler
  },
  // 自定义指令。注意,你无法对 `binding` 中的 `oldValue`
  // 赋值,因为 Vue 已经自动为你进行了同步。
  directives: [
    {
      name: 'my-custom-directive',
      value: '2',
      expression: '1 + 1',
      arg: 'foo',
      modifiers: {
        bar: true
      }
    }
  ],
  // 作用域插槽的格式为
  // { name: props => VNode | Array<VNode> }
  scopedSlots: {
    default: props => createElement('span', props.text)
  },
  // 如果组件是其它组件的子组件,需为插槽指定名称
  slot: 'name-of-slot',
  // 其它特殊顶层 property
  key: 'myKey',
  ref: 'myRef',
  // 如果你在渲染函数中给多个元素都应用了相同的 ref 名,
  // 那么 `$refs.myRef` 会变成一个数组。
  refInFor: true
}

Как видите, мы можем установить в вышеуказанном объектеpropsКогда значение свойства уничтожено, этого достаточно.

Реализация основного кода выглядит следующим образом:

// 这其实就是一个组件
const CompFormItem = {
  components: {
    Input, Select
  },
  name: 'FormItem',
  props: {
  	// 传入配置
    configJson: {
      required: true
    }
  },
  // h 实际上就是 createElement 参数
  render (h) {
  	// 第一个参数就是配置中的 type,也就是我们的组件名称
    return h(`${this.configJson.type}`, {
      props: {
      	// 针对 props 进行解构
        ...this.configJson.props || {}
      },
      attrs: {
      	// 针对 attrs 进行解构
        ...this.configJson.props || {}
      }
    })
  }
}

по этому мыInputнаписать в компонентеv-bind="$attrs"просто хорошо

<template>
  <div class="hello input-con">
    <label>输入框:</label>
    <el-input v-bind="$attrs"></el-input>
  </div>
</template>

<script>
export default {
  name: 'Input'
}
</script>

заключительные замечания

Вышеупомянутая функция рендеринга может полностью решить проблему прозрачных атрибутов, я также поставил конкретныеcodesandboxбинго--Свойства передачи динамических компонентов. также предоставитьАдрес GitHub[Так сложно, должно быть нормально просить лайк? 】

На самом деле, я все еще думаю, а есть ли другой выход? Комментарии и предложения приветствуются

Рекомендуемые отличные статьи в прошлом