@vtj/materials 0.9.6 → 0.9.7

package/dist/deps/element-plus/zh-cn.js

@@ -1,4 +1,4 @@
-/*! Element Plus v2.9.1 */
+/*! Element Plus v2.9.2 */
 
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vtj/materials",
   "private": false,
-  "version": "0.9.6",
+  "version": "0.9.7",
   "type": "module",
   "devDependencies": {
     "@vueuse/core": "~12.2.0",
@@ -11,11 +11,11 @@
     "vant": "~4.9.10",
     "vue": "~3.5.5",
     "vue-router": "~4.5.0",
-    "@vtj/utils": "~0.9.6",
-    "@vtj/charts": "~0.9.6",
-    "@vtj/cli": "~0.9.4",
-    "@vtj/core": "~0.9.6",
-    "@vtj/ui": "~0.9.6"
+    "@vtj/charts": "~0.9.7",
+    "@vtj/cli": "~0.9.5",
+    "@vtj/ui": "~0.9.7",
+    "@vtj/core": "~0.9.7",
+    "@vtj/utils": "~0.9.7"
   },
   "files": [
     "dist",

package/src/element/autodcomplete.ts

@@ -7,31 +7,35 @@ const Autodcomplete: MaterialDescription = {
   doc: 'https://element-plus.org/zh-CN/component/autocomplete.html',
   package: 'element-plus',
   props: [
+    {
+      name: 'modelValue',
+      defaultValue: '',
+      title: '选中项绑定值',
+      setters: 'StringSetter'
+    },
     {
       name: 'placeholder',
+      title: '占位文本',
       defaultValue: '',
-      setters: 'InputSetter'
+      setters: 'StringSetter'
     },
     {
       name: 'clearable',
+      title: '是否可清空',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
       name: 'disabled',
+      title: '自动补全组件是否被禁用',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
       name: 'valueKey',
+      title: '输入建议对象中用于显示的键名',
       defaultValue: 'value',
-      setters: 'InputSetter'
-    },
-    {
-      name: 'modelValue',
-      defaultValue: '',
-      title: '选中项绑定值',
-      setters: 'InputSetter'
+      setters: 'StringSetter'
     },
     {
       name: 'debounce',
@@ -58,54 +62,47 @@ const Autodcomplete: MaterialDescription = {
       name: 'fetchSuggestions',
       defaultValue: '',
       title: '获取输入建议的方法',
-      label: '建议方法',
-      setters: 'FunctionSetter'
-    },
-    {
-      name: 'popperClass',
-      defaultValue: '',
-      title: '下拉列表的类名',
-      setters: 'InputSetter'
+      setters: ['ArraySetter', 'FunctionSetter']
     },
     {
       name: 'triggerOnFocus',
       defaultValue: true,
       title: '是否在输入框focus时显示建议列表',
-      label: 'focus触发',
       setters: 'BooleanSetter'
     },
-    {
-      name: 'name',
-      defaultValue: '',
-      setters: 'InputSetter'
-    },
     {
       name: 'selectWhenUnmatched',
       defaultValue: false,
       title: '在输入没有任何匹配建议的情况下，按下回车是否触发select事件',
-      label: '回车触发',
       setters: 'BooleanSetter'
     },
     {
-      name: 'label',
+      name: 'name',
+      title: '等价于原生 input name 属性',
+      defaultValue: '',
+      setters: 'StringSetter'
+    },
+    {
+      name: 'aria-label',
       defaultValue: '',
-      title: '标签文本',
-      setters: 'InputSetter'
+      title: '原生 aria-label属性',
+      setters: 'StringSetter'
     },
     {
       name: 'hideLoading',
+      title: '是否隐藏远程加载时的加载图标',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
-      name: 'popperAppendToBody',
-      defaultValue: false,
-      title: '是否将下拉列表插入至body元素',
-      label: '下拉列表',
-      setters: 'BooleanSetter'
+      name: 'popperClass',
+      defaultValue: '',
+      title: '下拉列表的类名',
+      setters: 'StringSetter'
     },
     {
       name: 'teleported',
+      title: '是否将下拉列表元素插入 append-to 指向的元素下',
       defaultValue: true,
       setters: 'BooleanSetter'
     },
@@ -113,14 +110,18 @@ const Autodcomplete: MaterialDescription = {
       name: 'highlightFirstItem',
       defaultValue: false,
       title: '是否默认突出显示远程搜索建议中的第一项',
-      label: '高亮第一项',
       setters: 'BooleanSetter'
     },
     {
       name: 'fit-input-width',
       defaultValue: false,
       title: '下拉框是否与输入框同宽',
-      label: '适配宽度',
+      setters: 'BooleanSetter'
+    },
+    {
+      name: 'popperAppendToBody',
+      defaultValue: false,
+      title: '是否将下拉列表插入至body元素',
       setters: 'BooleanSetter'
     }
   ],

package/src/element/cascader.ts

@@ -11,17 +11,19 @@ const Cascader: MaterialDescription[] = [
     props: [
       {
         name: 'modelValue',
-        setters: 'JSONSetter'
+        title: '选中项绑定值',
+        setters: ['StringSetter', 'NumberSetter', 'ObjectSetter']
       },
       {
         name: 'options',
+        title: '选项的数据源， value 和 label 可以通过 CascaderProps 自定义',
         defaultValue: [],
-        setters: 'JSONSetter'
+        setters: ['ArraySetter', 'JSONSetter']
       },
       {
         name: 'props',
-        defaultValue: '',
-        setters: 'JSONSetter'
+        title: '配置选项',
+        setters: ['ObjectSetter', 'JSONSetter']
       },
       {
         name: 'size',
@@ -32,16 +34,18 @@ const Cascader: MaterialDescription[] = [
       },
       {
         name: 'placeholder',
-        defaultValue: 'Select',
-        setters: 'InputSetter'
+        title: '输入框占位文本',
+        setters: 'StringSetter'
       },
       {
         name: 'disabled',
+        title: '是否禁用',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'clearable',
+        title: '是否支持清空选项',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
@@ -49,11 +53,11 @@ const Cascader: MaterialDescription[] = [
         name: 'showAllLevels',
         defaultValue: true,
         title: '输入框中是否显示选中值的完整路径',
-        label: '完整路径',
         setters: 'BooleanSetter'
       },
       {
         name: 'collapseTags',
+        title: '多选模式下是否折叠Tag',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
@@ -62,64 +66,133 @@ const Cascader: MaterialDescription[] = [
         defaultValue: false,
         title:
           '当鼠标悬停于折叠标签的文本时，是否显示所有选中的标签。 要使用此属性，collapseTags属性必须设定为 true',
-        label: '显示所有',
         setters: 'BooleanSetter'
       },
       {
         name: 'separator',
+        title: '用于分隔选项的字符',
         defaultValue: '/',
-        setters: 'InputSetter'
+        setters: 'StringSetter'
       },
       {
         name: 'filterable',
+        title: '该选项是否可以被搜索',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'filterMethod',
+        title:
+          '自定义搜索逻辑，第一个参数是node，第二个参数是keyword，返回的布尔值表示是否保留该选项',
         defaultValue: '',
-        setters: 'ExpressionSetter'
+        setters: ['FunctionSetter', 'ExpressionSetter']
       },
       {
         name: 'debounce',
+        title: '搜索关键词正在输入时的去抖延迟，单位为毫秒',
         defaultValue: 300,
         setters: 'NumberSetter'
       },
       {
         name: 'beforeFilter',
+        title:
+          '过滤函数调用前，所要调用的钩子函数，该函数接收要过滤的值作为参数。 如果该函数的返回值是 false 或者是一个被拒绝的 Promise，那么接下来的过滤逻辑便不会执行',
         defaultValue: '',
-        setters: 'ExpressionSetter'
+        setters: ['FunctionSetter', 'ExpressionSetter']
       },
       {
         name: 'popperClass',
+        title: '弹出内容的自定义类名',
         defaultValue: '',
-        setters: 'InputSetter'
+        setters: 'StringSetter'
       },
       {
         name: 'teleported',
+        title: '弹层是否使用 teleport',
         defaultValue: true,
         setters: 'BooleanSetter'
       },
-      {
-        name: 'popperAppendToBody',
-        defaultValue: true,
-        title:
-          '是否将弹出的内容直接插入到 body 元素。 在弹出内容的边框定位出现问题时，可将该属性设置为 false',
-        label: 'popperAppend',
-        setters: 'BooleanSetter'
-      },
       {
         name: 'tagType',
+        title: '标签类型',
         defaultValue: 'info',
         options: ['success', 'info', 'warning', 'danger'],
         setters: 'SelectSetter'
       },
+      {
+        name: 'tag-effect',
+        title: 'tag effect',
+        defaultValue: 'light',
+        options: ['light', 'dark', 'plain'],
+        setters: 'SelectSetter'
+      },
       {
         name: 'validateEvent',
+        title: '输入时是否触发表单的校验',
         defaultValue: true,
         setters: 'BooleanSetter'
       },
-      { name: 'maxCollapseTags', setters: 'NumberSetter', defaultValue: 1 }
+      {
+        name: 'maxCollapseTags',
+        title:
+          '需要显示的 Tag 的最大数量 只有当 collapse-tags 设置为 true 时才会生效。',
+        setters: 'NumberSetter',
+        defaultValue: 1
+      },
+      {
+        name: 'empty-values',
+        title: '组件的空值配置',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'value-on-clear',
+        title: '清空选项的值',
+        setters: [
+          'StringSetter',
+          'NumberSetter',
+          'BooleanSetter',
+          'ArraySetter'
+        ]
+      },
+      {
+        name: 'persistent',
+        title:
+          '当下拉框未被激活并且persistent设置为false，下拉框容器会被删除。',
+        defaultValue: true,
+        setters: 'BooleanSetter'
+      },
+      {
+        name: 'fallback-placements',
+        title: 'Tooltip 可用的 positions',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'placement',
+        title: '下拉框出现的位置',
+        defaultValue: 'bottom-start',
+        options: [
+          'top',
+          'top-start',
+          'top-end',
+          'bottom',
+          'bottom-start',
+          'bottom-end',
+          'left',
+          'left-start',
+          'left-end',
+          'right',
+          'right-start',
+          'right-end'
+        ],
+        setters: 'SelectSetter'
+      },
+      {
+        name: 'popperAppendToBody',
+        defaultValue: true,
+        title:
+          '是否将弹出的内容直接插入到 body 元素。 在弹出内容的边框定位出现问题时，可将该属性设置为 false',
+        setters: 'BooleanSetter'
+      }
     ],
     events: [
       {
@@ -134,6 +207,9 @@ const Cascader: MaterialDescription[] = [
       {
         name: 'focus'
       },
+      {
+        name: 'clear'
+      },
       {
         name: 'visible-change'
       },
@@ -169,16 +245,19 @@ const Cascader: MaterialDescription[] = [
     props: [
       {
         name: 'modelValue',
+        title: '选中项绑定值',
         defaultValue: '',
-        setters: 'JSONSetter'
+        setters: ['StringSetter', 'NumberSetter', 'JSONSetter']
       },
       {
         name: 'options',
+        title: '选项的数据源',
         defaultValue: '',
         setters: 'JSONSetter'
       },
       {
         name: 'props',
+        title: '配置选项',
         defaultValue: '',
         setters: 'JSONSetter'
       }
@@ -194,7 +273,7 @@ const Cascader: MaterialDescription[] = [
         name: 'close'
       }
     ],
-    slots: ['default'],
+    slots: ['default', 'empty'],
     snippet: {
       props: {
         options: mockTreeData(),

package/src/element/checkbox.ts

@@ -10,51 +10,51 @@ const Checkbox: MaterialDescription[] = [
     props: [
       {
         name: 'modelValue',
+        title: '选中项绑定值',
         defaultValue: '',
         setters: ['InputSetter', 'NumberSetter', 'BooleanSetter']
       },
       {
         name: 'label',
+        title:
+          '选中状态的值，只有在绑定对象类型为 array 时有效。 如果没有 value， label则作为value使用',
         defaultValue: '',
         setters: ['InputSetter']
       },
       {
         name: 'value',
+        title:
+          '选中状态的值（只有在checkbox-group或者绑定对象类型为array时有效）',
         defaultValue: '',
         setters: ['InputSetter', 'NumberSetter', 'BooleanSetter', 'JSONSetter']
       },
       {
         name: 'trueValue',
+        title: '选中时的值',
         defaultValue: '',
         setters: ['InputSetter', 'NumberSetter']
       },
       {
         name: 'falseValue',
-        defaultValue: '',
-        setters: ['InputSetter', 'NumberSetter']
-      },
-      {
-        name: 'trueLabel',
-        defaultValue: '',
-        setters: ['InputSetter', 'NumberSetter']
-      },
-      {
-        name: 'falseLabel',
+        title: '没有选中时的值',
         defaultValue: '',
         setters: ['InputSetter', 'NumberSetter']
       },
       {
         name: 'disabled',
+        title: '是否禁用',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'border',
+        title: '是否显示边框',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'size',
+        title: 'Checkbox 的尺寸',
         defaultValue: 'default',
         options: ['large', 'default', 'small'],
         setters: 'SelectSetter'
@@ -66,6 +66,7 @@ const Checkbox: MaterialDescription[] = [
       },
       {
         name: 'checked',
+        title: '当前是否勾选',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
@@ -73,14 +74,14 @@ const Checkbox: MaterialDescription[] = [
         name: 'indeterminate',
         defaultValue: false,
         title: '设置 indeterminate 状态，只负责样式控制',
-        label: '半选',
+        // label: '半选',
         setters: 'BooleanSetter'
       },
       {
         name: 'validateEvent',
         defaultValue: true,
         title: '输入时是否触发表单的校验',
-        label: '表单校验',
+        // label: '表单校验',
         setters: 'BooleanSetter'
       },
       {
@@ -96,8 +97,24 @@ const Checkbox: MaterialDescription[] = [
         setters: 'StringSetter'
       },
       {
-        name: 'controls',
-        label: 'controls',
+        name: 'aria-controls',
+        title: '与 aria-control一致, 当 indeterminate为 true时生效',
+        setters: 'BooleanSetter'
+      },
+      {
+        name: 'trueLabel',
+        title: '选中时的值(deprecated)',
+        defaultValue: '',
+        setters: ['InputSetter', 'NumberSetter']
+      },
+      {
+        name: 'falseLabel',
+        title: '没有选中时的值(deprecated)',
+        defaultValue: '',
+        setters: ['InputSetter', 'NumberSetter']
+      },
+      {
+        name: 'controls(deprecated)',
         title: '与 aria-control一致, 当 indeterminate为 true时生效',
         setters: 'BooleanSetter'
       }
@@ -128,42 +145,44 @@ const Checkbox: MaterialDescription[] = [
     props: [
       {
         name: 'modelValue',
+        title: '绑定值',
         defaultValue: [],
         setters: 'JSONSetter'
       },
       {
         name: 'size',
+        title: '多选框组尺寸',
         defaultValue: '',
         options: ['large', 'default', 'small'],
         setters: 'SelectSetter'
       },
       {
         name: 'disabled',
+        title: '是否禁用',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'min',
+        title: '可被勾选的 checkbox 的最小数量',
         defaultValue: '',
         setters: 'NumberSetter'
       },
       {
         name: 'max',
+        title: '可被勾选的 checkbox 的最大数量',
         defaultValue: '',
         setters: 'NumberSetter'
       },
       {
-        name: 'label',
+        name: 'aria-label',
+        title: '原生 aria-label属性',
         defaultValue: '',
         setters: 'InputSetter'
       },
-      {
-        name: 'value',
-        defaultValue: '',
-        setters: ['InputSetter', 'NumberSetter', 'BooleanSetter', 'JSONSetter']
-      },
       {
         name: 'textColor',
+        title: '当按钮为活跃状态时的字体颜色',
         defaultValue: '#ffffff',
         setters: 'ColorSetter'
       },
@@ -173,12 +192,23 @@ const Checkbox: MaterialDescription[] = [
         title: '当按钮为活跃状态时的边框和背景颜色',
         setters: 'ColorSetter'
       },
+      {
+        name: 'tag',
+        defaultValue: 'div',
+        title: '复选框组元素标签',
+        setters: 'StringSetter'
+      },
       {
         name: 'validateEvent',
         defaultValue: true,
         title: '输入时是否触发表单的校验',
-        label: '表单校验',
         setters: 'BooleanSetter'
+      },
+      {
+        name: 'label',
+        title: '原生 aria-label属性',
+        defaultValue: '',
+        setters: 'StringSetter'
       }
     ],
     events: ['change', 'update:modelValue'],
@@ -216,37 +246,62 @@ const Checkbox: MaterialDescription[] = [
     categoryId: 'form',
     package: 'element-plus',
     props: [
+      {
+        name: 'modelValue',
+        title: '选中状态的值，只有在绑定对象类型为 array 时有效。',
+        defaultValue: [],
+        setters: ['StringSetter', 'NumberSetter', 'BooleanSetter', 'JSONSetter']
+      },
       {
         name: 'label',
+        title:
+          '选中状态的值，只有在绑定对象类型为 array 时有效。 如果没有 value， label则作为value使用',
         defaultValue: '',
-        setters: ['JSONSetter', 'InputSetter', 'NumberSetter', 'BooleanSetter']
+        setters: ['StringSetter', 'NumberSetter', 'BooleanSetter', 'JSONSetter']
       },
       {
-        name: 'trueLabel',
+        name: 'trueValue',
+        title: '选中时的值',
         defaultValue: '',
-        setters: ['InputSetter', 'NumberSetter']
+        setters: ['StringSetter', 'NumberSetter']
       },
       {
-        name: 'falseLabel',
+        name: 'falseValue',
+        title: '没有选中时的值',
         defaultValue: '',
-        setters: ['InputSetter', 'NumberSetter']
+        setters: ['StringSetter', 'NumberSetter']
       },
       {
         name: 'disabled',
+        title: '是否禁用',
         defaultValue: false,
         setters: 'BooleanSetter'
       },
       {
         name: 'name',
+        title: '原生 name 属性',
         defaultValue: '',
-        setters: 'InputSetter'
+        setters: 'StringSetter'
       },
       {
         name: 'checked',
         defaultValue: false,
         setters: 'BooleanSetter'
+      },
+      {
+        name: 'trueLabel',
+        title: '选中时的值',
+        defaultValue: '',
+        setters: ['StringSetter', 'NumberSetter']
+      },
+      {
+        name: 'falseLabel',
+        title: '没有选中时的值',
+        defaultValue: '',
+        setters: ['StringSetter', 'NumberSetter']
       }
     ],
+    slots: ['default'],
     snippet: {
       props: {
         label: '按钮选项'