@vtj/materials 0.15.1 → 0.16.0

package/src/element/upload.ts

@@ -15,26 +15,31 @@ const Upload: MaterialDescription = {
     },
     {
       name: 'headers',
+      title: '设置上传的请求头部',
       defaultValue: '',
       setters: 'JSONSetter'
     },
     {
       name: 'method',
+      title: '设置上传请求方法',
       defaultValue: 'post',
       setters: 'InputSetter'
     },
     {
       name: 'multiple',
+      title: '是否支持多选文件',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
       name: 'data',
+      title: '上传时附带的额外参数',
       defaultValue: '',
-      setters: 'ExpressionSetter'
+      setters: ['ExpressionSetter', 'FunctionSetter'],
     },
     {
       name: 'name',
+      title: '上传的文件字段名',
       defaultValue: 'file',
       setters: 'ExpressionSetter'
     },
@@ -46,88 +51,113 @@ const Upload: MaterialDescription = {
     },
     {
       name: 'showFileList',
+      title: '是否显示已上传文件列表',
       defaultValue: true,
       setters: 'BooleanSetter'
     },
     {
       name: 'drag',
+      title: '是否启用拖拽上传',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
       name: 'accept',
+      title: '接受上传的文件类型（thumbnail-mode 模式下此参数无效）',
       defaultValue: '',
       setters: 'InputSetter'
     },
     {
       name: 'crossorigin',
+      title: '原生属性 crossorigin',
       options: ['', 'anonymous', 'use-credentials'],
       setters: 'SelectSetter'
     },
     {
       name: 'onPreview',
+      title: '点击文件列表中已上传的文件时的钩子',
       setters: 'FunctionSetter'
     },
     {
       name: 'onRemove',
+      title: '文件列表移除文件时的钩子',
       setters: 'FunctionSetter'
     },
     {
       name: 'onSuccess',
+      title: '文件上传成功时的钩子',
       setters: 'FunctionSetter'
     },
     {
       name: 'onError',
+      title: '文件上传失败时的钩子',
       setters: ['FunctionSetter', 'ExpressionSetter']
     },
     {
       name: 'onProgress',
+      title: '文件上传时的钩子',
       setters: ['FunctionSetter', 'ExpressionSetter']
     },
     {
       name: 'onChange',
+      title: '文件状态改变时的钩子，添加文件、上传成功和上传失败时都会被调用',
       setters: 'FunctionSetter'
     },
     {
       name: 'onExceed',
+      title: '当超出限制时，执行的钩子函数',
       setters: 'FunctionSetter'
     },
     {
       name: 'beforeUpload',
+      title: '上传文件之前的钩子，参数为上传的文件， 若返回false或者返回 Promise 且被 reject，则停止上传',
       setters: 'FunctionSetter'
     },
     {
       name: 'beforeRemove',
+      title: '删除文件之前的钩子，参数为上传的文件和文件列表， 若返回 false 或者返回 Promise 且被 reject，则停止删除',
       setters: 'FunctionSetter'
     },
     {
       name: 'fileList',
+      title: '默认上传文件',
       setters: ['ArraySetter', 'JSONSetter']
     },
     {
       name: 'listType',
+      title: '文件列表的类型',
       defaultValue: 'text',
       options: ['text', 'picture', 'picture-card'],
       setters: 'SelectSetter'
     },
     {
       name: 'autoUpload',
+      title: '是否自动上传文件',
       defaultValue: true,
       setters: 'BooleanSetter'
     },
     {
       name: 'httpRequest',
+      title: '覆盖默认的 Xhr 行为，允许自行实现上传文件的请求',
       setters: 'FunctionSetter'
     },
     {
       name: 'disabled',
+      title: '是否禁用上传',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
     {
       name: 'limit',
+      title: '允许上传文件的最大数量',
       defaultValue: '',
       setters: 'NumberSetter'
+    },
+    {
+      name: 'directory',
+      title: '是否支持上传文件夹。 启用后，只能选择文件夹；选择文件夹后，文件夹内的文件将被扁平化处理',
+      defaultValue: false,
+      setters: 'BooleanSetter'
     }
   ],
   slots: [

package/src/element/virtualizedTable.ts

@@ -9,6 +9,7 @@ const VirtualizedTable: MaterialDescription = {
   props: [
     {
       name: 'cache',
+      title: '为了更好的渲染效果预先多加载的行数',
       defaultValue: 2,
       setters: 'NumberSetter'
     },
@@ -21,61 +22,90 @@ const VirtualizedTable: MaterialDescription = {
     },
     {
       name: 'header-class',
+      title: 'header 部分的自定义 class 名',
       defaultValue: '',
       setters: ['InputSetter', 'ExpressionSetter']
     },
     {
       name: 'header-props',
+      title: 'header 部分的自定义 props 名',
       defaultValue: '',
       setters: ['JSONSetter', 'ExpressionSetter']
     },
     {
       name: 'header-cell-props',
+      title: 'header cell 部分的自定义 props 名',
       defaultValue: '',
       setters: ['JSONSetter', 'ExpressionSetter']
     },
     {
       name: 'header-height',
+      title: 'Header 的高度由height设置。 如果传入数组，它会使 header row 等于数组长度',
       defaultValue: 50,
       setters: ['NumberSetter', 'ExpressionSetter']
     },
     {
       name: 'footer-height',
+      title: 'Footer 部分的高度，当传入值时，这部分将被计算入 table 的高度里',
       defaultValue: 0,
       setters: 'NumberSetter'
     },
     {
       name: 'row-class',
+      title: 'row wrapper 部分的自定义 class 名',
       defaultValue: '',
       setters: ['InputSetter', 'ExpressionSetter']
     },
     {
       name: 'row-key',
+      title: '每行的 key 值，如果不提供，将使用索引 index 代替',
       defaultValue: 'id',
       setters: ['InputSetter', 'NumberSetter']
     },
     {
       name: 'row-props',
+      title: 'row component 部分的自定义 class 名',
       defaultValue: '',
       setters: ['JSONSetter', 'ExpressionSetter']
     },
+    {
+      name: 'row-height',
+      title: '每行的高度, 用于计算表的总高度',
+      defaultValue: 50,
+      setters: 'NumberSetter'
+    },
+    {
+      name: 'row-event-handlers',
+      title: '当每行添加了一系列事件处理器时触发',
+      setters: 'ObjectSetter'
+    },
+    {
+      name: 'cell-props',
+      title: '每个单元格 cell 的自定义 props (除了 header cell 以外)',
+      defaultValue: 50,
+      setters: ['ObjectSetter', 'FunctionSetter']
+    },
     {
       name: 'columns',
+      title: '列 column 的配置数组',
       defaultValue: [],
       setters: 'ArraySetter'
     },
     {
       name: 'data',
+      title: '要在表中渲染的数据数组',
       defaultValue: [],
       setters: 'ArraySetter'
     },
     {
       name: 'data-getter',
+      title: '一个自定义方法从数据源获取数据',
       defaultValue: '',
       setters: 'ExpressionSetter'
     },
     {
       name: 'fixed-data',
+      title: '渲染行在表格主内容上方和 header 下方区域的数据',
       defaultValue: '',
       setters: 'JSONSetter'
     },
@@ -89,7 +119,7 @@ const VirtualizedTable: MaterialDescription = {
     {
       name: 'expanded-row-keys',
       defaultValue: '',
-      title: '列的 key 来标记哪个行可以被展开',
+      title: '存放行展开状态的 key 的数组，可以和 v-model 搭配使用',
       label: 'column-key',
       setters: 'JSONSetter'
     },
@@ -102,11 +132,13 @@ const VirtualizedTable: MaterialDescription = {
     },
     {
       name: 'class',
+      title: '表格的类名称，将应用于表格的全部的三个部分 (左、右、主)',
       defaultValue: '',
       setters: ['JSONSetter', 'InputSetter']
     },
     {
       name: 'fixed',
+      title: '单元格宽度是自适应还是固定',
       defaultValue: false,
       setters: 'BooleanSetter'
     },
@@ -124,17 +156,26 @@ const VirtualizedTable: MaterialDescription = {
     },
     {
       name: 'max-height',
+      title: '表格的最大高度',
       defaultValue: '',
       setters: 'NumberSetter'
     },
+    {
+      name: 'indent-size',
+      title: '树形表的水平缩进',
+      defaultValue: 12,
+      setters: 'NumberSetter'
+    },
     {
       name: 'h-scrollbar-size',
+      title: '配置表格的水平滚动条大小，防止水平和垂直滚动条重叠',
       defaultValue: 6,
       label: '水平滚动条大小',
       setters: 'NumberSetter'
     },
     {
-      name: 'h-scrollbar-size',
+      name: 'v-scrollbar-size',
+      title: '配置表格的垂直滚动条大小，防止水平和垂直滚动条重叠',
       defaultValue: 6,
       label: '垂直滚动条大小',
       setters: 'NumberSetter'
@@ -165,7 +206,8 @@ const VirtualizedTable: MaterialDescription = {
     'end-reached',
     'scroll',
     'rows-rendered',
-    'row-event-handlers'
+    // 'row-event-handlers',
+    'row-expand'
   ],
   snippet: {
     props: {

package/src/shared/props.ts

@@ -3,6 +3,7 @@ import type { MaterialProp } from '@vtj/core';
 export function size(name: string = 'size'): MaterialProp {
   return {
     name,
+    title: '尺寸',
     defaultValue: 'default',
     setters: 'SelectSetter',
     options: ['default', 'large', 'small']
@@ -12,8 +13,19 @@ export function size(name: string = 'size'): MaterialProp {
 export function type(name: string = 'type'): MaterialProp {
   return {
     name,
+    title: '类型',
     defaultValue: 'default',
     setters: 'SelectSetter',
     options: ['default', 'primary', 'success', 'warning', 'danger', 'info']
   };
 }
+
+export function effect(name: string = 'effect'): MaterialProp {
+  return {
+    name,
+    title: '主题',
+    defaultValue: 'light',
+    setters: 'SelectSetter',
+    options: ['dark', 'light'],
+  };
+}

package/src/version.ts

@@ -2,7 +2,7 @@
  * Copyright (c) 2026, VTJ.PRO All rights reserved.
  * @name @vtj/materials 
  * @author CHC chenhuachun1549@dingtalk.com 
- * @version 0.15.1
+ * @version 0.16.0
  * @license <a href="https://vtj.pro/license.html">MIT License</a>
  */
-export const version = '0.15.1';
+export const version = '0.16.0';