`vue3`+`ts`+`setup`语法糖实现一个无限嵌套的`tree`组件

今天用vue3+ts+setup语法糖实现一个无限嵌套的tree组件,先看一下实现的效果,样式没有做过多的修饰。

1

本篇文章是很基础的内容,本人主要也是刚接触vue3这一套。最近也开始练手将公司开发时的一些vue2的组件用vue3来实现一套,也希望看到的人能有所获。

Vue3的setup语法糖

vue3中的setup的加入,使得vue可以从Options API转变为Composition APIOptions API会导致data, methods, computed等必须分开到不同的对象中实现,使得逻辑过于分散。而Componsitions API可以将同一个功能写在setup中同一个代码块中,而不需要分开来写。有些同学可能觉得一个组件所有功能写在一起,会导致所有代码都在一坨,反而容易导致逻辑混乱,其实完全不必担心,vue3可以像react hook一样,把一段逻辑抽离,一个逻辑就是一个代码块,再在组件里面引入,这样逻辑清晰,同时方便复用,也取代了vue2mixin的写法。看下面这张图就明白了:

比较

setup语法糖中,我们不需要使用return返回响应式变量,函数,组件,只需要在组件顶层声明即可,然后可以在html模板中直接使用,看下面一段代码:

const {dataList, levelPadL, selectIds} = defineProps({
  // 数据源列表
  dataList: {
    type: Array as PropType<BaseOptons[]>,
    required: true
  },
  // 层级缩减,默认10px
  levelPadL: {
    type: Number,
    default: 10
  },
  // 已选中的id集合
  selectIds: {
    type: Array,
    default: []
  }
})

上面的dataList,levelPadL,selectIds三个props是不用再return的,我们是可以直接在模板中使用。另外setup语法糖和setup勾子函数的区别是不能接受propscontext参数,但是多了一些全局变量,这里主要用到defineProps,defineEmits。前者用来声明组件需要接受的props,后者用来接受来自父组件的事件,这里我们的tree组件需要接受一个更新选中的事件,这里的想法是能实现props的双向绑定,所以props selectIds采用了vue3的新语法v-model:selectIds来实现的,看下面的代码:

const emits = defineEmits(['update:selectIds'])
// some change 
emits('update:selectIds', selectIds)

Ts的运用及Vue3中的ts

首先我们为了props能有类型提醒,我们需要定义我们的props类型,这里主要是tree组件接受到的一个dataList的类型,是一个无限嵌套的的数组:

export interface BaseOptions {
    label: string,
    value: string | number,
    children?: BaseOptions[]
}
// 引用该类型并使用
const dataList = reactive<BaseOptions[]>([{
  label: '周一不开心',
  value: '1',
  children: [
    {label: '不开心1', value: '1-1', children: [{label: '不开心1-1', value: '1-1-1'}]},
    {label: '不开心2', value: '1-2', children: [{label: '不开心2-1', value: '1-2-1'}]},
    {label: '开心3', value: '1-3', children: [{label: '开心1-3-1', value: '1-3-1', children: [{label: '开心1-3-2', value: '1-3-2'}]}]}
  ]
}])
// 接受该类型props并标记类型
defineProps({
  // 数据源列表
  dataList: {
    type: Array as PropType<BaseOptions[]>,
    required: true
  }
})

可以看到,vue3中定义reactive中需要使用ts的泛型才能标记类型。而如果props的类型如果采用运行时声明的方式,当props的类型为Object或者Array时,则需要使用Array as PropType<BaseOptions[]>来标记类型,相比常规ts的用法,还是麻烦不少。

组件其他部件

组件使用到了一个双向绑定的props selectIds,与vue2相比略有区别:v-model:selectIds="selectIds",这样可以更灵活一些。子组件修改该props同样是通过emits(update:propsName)

模板部分
<ul class="treeList" :style="{'padding-left': `${levelPadL}px`}">
    <li v-for="item in dataList" class="item" :key="item.value" :class="{'hasChild': item?.children?.length}">
      <div class="label" :class="{'is-open': isOpen(item.value)}" @click="toggleItem(item)">
        <span>{{item.label}}</span>
        <span class="icon" v-if="item?.children?.length"></span>
      </div>
      <collapseTransition>
        <template v-if="isOpen(item.value)">
          <treeList v-bind="$props" :data-list="item.children"></treeList>
        </template>
      </collapseTransition>
    </li>
  </ul>

可以看到vue3的模板中,终于可以使用.?可选链新语法了,实在太爽了,不会因为对象或数组的空指针导致整个dom不渲染了。collapseTransition动画组件是基于vue2实现了,看来是完全兼容的。

组件方法
// 展开收起方法
const toggleItem = (item: BaseOptions) => {
  const {value, children = []} = item
  if (children.length) {
    const findIndex = selectIds.findIndex(id => value === id)
    if (findIndex > -1) {
      selectIds.splice(findIndex, 1)
    } else {
      selectIds.push(value)
    }
    emits('update:selectIds', selectIds)
  }
}

// 判断是否展开
const isOpen = (id: Number | String) => {
  return !!selectIds.find(item => id === item)
}

总结

整个组件还是蛮简单的,也是我们常常要用到的,这里主要是基于vue3+setup+TS来实现熟悉一下语法和新特性,大家也可以用来练练手,体验体验vue3,看它是否是真香,卷起来吧!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容