@opentiny/vue-docs 3.19.8-alpha.5 → 3.20.0

package/demos/apis/bulletin-board.js

@@ -18,11 +18,12 @@ export default {
         },
         {
           name: 'data',
-          type: 'Array',
+          typeAnchorName: 'BulletinBoardData',
+          type: 'BulletinBoardData[]',
           defaultValue: '',
           desc: {
-            'zh-CN': 'tab-item 数据;tab-item 数据',
-            'en-US': 'tab-item data; tab-item data'
+            'zh-CN': 'tab-item 数据;',
+            'en-US': 'tab-item data;'
           },
           mode: ['pc'],
           pcDemo: 'base'
@@ -87,9 +88,38 @@ export default {
           pcDemo: 'title'
         }
       ],
-      events: [],
+      events: [
+        {
+          name: 'contentClick',
+          type: '(event: BulletinBoardData) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '当公告牌内容被点击时触发的回调函数',
+            'en-US': 'The callback function triggered when the content of the bulletin board is clicked'
+          },
+          mode: ['pc'],
+          pcDemo: 'events',
+          meta: {
+            stable: '3.20.0'
+          }
+        }
+      ],
       methods: [],
       slots: []
     }
+  ],
+  types: [
+    {
+      name: 'BulletinBoardData',
+      type: 'interface',
+      code: `
+            interface BulletinBoardData {
+              text: string // 显示文本
+              date: string // 日期
+              url: string // 需要跳转的地址
+              target: string // <a> 标签的一个属性，该属性指定在何处显示链接的资源
+              }
+            `
+    }
   ]
 }

package/demos/apis/calendar-view.js

@@ -43,7 +43,7 @@ export default {
         },
         {
           name: 'height',
-          type: 'string',
+          type: 'string | number',
           defaultValue: '',
           desc: {
             'zh-CN': '日历高度',

package/demos/apis/card.js

@@ -18,19 +18,6 @@ export default {
           pcDemo: '',
           mfDemo: 'card-auto-width'
         },
-        {
-          name: 'check-type',
-          type: 'string',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '设置卡片单选、多选，单选/radio；多选/checkbox，需同时设置 label。',
-            'en-US':
-              'Set single-choice, multiple-choice, single-choice, and radio. Multi-choice/checkbox. You need to set the label at the same time.'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'check-type-checkbox',
-          mfDemo: 'check-type-checkbox'
-        },
         {
           name: 'custom-class',
           type: 'string',
@@ -43,18 +30,6 @@ export default {
           pcDemo: 'custom-class',
           mfDemo: 'card-custom-class'
         },
-        {
-          name: 'disabled',
-          type: 'boolean',
-          defaultValue: 'false',
-          desc: {
-            'zh-CN': '卡片禁用',
-            'en-US': 'Card disabled'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'card-disabled',
-          mfDemo: 'card-disabled'
-        },
         {
           name: 'height',
           type: 'string',
@@ -67,55 +42,6 @@ export default {
           mfDemo: 'card-height',
           pcDemo: 'custom-class'
         },
-        {
-          name: 'icon-more',
-          type: "'iconxxx' | Component",
-          defaultValue: '',
-          desc: {
-            'zh-CN': '更多按钮图标，可传入一个svg图标对象进行替换',
-            'en-US': 'More button icons can be replaced by a svg icon object.'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: '',
-          mfDemo: 'card-icon-more'
-        },
-        {
-          name: 'label',
-          type: 'string / number',
-          defaultValue: '',
-          desc: {
-            'zh-CN': 'checkbox或radio的label',
-            'en-US': 'Checkbox or radio label.'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'check-type-checkbox',
-          mfDemo: 'card-label'
-        },
-        {
-          name: 'options',
-          typeAnchorName: 'IOptions',
-          type: 'IOptions',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '操作按钮配置',
-            'en-US': ''
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'operate-bar',
-          mfDemo: ''
-        },
-        {
-          name: 'size',
-          type: 'string',
-          defaultValue: 'medium',
-          desc: {
-            'zh-CN': '尺寸，支持large、medium、small、mini 4个尺寸，默认值为medium',
-            'en-US': 'Size. The options are large, medium, small, and mini. The default value is medium.'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'card-size',
-          mfDemo: 'card-size'
-        },
         {
           name: 'src',
           type: 'string',
@@ -128,18 +54,6 @@ export default {
           pcDemo: 'card-type',
           mfDemo: 'card-src'
         },
-        {
-          name: 'status',
-          type: 'string',
-          defaultValue: 'default',
-          desc: {
-            'zh-CN': '卡片状态，支持 success、warning、alerting、danger 4 种状态',
-            'en-US': 'Card status. The value can be success, warning, alerting, or dangerous.'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'card-status',
-          mfDemo: 'card-status'
-        },
         {
           name: 'title',
           type: 'string',
@@ -163,70 +77,157 @@ export default {
           mode: ['pc', 'mobile-first'],
           pcDemo: 'card-type',
           mfDemo: 'card-type'
-        },
-        {
-          name: 'v-model',
-          type: 'string',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '绑定值，默认为空',
-            'en-US': ''
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'check-type-checkbox',
-          mfDemo: ''
-        },
-        {
-          name: 'check-mode',
-          type: 'string',
-          defaultValue: 'normal',
-          desc: {
-            'zh-CN': '卡片被选中后的呈现模式，可选值为：normal | simple | badge',
-            'en-US': 'Display mode of a selected card. The options are as follows: normal | simple | badge'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'check-mode',
-          mfDemo: ''
-        }
-      ],
-      events: [
-        {
-          name: 'change',
-          type: '() => {}',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '组件选中/取消选中事件',
-            'en-US': 'Component check/uncheck event'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'card-events',
-          mfDemo: 'card-events'
-        },
-        {
-          name: 'icon-click',
-          type: '() => {}',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '操作栏按钮点击事件',
-            'en-US': 'Operation bar button click event'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: 'card-events',
-          mfDemo: 'card-events'
-        },
-        {
-          name: 'click',
-          type: '() => {}',
-          defaultValue: '',
-          desc: {
-            'zh-CN': '点击卡片事件',
-            'en-US': 'Click card event'
-          },
-          mode: ['pc', 'mobile-first'],
-          pcDemo: '',
-          mfDemo: ''
+          // 以下IPI暂不暴露
+          // {
+          //   name: 'check-type',
+          //   type: 'string',
+          //   defaultValue: '',
+          //   desc: {
+          //     'zh-CN': '设置卡片单选、多选，单选/radio；多选/checkbox，需同时设置 label。',
+          //     'en-US':
+          //       'Set single-choice, multiple-choice, single-choice, and radio. Multi-choice/checkbox. You need to set the label at the same time.'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'check-type-checkbox',
+          //   mfDemo: 'check-type-checkbox'
+          // },
+          // {
+          //   name: 'disabled',
+          //   type: 'boolean',
+          //   defaultValue: 'false',
+          //   desc: {
+          //     'zh-CN': '卡片禁用',
+          //     'en-US': 'Card disabled'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'card-disabled',
+          //   mfDemo: 'card-disabled'
+          // },
+          // {
+          //   name: 'icon-more',
+          //   type: "'iconxxx' | Component",
+          //   defaultValue: '',
+          //   desc: {
+          //     'zh-CN': '更多按钮图标，可传入一个svg图标对象进行替换',
+          //     'en-US': 'More button icons can be replaced by a svg icon object.'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: '',
+          //   mfDemo: 'card-icon-more'
+          // },
+          // {
+          //   name: 'label',
+          //   type: 'string / number',
+          //   defaultValue: '',
+          //   desc: {
+          //     'zh-CN': 'checkbox或radio的label',
+          //     'en-US': 'Checkbox or radio label.'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'check-type-checkbox',
+          //   mfDemo: 'card-label'
+          // },
+          // {
+          //   name: 'options',
+          //   typeAnchorName: 'IOptions',
+          //   type: 'IOptions',
+          //   defaultValue: '',
+          //   desc: {
+          //     'zh-CN': '操作按钮配置',
+          //     'en-US': ''
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'operate-bar',
+          //   mfDemo: ''
+          // },
+          // {
+          //   name: 'size',
+          //   type: 'string',
+          //   defaultValue: 'medium',
+          //   desc: {
+          //     'zh-CN': '尺寸，支持large、medium、small、mini 4个尺寸，默认值为medium',
+          //     'en-US': 'Size. The options are large, medium, small, and mini. The default value is medium.'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'card-size',
+          //   mfDemo: 'card-size'
+          // },
+          // {
+          //   name: 'status',
+          //   type: 'string',
+          //   defaultValue: 'default',
+          //   desc: {
+          //     'zh-CN': '卡片状态，支持 success、warning、alerting、danger 4 种状态',
+          //     'en-US': 'Card status. The value can be success, warning, alerting, or dangerous.'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'card-status',
+          //   mfDemo: 'card-status'
+          // },
+          // },
+          // {
+          //   name: 'v-model',
+          //   type: 'string',
+          //   defaultValue: '',
+          //   desc: {
+          //     'zh-CN': '绑定值，默认为空',
+          //     'en-US': ''
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'check-type-checkbox',
+          //   mfDemo: ''
+          // },
+          // {
+          //   name: 'check-mode',
+          //   type: 'string',
+          //   defaultValue: 'normal',
+          //   desc: {
+          //     'zh-CN': '卡片被选中后的呈现模式，可选值为：normal | simple | badge',
+          //     'en-US': 'Display mode of a selected card. The options are as follows: normal | simple | badge'
+          //   },
+          //   mode: ['pc', 'mobile-first'],
+          //   pcDemo: 'check-mode',
+          //   mfDemo: ''
         }
       ],
+      // events: [
+      //   {
+      //     name: 'change',
+      //     type: '() => {}',
+      //     defaultValue: '',
+      //     desc: {
+      //       'zh-CN': '组件选中/取消选中事件',
+      //       'en-US': 'Component check/uncheck event'
+      //     },
+      //     mode: ['pc', 'mobile-first'],
+      //     pcDemo: 'card-events',
+      //     mfDemo: 'card-events'
+      //   },
+      //   {
+      //     name: 'icon-click',
+      //     type: '() => {}',
+      //     defaultValue: '',
+      //     desc: {
+      //       'zh-CN': '操作栏按钮点击事件',
+      //       'en-US': 'Operation bar button click event'
+      //     },
+      //     mode: ['pc', 'mobile-first'],
+      //     pcDemo: 'card-events',
+      //     mfDemo: 'card-events'
+      //   },
+      //   {
+      //     name: 'click',
+      //     type: '() => {}',
+      //     defaultValue: '',
+      //     desc: {
+      //       'zh-CN': '点击卡片事件',
+      //       'en-US': 'Click card event'
+      //     },
+      //     mode: ['pc', 'mobile-first'],
+      //     pcDemo: '',
+      //     mfDemo: ''
+      //   }
+      // ],
       methods: [],
       slots: [
         {
@@ -246,7 +247,7 @@ export default {
           type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '组件默认插槽',
+            'zh-CN': '组件底部插槽',
             'en-US': 'Component Default Slot'
           },
           mode: ['pc', 'mobile-first'],
@@ -291,33 +292,33 @@ export default {
         }
       ]
     }
-  ],
-  types: [
-    {
-      name: 'IOptions',
-      type: 'interface',
-      code: `
-interface IOptions [
-  {
-    text: '删除列表',
-    icon: IconDel()
-  },
-  {
-    text: '编辑',
-    icon: IconWriting(),
-    disabled: true
-  },
-  {
-    text: '排序',
-    icon: IconAscending()
-  },
-  {
-    text: '分享',
-    icon: IconShare(),
-    disabled: true
-  }
-]
-`
-    }
+    //   ],
+    //   types: [
+    //     {
+    //       name: 'IOptions',
+    //       type: 'interface',
+    //       code: `
+    // interface IOptions [
+    //   {
+    //     text: '删除列表',
+    //     icon: IconDel()
+    //   },
+    //   {
+    //     text: '编辑',
+    //     icon: IconWriting(),
+    //     disabled: true
+    //   },
+    //   {
+    //     text: '排序',
+    //     icon: IconAscending()
+    //   },
+    //   {
+    //     text: '分享',
+    //     icon: IconShare(),
+    //     disabled: true
+    //   }
+    // ]
+    // `
+    //     }
   ]
 }

package/demos/apis/color-picker.js

@@ -21,8 +21,8 @@ export default {
           type: 'string[] | undefined',
           defaultValue: 'undefined',
           desc: {
-            'zh-CN': '启用历史记录',
-            'en-US': 'enable history or not'
+            'zh-CN': '历史记录默认值',
+            'en-US': 'Default values for historical records'
           },
           mode: ['pc'],
           pcDemo: 'history'
@@ -32,12 +32,40 @@ export default {
           type: 'string[] | undefined',
           defaultValue: 'undefined',
           desc: {
-            'zh-CN': '启用预定义颜色',
-            'en-US': 'enable predefine or not'
+            'zh-CN': '预定义颜色色值',
+            'en-US': 'predefine color values'
           },
           mode: ['pc'],
           pcDemo: 'predefine'
         },
+        {
+          name: 'enable-history',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否启用预定义颜色',
+            'en-US': 'enable history or not'
+          },
+          mode: ['pc'],
+          pcDemo: 'history',
+          meta: {
+            stable: '3.19.0'
+          }
+        },
+        {
+          name: 'enable-predefine-color',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否启用预定义颜色',
+            'en-US': 'enable predefined colors or not'
+          },
+          mode: ['pc'],
+          pcDemo: 'predefine',
+          meta: {
+            stable: '3.19.0'
+          }
+        },
         {
           name: 'size',
           type: 'string',
@@ -60,6 +88,21 @@ export default {
           },
           mode: ['pc'],
           pcDemo: 'default-visible'
+        },
+        {
+          name: 'format',
+          type: "('hex'|'rgb'|'hsl'|'hsv')[]",
+          defaultValue: '[]',
+          desc: {
+            'zh-CN': '点击确认后, confirm的事件将会返回对应的format数值. 如果为空数组则表示禁用颜色格式下拉选择',
+            'en-US':
+              'After clicking confirm, the confirm event will return the corresponding format value If it is an empty array, it means that the color format dropdown selection is disabled'
+          },
+          mode: ['pc'],
+          pcDemo: 'format',
+          meta: {
+            stable: '3.19.0'
+          }
         }
       ],
       events: [

package/demos/apis/color-select-panel.js

@@ -21,8 +21,8 @@ export default {
           type: 'string[] | undefined',
           defaultValue: 'undefined',
           desc: {
-            'zh-CN': '时候启用历史记录',
-            'en-US': 'enable history or not'
+            'zh-CN': '历史记录默认值',
+            'en-US': 'Default values for historical records'
           },
           mode: ['pc'],
           pcDemo: 'history'
@@ -32,12 +32,40 @@ export default {
           type: 'string[] | undefined',
           defaultValue: 'undefined',
           desc: {
-            'zh-CN': '时候启用历史记录',
-            'en-US': 'enable predefine or not'
+            'zh-CN': '预定义颜色色值',
+            'en-US': 'predefine color values'
           },
           mode: ['pc'],
           pcDemo: 'predefine'
         },
+        {
+          name: 'enable-history',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否启用预定义颜色',
+            'en-US': 'enable history or not'
+          },
+          mode: ['pc'],
+          pcDemo: 'history',
+          meta: {
+            stable: '3.19.0'
+          }
+        },
+        {
+          name: 'enable-predefine-color',
+          type: 'boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否启用预定义颜色',
+            'en-US': 'enable predefined colors or not'
+          },
+          mode: ['pc'],
+          pcDemo: 'predefine',
+          meta: {
+            stable: '3.19.0'
+          }
+        },
         {
           name: 'visible',
           type: 'boolean',
@@ -47,6 +75,21 @@ export default {
             'en-US': 'Is color select panel displayed by default'
           },
           mode: ['pc']
+        },
+        {
+          name: 'format',
+          type: "('hex'|'rgb'|'hsl'|'hsv')[]",
+          defaultValue: '[]',
+          desc: {
+            'zh-CN': '点击确认后, confirm的事件将会返回对应的format数值. 如果为空数组则表示禁用颜色格式下拉选择',
+            'en-US':
+              'After clicking confirm, the confirm event will return the corresponding format value If it is an empty array, it means that the color format dropdown selection is disabled'
+          },
+          mode: ['pc'],
+          pcDemo: 'format',
+          meta: {
+            stable: '3.19.0'
+          }
         }
       ],
       events: [

package/demos/apis/form.js

@@ -44,7 +44,7 @@ export default {
         {
           name: 'hide-required-asterisk',
           type: 'boolean',
-          defaultValue: 'true',
+          defaultValue: 'false',
           desc: {
             'zh-CN': '是否隐藏必填字段的标签旁边的红色星号',
             'en-US': 'Whether to hide the red asterisk next to the label of mandatory fields'