@opentiny/vue-docs 3.28.1 → 3.30.0

package/demos/apis/drawer.js

@@ -5,6 +5,21 @@ export default {
       name: 'drawer',
       type: 'component',
       props: [
+        {
+          name: 'append-to-body',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': 'drawer 本身是否插入到 body 上',
+            'en-US': 'Whether the drawer itself is inserted into the body'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: '',
+          mfDemo: '',
+          meta: {
+            stable: '3.30.0'
+          }
+        },
         {
           name: 'before-close',
           type: '(type) => boolean',
@@ -236,6 +251,21 @@ export default {
           pcDemo: 'events',
           mfDemo: ''
         },
+        {
+          name: 'closed',
+          type: '() => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '关闭抽屉动画结束时的事件',
+            'en-US': 'Event emitted when drawer closing animation ends'
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: 'events',
+          mfDemo: '',
+          meta: {
+            stable: '3.29.0'
+          }
+        },
         {
           name: 'confirm',
           type: '() => void',
@@ -371,6 +401,7 @@ interface IDrawerConfigs extends IDrawerProps {
   events: {
     // 监听事件
     close: () => void
+    closed: () => void
     confirm: () => void
     show: (instance: Component) => void
   },

package/demos/apis/dropdown.js

@@ -498,7 +498,40 @@ export default {
             'en-US': 'Sets the level-2 drop-down menu flag.'
           },
           mode: ['mobile-first']
-        }
+        },
+        {
+          name: 'tip',
+          type: 'string | Function',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '提示信息内容，支持字符串或函数。函数接收参数 { itemData, vm }',
+            'en-US': 'Tooltip content, supports string or function. Function receives parameters { itemData, vm }'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
+        {
+          name: 'tip-position',
+          type: 'string',
+          defaultValue: "'right'",
+          desc: {
+            'zh-CN': '提示信息的位置，可选值：top / right / bottom / left',
+            'en-US': 'Position of tooltip, optional values: top / right / bottom / left'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
+        {
+          name: 'tip-effect',
+          type: 'string',
+          defaultValue: "'light'",
+          desc: {
+            'zh-CN': '提示信息的主题，可选值：light（浅色）/ dark（深色）',
+            'en-US': 'Theme of tooltip, optional values: light / dark'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
+        },
       ],
       events: [],
       methods: [],
@@ -555,6 +588,11 @@ interface IItemData {
   label?: string
   disabled?: boolean
   divided?: boolean
+  tip?: string | ((params: { itemData: IItemData, vm: any }) => string)
+  tipPosition?: 'top' | 'right' | 'bottom' | 'left'
+  tipEffect?: 'light' | 'dark'
+  children?: IItemData[]
+  icon?: Component
 }
 `
     },

package/demos/apis/filter-panel.js

@@ -17,7 +17,15 @@ export default {
           pcDemo: 'tip'
         },
         {
-          mode: []
+          name: 'clearable',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示清空按钮',
+            'en-US': 'Whether to display the clear button'
+          },
+          mode: ['pc'],
+          pcDemo: 'tip'
         },
         {
           name: 'disabled',
@@ -76,6 +84,18 @@ export default {
           mode: ['pc'],
           pcDemo: 'popper-class'
         },
+        {
+          name: 'size',
+          type: "'medium'",
+          defaultValue: '',
+          desc: {
+            'zh-CN': '过滤器面板的尺寸，可选值：medium（中等尺寸），不设置则为默认尺寸',
+            'en-US': 'Size of the filter panel. Optional value: medium. If not set, the default size is used'
+          },
+          stable: '3.29.0',
+          mode: ['pc'],
+          pcDemo: 'size'
+        },
         {
           name: 'tip',
           type: 'string',

package/demos/apis/fluent-editor.js

@@ -18,6 +18,22 @@ export default {
           },
           pcDemo: 'before-editor-init'
         },
+        {
+          name: 'before-link-open',
+          typeAnchorName: 'IBeforeLinkOpen',
+          type: 'IBeforeLinkOpen',
+          defaultValue: '',
+          meta: {
+            stable: '3.30.0'
+          },
+          desc: {
+            'zh-CN':
+              '点击富文本中的超链接前触发。返回 false（或 Promise resolve false）可拦截跳转；返回 true/undefined 继续跳转。',
+            'en-US': ''
+          },
+          mode: ['pc', 'mobile-first'],
+          pcDemo: ''
+        },
         {
           name: 'data-type',
           type: 'boolean',
@@ -103,6 +119,20 @@ export default {
     }
   ],
   types: [
+    {
+      name: 'IBeforeLinkOpen',
+      type: 'type',
+      code: `
+type IBeforeLinkOpen = (payload: {
+  url: string // 过滤后的安全链接
+  rawUrl: string // 原始 href
+  target: string // 超链接 target，默认 _blank
+  rel: string // 超链接 rel
+  event: MouseEvent // 点击事件对象
+  quill: any // 当前编辑器实例
+}) => boolean | void | Promise<boolean | void>
+      `
+    },
     {
       name: 'IImageUploadOptions',
       type: 'interface',

package/demos/apis/form.js

@@ -580,6 +580,17 @@ export default {
           mode: ['pc'],
           pcDemo: 'slot-label'
         },
+        {
+          name: 'label-line',
+          defaultValue: 2,
+          type: 'number',
+          desc: {
+            'zh-CN': '标签文本显示的行数',
+            'en-US': 'The number of lines displayed in the label text'
+          },
+          mode: ['mobile-first'],
+          pcDemo: 'slot-label'
+        },
         {
           name: 'error',
           defaultValue: '',

package/demos/apis/fullscreen.js

@@ -12,7 +12,7 @@ export default {
           desc: {
             'zh-CN': '组件式使用时，点击组件 wrapper 是否关闭全屏显示。默认为 true',
             'en-US':
-              'When the component is used in component mode, click the component wrapper to determine whether to disable full-screen display. The default value is true.'
+              'In component mode, whether clicking the component wrapper exits fullscreen display. Default is true.'
           },
           mode: ['pc'],
           pcDemo: ''
@@ -23,7 +23,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '组件式使用时，控制组件是否全屏显示。默认为 false',
-            'en-US': 'Whether to display a component in full screen mode. The default value is false'
+            'en-US': 'In component mode, controls whether the component displays in fullscreen. Default is false.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'
@@ -34,7 +34,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '自定义组件 wrapper 的样式类名',
-            'en-US': 'Style class name of the custom component wrapper'
+            'en-US': 'Custom CSS class name for the component wrapper.'
           },
           mode: ['pc'],
           pcDemo: ''
@@ -45,8 +45,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '显示模式。true 为网页全屏，false 为浏览器全屏。默认值为 false',
-            'en-US':
-              'Display mode. The value true indicates that the web page is displayed in full screen mode, and the value false indicates that the browser is displayed in full screen mode. The default value is false'
+            'en-US': 'Display mode. true for webpage fullscreen, false for browser fullscreen. Default is false.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'
@@ -58,7 +57,7 @@ export default {
           desc: {
             'zh-CN': '是否将目标元素移动到 body 下。true 为移动，false 为不移动。默认值为 false',
             'en-US':
-              'Indicates whether to move the target element to the body. true: move; false: do not move. The default value is false'
+              'Whether to teleport the target element to body. true to move, false to not move. Default is false.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'
@@ -69,7 +68,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '在全屏显示时，目标元素的 zIndex',
-            'en-US': 'ZIndex of the target element in full-screen display'
+            'en-US': 'z-index value of the target element when in fullscreen display.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'
@@ -82,7 +81,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '拦截事件',
-            'en-US': 'Intercept Events.'
+            'en-US': 'Intercept event handler.'
           },
           mode: ['pc'],
           pcDemo: 'before-change'
@@ -92,7 +91,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '组件式使用时，更新 fullscreen 属性',
-            'en-US': 'Update the fullscreen attribute in component mode.'
+            'en-US': 'In component mode, updates the fullscreen prop.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'
@@ -104,7 +103,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '函数式使用时，切换全屏模式',
-            'en-US': 'Switch the full-screen mode when the function mode is used.'
+            'en-US': 'In function mode, toggles between fullscreen and normal mode.'
           },
           mode: ['pc'],
           pcDemo: 'example-api'
@@ -116,7 +115,7 @@ export default {
           defaultValue: '',
           desc: {
             'zh-CN': '自定义内容，需要在 layout 中列出 slot',
-            'en-US': 'User-defined content. Slots must be listed in the layout.'
+            'en-US': 'Custom content slot. Must be declared in the layout.'
           },
           mode: ['pc'],
           pcDemo: 'example-component'

package/demos/apis/grid.js

@@ -30,6 +30,23 @@ export default {
           pcDemo: 'grid-data-source#data-source-auto-load',
           mfDemo: ''
         },
+        {
+          name: 'filter-popper-options',
+          typeAnchorName: 'IPopperOption',
+          type: 'IPopperOption',
+          defaultValue: '{}',
+          desc: {
+            'zh-CN': '过滤面板弹出层配置项；具体参考 IPopperOption 的描述',
+            'en-US':
+              'Configuration item for the filter panel pop-up layer; refer to the description of IPopperOption for details'
+          },
+          meta: {
+            stable: '3.29.0'
+          },
+          mode: ['pc'],
+          pcDemo: 'grid-filter#filter-default-filter',
+          mfDemo: ''
+        },
         {
           name: 'auto-resize',
           type: 'boolean',
@@ -3217,6 +3234,21 @@ export default {
     }
   ],
   types: [
+    {
+      name: 'IPopperOption',
+      type: 'interface',
+      code: `
+    interface IPopperOption {
+      bubbling: boolean // 是否监听元素所有上级有滚动元素的scroll事件，监听到则更新popper的位置。用于解决某些弹出层位置在页面滚动时，位置不正确的场景，默认true
+      followReferenceHide: boolean // 当触发源隐藏时，自动隐藏弹出层，默认true
+      removeOnDestroy: boolean // 弹出层消失后，是否移除弹出层的DOM元素，布尔false
+      updateHiddenPopperOnScroll: boolean  // 滚动过程中是否更新隐藏的弹出层位置
+      boundariesElement: 'viewport' | 'body' | HTMLElement // 滚动过程中,弹出层的碰撞边界。 默认值为： 'viewport'
+      ignoreBoundaries: boolean  // 忽略边界判断，弹出的位置始终是设置的 placement 值
+      scrollParent:  HTMLElement  // 指定滚动的父节点，优化级最高。 默认为null
+    }
+          `
+    },
     {
       name: 'IRow',
       type: 'interface',
@@ -4169,25 +4201,108 @@ interface IEditorConfig {
     {
       name: 'IFilterConfig',
       type: 'type',
+      depTypes: ['IRow', 'IColumnConfig'],
       code: `
 interface IFilterConfig {
-  // 设置在显示枚举选项功能是否为多选, 仅在 enumable:true 下有效
-  multi: boolean
+  // 设置在显示枚举选项功能是否为多选，仅在 enumable:true 下有效，默认 true
+  multi?: boolean
   // 设置在过滤面板中显示枚举选项
-  enumable: boolean
-  // 设置在过滤面板中显示默认的筛选条件
-  defaultFilter: boolean
-  // 设置在过滤面板中显示输入筛选的项
-  inputFilter: boolean
-  // 设置在显示枚举选项功能(enumable)下制定静态数据源，也可以是函数返回一个Promise对象
-  values: {
-    // 设置枚举数据的显示值属性字段， 默认'label'
-    label: string
-    // 设置枚举数据的实际值属性字段， 默认'value'
-    value: string 
-  }[] | () => Promise
-  // 3.25.0新增，设置过滤面板根节点属性
-  attrs: { [props: string]: string }
+  enumable?: boolean
+  // 设置在过滤面板中显示空/非空筛选条件
+  defaultFilter?: boolean
+  // 设置在过滤面板中显示输入筛选，true 使用默认 input，或传入 IInputFilterConfig 配置
+  inputFilter?: boolean | IInputFilterConfig
+  // 设置枚举选项的静态数据源，也可为函数 (params) => Promise<Array<{label,value,checked?}>>
+  values?: Array<{ [key: string]: any }> | (params: { property: string; filter: IFilterConfig }) => Promise<Array<{ [key: string]: any }>>
+  // 设置枚举数据的显示值属性字段，默认 'label'
+  label?: string
+  // 设置枚举数据的实际值属性字段，默认 'value'
+  value?: string
+  // 设置筛选项的显示顺序和组合，默认为 'input,enum,default,extends,base'
+  // 可选项：input | enum | default | extends | base | simple（简化版与其它互斥）
+  layout?: string
+  // 初始筛选条件
+  condition?: IFilterCondition
+  // 扩展快捷筛选项，点击后直接应用对应 method 筛选
+  extends?: IExtendsFilterItem[]
+  // 自定义筛选方法，用于 filter 插槽或 extends 扩展项
+  method?: (params: { row: IRow; column: IColumnConfig; property: string }) => boolean
+  // 简化版筛选配置，layout 需包含 'simple'
+  simpleFilter?: ISimpleFilterConfig
+  // 3.25.0 新增，设置过滤面板根节点属性
+  attrs?: Record<string, string>
+  // 数据源配置，用于异步获取枚举选项
+  dataset?: any
+}
+
+// 输入筛选配置
+interface IInputFilterConfig {
+  // 输入组件，默认 'input'，可传入 TinyDatePicker、TinyNumeric 等
+  component?: string | object
+  // 传递给输入组件的属性
+  attrs?: Record<string, any>
+  // 筛选关系选项，内置：equals|unequal|greaterThan|lessThan|equalToGreaterThan|equalToLessThan|contains|startwith|endwith|exclude
+  relations?: IRelationFilterItem[]
+  // 默认选中的 relation 值
+  relation?: string
+  // 重置输入时的回调
+  onResetInputFilter?: (ref: any) => void
+}
+
+// 关系选项项
+interface IRelationFilterItem {
+  label: string
+  value: string
+  // 自定义筛选方法，(params) => boolean，不传则使用内置 relation 逻辑
+  method?: (params: { value: any; input: any; row?: IRow; column?: IColumnConfig }) => boolean
+}
+
+// 扩展筛选项
+interface IExtendsFilterItem {
+  label: string
+  value?: string
+  // 本地筛选时必填；服务端筛选可不填
+  method?: (params: { value: any; row: IRow; column: IColumnConfig }) => boolean
+}
+
+// 筛选条件
+interface IFilterCondition {
+  input?: string | number
+  relation?: string
+  empty?: boolean | null
+  type?: 'input' | 'enum' | 'empty' | 'extend' | 'date' | 'custom' | null
+  value?: any[]
+  dateList?: [string, string]
+}
+
+// 简化版筛选配置
+interface ISimpleFilterConfig {
+  // 是否为日期时间模式，true 时渲染日期范围选择器
+  isDatetime?: boolean
+  // 是否显示全选按钮，多选模式下有效；搜索模式下与 searchable 互斥显示
+  selectAll?: boolean
+  // 日期时间配置，isDatetime 为 true 时必填
+  datetimeConfig?: IDatetimeFilterConfig
+  // 搜索配置，isDatetime 为 false 时可配置，用于在枚举列表中增加搜索框
+  searchConfig?: ISearchFilterConfig
+}
+
+// 简化版-日期时间配置
+interface IDatetimeFilterConfig {
+  component: object
+  format?: string
+  valueFormat?: string
+  type?: 'date' | 'datetime' | 'daterange'
+  min?: Date
+  max?: Date
+  startDate?: string
+  endDate?: string
+}
+
+// 简化版-搜索配置
+interface ISearchFilterConfig {
+  component?: object
+  searchValue?: string
 }
       `
     },

package/demos/apis/guide.js

@@ -152,6 +152,20 @@ export default {
           meta: {
             stable: '3.27.0'
           }
+        },
+        {
+          name: 'show-close',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示关闭按钮',
+            'en-US': ''
+          },
+          mode: ['pc'],
+          pcDemo: 'show-close',
+          meta: {
+            stable: '3.29.0'
+          }
         }
       ],
       events: [],

package/demos/apis/link.js

@@ -70,6 +70,17 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'basic-usage'
+        },
+        {
+          name: 'target',
+          type: "'_self' | '_blank' | '_parent' | '_top'",
+          defaultValue: '_self',
+          desc: {
+            'zh-CN': '链接打开方式',
+            'en-US': 'Link open mode'
+          },
+          mode: ['pc'],
+          pcDemo: 'target'
         }
       ],
       events: [

package/demos/apis/message.js

@@ -1,5 +1,5 @@
 export default {
-  mode: ['mobile-first'],
+  mode: ['mobile-first', 'pc'],
   apis: [
     {
       name: 'message',
@@ -7,63 +7,89 @@ export default {
       props: [
         {
           name: 'duration',
-          type: 'String',
-          defaultValue: '',
+          type: 'string',
+          defaultValue: '3000',
           desc: {
             'zh-CN': '设置提示信息停留时间',
-            'en-US': ''
+            'en-US': 'Set the prompt information retention time'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'message-duration'
         },
         {
           name: 'id',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置唯一的 id 防止重复提示，只对 type=message 有效',
-            'en-US': ''
+            'en-US': 'Set a unique id to prevent duplicate prompts, only valid for type=message'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'prevent-duplicate'
         },
         {
           name: 'message',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '设置提示信息',
-            'en-US': ''
+            'en-US': 'Set the prompt information'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'basic-usage'
         },
         {
           name: 'show-close',
-          type: 'String',
+          type: 'string',
           defaultValue: '',
           desc: {
             'zh-CN': '控制弹窗是否显示关闭图标',
-            'en-US': ''
+            'en-US': 'Whether to display the close icon'
           },
           mode: ['mobile-first'],
           mfDemo: ''
         },
+        {
+          name: 'message-closable',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示关闭按钮，默认值为 false',
+            'en-US': 'close button is displayed or not, the default value is false'
+          },
+          mode: ['pc'],
+          mfDemo: '',
+          pcDemo: 'message-close'
+        },
         {
           name: 'status',
-          type: 'String',
-          defaultValue: '',
+          typeAnchorName: 'IStatus',
+          type: 'IStatus',
+          defaultValue: "'info'",
           desc: {
-            'zh-CN': '设置消息状态，可选值有 info | success | warning | error',
-            'en-US': ''
+            'zh-CN': '设置消息状态',
+            'en-US': 'Set the message status'
           },
-          mode: ['mobile-first'],
-          mfDemo: ''
+          mode: ['mobile-first', 'pc'],
+          mfDemo: '',
+          pcDemo: 'basic-usage'
         }
       ],
       events: [],
       methods: [],
       slots: []
     }
+  ],
+  types: [
+    {
+      name: 'IStatus',
+      type: 'type',
+      code: `
+          type IStatus = 'info' | 'success' | 'warning' | 'error' | 'loading'
+      `
+    }
   ]
 }