Slots Emit和Props穿透组件封装实现摸鱼加钟

目录

• 背景
• ‍准备工作
• Slots穿透方案-单子组件
• Slots穿透方案-多子组件
• Props和Emit穿透方案-单子组件
• Props和Emit穿透方案-多子组件
• 最后

背景

组内多人共同开发时免不了基于某UI库二次封装组件来适应项目业务场景的情况，但不知道大家有没有遇到过需要兼容部分或者穿透子组件全部Props或者Slots的情况，这种时候如果针对每一个Props或者Slots去单独处理穿透不仅费时费力而且代码会越来越臃肿难以维护，所以想在这里通过一个简单的例子来对比一下Slots、Props、Emit的各种穿透方案

‍准备工作

首先新建我们需要用到的子组件，如下

Card.vue

...css部分略过

再来准备一个Button.vue

以及我们需要实现的ProCard.vue

Slots穿透方案-单子组件

使用Vue提供的Dynamic directive arguments结合v-slot指令 Dynamic directive arguments部分文档链接 在单子组件的情况下穿透Slot比较简单，不需要考虑太多的Slot覆盖问题，只需要关注封装组件自身Slot命名即可，如有命名重复情况可参考多子组件方案解决，比如下面这个ProCard.vue，只用到了Card组件

使用

效果

Slots穿透方案-多子组件

通常我们封装业务组件时一般不至于一个子组件，但多个子组件的情况下就要特别注意Slot命名情况了，这边分享一个在平时开发时我们选择的一个方案：使用不同前缀来区分不同slot，props也是同理。在ProCard.vue中我们加入一个Button组件，协商约定c-xxx为Card组件Slot，b-xxx为Button组件Slot，这样在经过分解之后就可以区分出应该往哪个组件穿透Slot了。

在ProCard.vue中取的所有slots并且理好各个组件所需slots

// 首先还是取到所有Slots的key
const slots = Object.keys(useSlots())
// 定义一个buttonSlots，用来组装需要用到的Button组件的slots
const buttonSlots = ref([])
// 定义一个cardSlots，用来组装需要用到的Card组件的slots
const cardSlots = ref([])
// 找出各自组件需要的slot组装好push进去就可以在template中穿透到指定组件了
for (let slotIndex = 0; slotIndex < slots.length; slotIndex++) {
	const slotKey = slots[slotIndex];
	if (slotKey.indexOf('c-') > -1) {
		cardSlots.value.push(slotKey.slice(2, slotKey.length))
		continue
	}
	if (slotKey.indexOf('b-') > -1) {
		buttonSlots.value.push(slotKey.slice(2, slotKey.length))
	}
}

接下来就可以在template中直接使用了

引入一下ProCard组件来看一下效果吧

成功实现了多组件Slots穿透

Props和Emit穿透方案-单子组件

Props和Emit的穿透方式与Slots的方案类似，使用v-bind直接绑定组件Attributes是最方便的穿透方式，但缺点也很明细，直接v-bind所有Attributes可能会导致命名重复所带来的各种连锁问题，如果像上文slots一样通过前缀来区分组装又有点繁琐，所以如果是多子组件的情况下推荐使用下面的props+v-bind方案。

单子组件这边在ProCard中使用useAttrs来得到子组件上所有的attributes，再使用v-bind直接转发到ProCard的子组件，这样就可以直接穿透Props和Emit了非常方便好用

// 获取到组件所有的attributes
const attrs = useAttrs()

template中转发到子组件

父组件调用ProCard

看一下实际效果

点击一下右上角关闭按钮

可以看到成功穿透了Emit和Props并且被子组件给执行了

Props和Emit穿透方案-多子组件

多子组件的情况下Props和Emit穿透的解决方案也很多，比如和Slots一样采用前缀的方式来分别组装，但是这种方式较为繁琐，这里比较推荐使用Props分组的方案，在传入的时候就直接把

ProCard

interface ProCardProps {
	title: String
	cardProps: Object // 新增cardProps，用来转发外部传入用于card组件的props
        buttonProps: Object // 新增buttonProps，用来转发外部传入用于button组件的props
}
// 获取到组件所有的attributes
const attrs = useAttrs()
const props = defineProps()
// 在template中使用如下，注意替换Card组件和Button组件的v-bind为各自需要接收的props

使用方法如下

点击Card组件关闭图标再单机Button组件之后效果如下

可以看到传入的cardProps和buttonProps都起到了预期的效果

最后

希望本文可以让你有所收获，这是我在掘金写的第一篇文章，希望可以帮助到大家。Slots、Emit、Props穿透的方案有很多，本文介绍的是我在项目中实际使用到的几种方法，尤其是在重度依赖第三方UI组件库的的情况下特别适用，既能很好的兼顾三方组件库的原生Api，也能在此基础上进行增量扩展。

最后，XDM！给摸鱼的时间加钟吧！

更多关于Slots Emit Props穿透组件封装的资料请关注脚本之家其它相关文章！