如何优雅的设置UI库组件的属性?

UI库提供了很多组件,组件又带有很多属性,有一些常用属性我们可以记住并且手撸,但是有些不常用的属性,或者需要设置多个属性,这样的情况下写起来就麻烦了,有时候还要打开帮助文档看看属性是怎么设定的,需要设置什么样的属性值。
那么有没有优雅的方式来设置组件的各种属性呢?我做了一个在线小工具,可以方便的设置属性,并且可以实时看到效果。

演示地址

https://naturefw.gitee.io/nf-rollup-ui-controller/

源码

https://gitee.com/naturefw/nf-rollup-ui-controller

技术栈

  • vite:^2.6.4
  • vue3: ^3.2.16
  • element-plus: ^1.2.0-beta.3
  • @element-plus/icons: ^0.0.11

特点

  • 可以选择组件类型,文本、数字、日期、select、checkbox、radio、等等;
  • 根据选择的组件类型,设置对应的属性,按需设置,不显示“无效”属性;
  • 可以实时显示效果,设置属性后可以立即看到效果,方便调整属性;
  • 设置好的属性可以生成js的对象和模板代码,支持 json 格式;
  • 大部分属性值都可以通过鼠标点击的方式生成,少数的需要手敲;

工作量比较大、精力有限,目前仅支持 element-plus 的部分组件,理论上可以支持任何UI库,只是设置属性有点太繁琐了,需要时间进行学习、掌握和理解,把相关属性合在一起,还有调试演示代码等工作。
有没有感兴趣的小伙伴来帮帮忙?

实现思路

实现方法比较土,就是把需要的组件分个类,再把需要的属性分成两种:基础属性、扩展属性,然后就是力气活了,把各种属性整理出来即可。

基础 组件 分类.png

大类原则

主要是看内容,文本、日期、数字很明显的可以分别归类,选择和下拉都是选择类型的,分成两类主要是小分类比较多,分开更清晰一些。

小类原则

  • 按照UI库提供的组件
  • 按照功能,“原子”级别
  • 按照值的类型,比如数组和非数组。

范围类的组件,值的类型是数组,非范围型的组件,值的类型不是数组,在动态改变某属性值的时候,数组和非数组有的时候不能自动变更类型,导致代码出错。

这样就需要把范围类的和非范围类的分开,比如 select 的单选模式和多选模式,只是一个 “multiple” 属性的区别,但是这个属性不能在运行时修改,否则会报错,所以只好分成两个小类。

好吧,其实你不用关心这些。

举例

el-input 可以细分为多个小类:单行文本,多行文本,密码,URL,可选等。
为什么要细分呢?因为不同的小类需要的属性是不同的,细分一下可以缩小备选的属性范围,设置起来更清晰,否则像官网那样,各种属性都堆在一起,还得分辨一下是否是支持某个小类。

比如 “show-word-limit” 仅支持单行文本和多行文本,并不支持其他小类。如果我要设置一个密码组件的属性,那么就不需要显示 “show-word-limit”这个属性,否则看起来就会比较乱。

所以通过细分小类的方式显示需要的属性,避免混淆。

基础属性

表单里的组件共有的属性:

基础属性

基本上表单里的组件都需要这几个属性,所以拿出来作为基础属性,一起设置。
扩展属性按照分类分别设置。

文本类

  • 单行文本
单行文本
  • 可以选择的文本
有备选项的文本框
可选可填的文本框
  • 设置颜色
颜色

数字类

  • 数字
数字
  • 滑块
滑块
滑块
滑块效果
  • 评分
评分

其实最大值没有做限制,可以>5

评分颜色

日期类

  • 日期
日期
日期
  • 日期范围
设置日期范围
日期范围演示

选择类

  • 开关
设置开关
开关
  • 多选
设置多选
多选

下拉类

  • 单选下拉列表框
设置下拉列表框
下拉列表框

不一一列举了,感兴趣的小伙伴可以看在线演示。
https://naturefw.gitee.io/nf-rollup-ui-controller/

生成模板和代码

属性设置完毕之后,可以生成template模板代码,以及js里定义的对象,支持json格式。

  • 模板
<el-checkbox-group
  v-model="checkboxs"
  v-bind="itemProps"
>
  <el-checkbox
    v-for="item in itemProps.optionList"
    :key="'check' + columnId + item.value"
    :label="item.value"
    :disabled="item.disabled"
  >
    {{item.label}}
  </el-checkbox>
</el-checkbox-group>
  • js代码
const itemProps = reactive({
  colName: 'test',
  kind: 15,
  controlType: 152,
  colCount: 0,
  isClear: false,
  clearable: true,
  optionList: [
    {
      value: '1',
      label: '选项1',
      disabled: false
    },
    {
      value: '2',
      label: '选项2',
      disabled: false
    },
    {
      value: '3',
      label: '选项3',
      disabled: false
    },
    {
      value: '4',
      label: '选项4',
      disabled: false
    }
  ] 
})
  • json 格式
{
  "colName": "test",
  "kind": 15,
  "controlType": 152,
  "colCount": 0,
  "isClear": false,
  "clearable": true,
  "optionList": [
    {
      "value": "1",
      "label": "选项1",
      "disabled": false
    },
    {
      "value": "2",
      "label": "选项2",
      "disabled": false
    },
    {
      "value": "3",
      "label": "选项3",
      "disabled": false
    },
    {
      "value": "4",
      "label": "选项4",
      "disabled": false
    }
  ]
}

为啥要支持json呢?大家可以猜一猜。

时间仓促,可能有一点小bug,还有属性值是对象的情况,暂时还没有支持;属性是组件(比如图标)的情况,支持的也不理想。

已知的几个小问题:

  • 评分的小星星为啥显示不全?
    目前没找到原因。

  • 颜色值的返回类型为啥不变?
    类型好像不能在运行时修改,运行前设置类型是有效的。

  • 日期组件的“年周”类型,同时设置显示格式和返回格式,会出错。
    在线演示做了封装(不支持自定义格式),所以没出错,但是原生组件不支持两个属性一起设置,或者是我使用的方式不对。

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

推荐阅读更多精彩内容