@opentinyvue/vue-docs 3.21.0

package/.prettierignore

@@ -0,0 +1,11 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json
+lib
+build
+demo/*.js
+demo/*.css
+module
+.*
+docs
+*.log
+node_modules

package/.prettierrc

@@ -0,0 +1,23 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "none",
+  "quoteProps": "preserve",
+  "endOfLine": "auto",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": true,
+  "jsxSingleQuote": false,
+  "useTabs": false,
+  "tabWidth": 2,
+  "proseWrap": "preserve",
+  "arrowParens": "always",
+  "overrides": [
+    {
+      "files": ".prettierrc",
+      "options": {
+        "parser": "json"
+      }
+    }
+  ]
+}

package/.stylelintignore

@@ -0,0 +1,6 @@
+*.js
+*.ts
+*.png
+*.eot
+*.ttf
+*.woff

package/.stylelintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: 'stylelint-config-standard', //stylelint-config-airbnb
+  rules: {
+    'string-quotes': 'single',
+    'property-no-unknown': true,
+    'selector-pseudo-class-no-unknown': true,
+    'at-rule-empty-line-before': 'always',
+    'block-no-empty': true,
+    'indentation': 4 // http://cui.ulanqab.huawei.com/#/articalDetail?id=b76da810d8ed8
+  }
+}

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 - present TinyVue Authors.
+Copyright (c) 2022 - present Huawei Cloud Computing Technologies Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/cp-component-md.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+for file in ./examples/sites/dist/\@demos/app/*
+do
+  component=${file##*/}
+  cp ./examples/sites/dist/\@demos/app/${component}/webdoc/*.md ./_site/\@demos/app/${component}/webdoc
+done

package/demos/.eslintrc.js

@@ -0,0 +1,9 @@
+/* eslint-env node */
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  rules: {
+    'no-console': 'off',
+    'vue/no-unused-vars': 'off'
+  }
+}

package/demos/apis/action-menu.js

@@ -0,0 +1,192 @@
+export default {
+  mode: ['pc'],
+  apis: [
+    {
+      name: 'action-menu',
+      type: 'component',
+      props: [
+        {
+          name: 'max-show-num',
+          type: 'number',
+          defaultValue: '2',
+          desc: {
+            'zh-CN': '最多显示菜单按钮的个数，其他菜单在下拉弹框显示',
+            'en-US':
+              'The maximum number of displayed menu buttons, and other menus are displayed in the drop-down pop-up box'
+          },
+          mode: ['pc'],
+          pcDemo: 'max-show-num'
+        },
+        {
+          name: 'mode',
+          type: '"default" | "card"',
+          defaultValue: '"default"',
+          desc: {
+            'zh-CN': '菜单按钮模式',
+            'en-US': 'Card mode'
+          },
+          mode: ['pc'],
+          pcDemo: 'card-mode'
+        },
+        {
+          name: 'more-text',
+          type: 'string',
+          defaultValue: "'更多'",
+          desc: {
+            'zh-CN': '下拉按钮文本',
+            'en-US': 'Dropdown button text'
+          },
+          mode: ['pc'],
+          pcDemo: 'more-text'
+        },
+        {
+          name: 'options',
+          typeAnchorName: 'IItemData',
+          type: 'IItemData[]',
+          defaultValue: '[]',
+          desc: {
+            'zh-CN': '菜单项列表的数据',
+            'en-US': 'Data for menu item list'
+          },
+          mode: ['pc'],
+          pcDemo: 'basic-usage'
+        },
+        {
+          name: 'popper-class',
+          type: 'string',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '下拉弹框的类名，用于自定义样式',
+            'en-US': 'The class name of the dropdown pop-up box, used for customizing styles'
+          },
+          mode: ['pc'],
+          pcDemo: 'popper-class'
+        },
+        {
+          name: 'show-icon',
+          type: 'boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示下拉触发源图标',
+            'en-US': 'Is the dropdown trigger source icon displayed'
+          },
+          mode: ['pc'],
+          pcDemo: 'icon'
+        },
+        {
+          name: 'spacing',
+          type: 'string | number',
+          defaultValue: "'5px'",
+          desc: {
+            'zh-CN': '菜单按钮之间的间距',
+            'en-US': 'Spacing between menu buttons'
+          },
+          mode: ['pc'],
+          pcDemo: 'spacing'
+        },
+        {
+          name: 'suffix-icon',
+          type: 'Component',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '下拉触发源图标',
+            'en-US': 'Dropdown trigger source icon'
+          },
+          mode: ['pc'],
+          pcDemo: 'icon'
+        },
+        {
+          name: 'text-field',
+          type: 'string',
+          defaultValue: "'label'",
+          desc: {
+            'zh-CN': '菜单按钮文本的键值',
+            'en-US': 'Key values for menu button text'
+          },
+          mode: ['pc'],
+          pcDemo: 'text-field'
+        }
+      ],
+      events: [
+        {
+          name: 'item-click',
+          typeAnchorName: 'IItemClickParams',
+          type: '(data:IItemClickParams) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '监听菜单项的点击事件',
+            'en-US': 'Listen for click events on menu items'
+          },
+          mode: ['pc'],
+          pcDemo: 'events'
+        },
+        {
+          name: 'more-click',
+          type: '() => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '监听下拉按钮的点击事件。trigger 为 click 时生效',
+            'en-US': 'Listen for the click event of the drop-down button. Effective when trigger is click'
+          },
+          mode: ['pc'],
+          pcDemo: 'events'
+        },
+        {
+          name: 'visible-change',
+          type: '(status: boolean) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '监听下拉弹框的显示或隐藏状态变化',
+            'en-US': 'Monitor the display or hidden state changes of the dropdown pop-up box'
+          },
+          mode: ['pc'],
+          pcDemo: 'events'
+        }
+      ],
+      methods: [],
+      slots: [
+        {
+          name: 'item',
+          type: '插槽',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '菜单选项插槽',
+            'en-US': 'Menu option slot'
+          },
+          mode: ['pc'],
+          pcDemo: 'slot-item'
+        }
+      ]
+    }
+  ],
+  types: [
+    {
+      name: 'IItemData',
+      type: 'interface',
+      code: `
+interface IItemData {
+  label?: string           // 菜单项文本
+  disabled?: boolean       // 是否禁用
+  divided?: boolean        // 是否显示分割线
+  children?: IItemData[]   // 菜单项子集
+  icon?: Component      // 菜单项图标
+}
+`
+    },
+    {
+      name: 'IItemClickParams',
+      type: 'interface',
+      code: `
+interface IItemClickParams {
+  itemData: IItemData     // 菜单项配置
+  vm: {                   // 菜单项实例
+    selected: boolean
+    textField: string
+    tipPosition: string
+    $el: HTMLElement
+  }       
+}
+`
+    }
+  ]
+}

package/demos/apis/action-sheet.js

@@ -0,0 +1,329 @@
+export default {
+  mode: ['mobile-first'],
+  apis: [
+    {
+      name: 'ActionSheet',
+      type: 'component',
+      props: [
+        {
+          name: 'before-close',
+          type: "(type: 'confirm' | 'close' | 'hide') => void",
+          defaultValue: '',
+          desc: {
+            'zh-CN': '关闭前执行的事件',
+            'en-US': 'Event executed before a action sheet is closed'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'before-close'
+        },
+        {
+          name: 'custom-class',
+          type: 'String',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '自定义 class 样式',
+            'en-US': 'Customize the class style'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'flex',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '弹性布局',
+            'en-US': 'Sets the elastic layout'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'fullscreen',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否全屏',
+            'en-US': 'Full screen display'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'fullscreen'
+        },
+        {
+          name: 'lock-scroll',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '弹出时是否禁用滚动条',
+            'en-US': 'Full screen display'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'mask',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示遮罩层',
+            'en-US': 'Indicates whether to display the mask layer'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'mask'
+        },
+        {
+          name: 'mask-closable',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '单击遮罩层是否关闭弹窗',
+            'en-US': 'Indicates whether to close the pop-up window when you click the mask layer'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'mask-event'
+        },
+        {
+          name: 'menus',
+          type: 'Array',
+          defaultValue: '[]',
+          desc: {
+            'zh-CN': '操作列表，设置 type 为 action 启用操作列表模式时有效。',
+            'en-US': 'Operation list. This parameter is valid only when type is set to action.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        },
+        {
+          name: 'show-close',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示关闭按钮',
+            'en-US': 'Indicates whether to display the close icon'
+          },
+          mode: ['mobile-first'],
+          mfDemo: ''
+        },
+        {
+          name: 'show-footer',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否显示底部',
+            'en-US': 'Indicates whether to display the bottom'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'show'
+        },
+        {
+          name: 'show-header',
+          type: 'Boolean',
+          defaultValue: 'true',
+          desc: {
+            'zh-CN': '是否显示头部',
+            'en-US': 'Indicates whether to display the header'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'show'
+        },
+        {
+          name: 'title',
+          type: 'String',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '面板标题',
+            'en-US': 'Panel Title'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        },
+        {
+          name: 'type',
+          type: 'Array[string]',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '设置 type 为 action 启用操作列表模式',
+            'en-US': 'Set type to action to enable the operation list mode.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        },
+        {
+          name: 'v-model',
+          type: 'Number | String | Array',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '双向数据绑定',
+            'en-US': 'bidirectional data binding'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'visible',
+          type: 'Boolean',
+          defaultValue: 'false',
+          desc: {
+            'zh-CN': '是否弹出面板',
+            'en-US': 'Indicates whether to display the panel.'
+          },
+          mode: ['mobile-first']
+        }
+      ],
+      events: [
+        {
+          name: 'click',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '点击列表选项时触发，设置 type 为 action 启用操作列表模式时有效。',
+            'en-US':
+              'This event is triggered when a list option is clicked. This event is valid only when type is set to action and the operation list mode is enabled.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        },
+        {
+          name: 'close',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '关闭面板时触发的事件。',
+            'en-US': 'Event triggered when a panel is closed.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        },
+        {
+          name: 'confirm',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '点击底部按钮时触发，设置 show-footer 为 true 时有效。',
+            'en-US':
+              'This event is triggered when the bottom button is clicked. It is valid only when show-footer is set to true.'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'update:modelValue',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '数据更新时触发的事件',
+            'en-US': 'The event triggered when data is updated'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'update:visible',
+          type: 'Function()',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '面板显示或隐藏时触发',
+            'en-US': 'Triggered when the panel is displayed or hidden'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        }
+      ],
+      methods: [
+        {
+          name: 'actionSelectOption',
+          type: '(item, index) => void',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '选择列表项，设置 type 为 action 启用操作列表模式时有效',
+            'en-US':
+              'Select a list item and set type to action. This parameter is valid only when the operation list mode is enabled.'
+          },
+          mode: ['mobile-first']
+        },
+        {
+          name: 'actionSelectOption(item, index)',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '选择列表项，设置 type 为 action 启用操作列表模式时有效',
+            'en-US': ''
+          },
+          mode: ['mobile-first'],
+          mfDemo: ''
+        },
+        {
+          name: 'close',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '关闭面板',
+            'en-US': 'Close the panel.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'action'
+        }
+      ],
+      slots: [
+        {
+          name: 'body-bottom',
+          desc: {
+            'zh-CN': '内容底部插槽',
+            'en-US': 'slot at the bottom of content'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'body-top',
+          desc: {
+            'zh-CN': '内容顶部插槽',
+            'en-US': 'slot at the top of content'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'default',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '组件默认插槽，设置 type 为 action 启用操作列表模式会提供参数 data 列表项和 index 列表索引。',
+            'en-US':
+              'Component default slot. Set type to action to enable the operation list mode. The parameter data list item and index list index are provided.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'footer',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '底部插槽，设置 show-footer 为 true 时有效',
+            'en-US': 'Bottom slot. This parameter is valid only when show-footer is set to true.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'header-left',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '头部左侧插槽，设置 show-header 为 true 时有效',
+            'en-US': 'Slot on the left of the header. This parameter is valid only when show-header is set to true.'
+          },
+          mode: ['mobile-first'],
+          mfDemo: 'slot'
+        },
+        {
+          name: 'header-right',
+          type: '',
+          defaultValue: '',
+          desc: {
+            'zh-CN': '头部右侧插槽，设置 show-header 为 true 时有效',
+            'en-US': ''
+          },
+          mode: ['mobile-first'],
+          mfDemo: ''
+        }
+      ]
+    }
+  ]
+}