@vtj/materials 0.8.43 → 0.8.45

package/src/antdv/menu.ts

@@ -0,0 +1,314 @@
+import type { MaterialDescription } from '@vtj/core';
+
+const components: MaterialDescription[] = [
+  {
+    name: 'AMenu',
+    alias: 'Menu',
+    label: '导航菜单',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/menu-cn',
+    props: [
+      {
+        name: 'forceSubMenuRender',
+        label: 'forceSubMenuRender',
+        title: '在子菜单展示之前就渲染进 DOM',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'inlineCollapsed',
+        label: 'inlineCollapsed',
+        title: 'inline 时菜单是否收起状态',
+        setters: 'BooleanSetter'
+      },
+      {
+        name: 'inlineIndent',
+        label: 'inlineIndent',
+        title: 'inline 模式的菜单缩进宽度',
+        setters: 'NumberSetter',
+        defaultValue: 24
+      },
+      {
+        name: 'items',
+        label: 'items',
+        title: '菜单内容',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'mode',
+        label: 'mode',
+        title: '菜单类型，现在支持垂直、水平、和内嵌模式三种',
+        setters: 'SelectSetter',
+        options: ['vertical', 'horizontal', 'inline'],
+        defaultValue: 'vertical'
+      },
+      {
+        name: 'multiple',
+        label: 'multiple',
+        title: '是否允许多选',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'openKeys',
+        label: 'openKeys',
+        title: '当前展开的 SubMenu 菜单项 key 数组',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'selectable',
+        label: 'selectable',
+        title: '是否允许选中',
+        setters: 'BooleanSetter',
+        defaultValue: true
+      },
+      {
+        name: 'selectedKeys',
+        label: 'selectedKeys',
+        title: '当前选中的菜单项 key 数组',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'subMenuCloseDelay',
+        label: 'subMenuCloseDelay',
+        title: '用户鼠标离开子菜单后关闭延时，单位：秒',
+        setters: 'NumberSetter',
+        defaultValue: 0.1
+      },
+      {
+        name: 'subMenuOpenDelay',
+        label: 'subMenuOpenDelay',
+        title: '用户鼠标进入子菜单后开启延时，单位：秒',
+        setters: 'NumberSetter',
+        defaultValue: 0
+      },
+      {
+        name: 'theme',
+        label: 'theme',
+        title: '主题颜色',
+        setters: 'SelectSetter',
+        options: ['light', 'dark'],
+        defaultValue: 'light'
+      },
+      {
+        name: 'triggerSubMenuAction',
+        label: 'triggerSubMenuAction',
+        title: '修改 Menu 子菜单的触发方式',
+        setters: 'SelectSetter',
+        options: ['click', 'hover'],
+        defaultValue: 'hover'
+      }
+    ],
+    events: [
+      'click',
+      'deselect',
+      'openChange',
+      'select',
+      'update:openKeys',
+      'update:selectedKeys'
+    ],
+    slots: ['overflowedIndicator'],
+    snippet: {
+      props: {
+        selectedKeys: ['mail'],
+        mode: 'horizontal',
+        items: [
+          {
+            key: 'mail',
+            label: 'Navigation One',
+            title: 'Navigation One'
+          },
+          {
+            key: 'app',
+            label: 'Navigation Two',
+            title: 'Navigation Two'
+          },
+          {
+            key: 'sub1',
+            label: 'Navigation Three - Submenu',
+            title: 'Navigation Three - Submenu',
+            children: [
+              {
+                type: 'group',
+                label: 'Item 1',
+                children: [
+                  {
+                    label: 'Option 1',
+                    key: 'setting:1'
+                  },
+                  {
+                    label: 'Option 2',
+                    key: 'setting:2'
+                  }
+                ]
+              },
+              {
+                type: 'group',
+                label: 'Item 2',
+                children: [
+                  {
+                    label: 'Option 3',
+                    key: 'setting:3'
+                  },
+                  {
+                    label: 'Option 4',
+                    key: 'setting:4'
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            key: 'alipay',
+            label: 'Navigation Four - Link',
+            title: 'Navigation Four - Link'
+          }
+        ]
+      }
+    }
+  },
+  {
+    name: 'AMenuItem',
+    alias: 'Item',
+    parent: 'Menu',
+    label: '导航菜单项',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/menu-cn',
+    props: [
+      {
+        name: 'disabled',
+        label: 'disabled',
+        title: '是否禁用',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'key',
+        label: 'key',
+        title: 'item 的唯一标志',
+        setters: ['StringSetter', 'NumberSetter']
+      },
+      {
+        name: 'title',
+        label: 'title',
+        title: '设置收缩时展示的悬浮标题',
+        setters: 'StringSetter'
+      }
+    ],
+    slots: ['icon', 'title'],
+    snippet: {
+      children: '菜单项',
+      props: {
+        key: 'key',
+        title: 'Navigation One'
+      }
+    }
+  },
+  {
+    name: 'AMenuSubMenu',
+    alias: 'SubMenu',
+    childIncludes: ['AMenuItem', 'AMenuSubMenu'],
+    parent: 'Menu',
+    label: '导航子菜单',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/menu-cn',
+    props: [
+      {
+        name: 'disabled',
+        label: 'disabled',
+        title: '是否禁用',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'key',
+        label: 'key',
+        title: '唯一标志, 必填',
+        setters: ['StringSetter', 'NumberSetter']
+      },
+      {
+        name: 'popupClassName',
+        label: 'popupClassName',
+        title: '子菜单样式',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'popupOffset',
+        label: 'popupOffset',
+        title: '子菜单偏移量，mode="inline" 时无效',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'title',
+        label: 'title',
+        title: '子菜单项值',
+        setters: 'StringSetter'
+      }
+    ],
+    events: ['titleClick'],
+    slots: ['expandIcon', 'icon', 'title'],
+    snippet: {
+      //Menu.SubMenu 的子元素必须是 MenuItem 或者 SubMenu.
+      //SubMenu 必须传递 key，如不传递，该 SubMenu 下子元素将提前渲染，而且部分场景无法进行有效高亮。
+      children: [
+        {
+          name: 'AMenuItem',
+          children: '菜单项',
+          props: {
+            key: 'key',
+            title: 'Navigation One -- AMenuItem'
+          }
+        }
+      ]
+    }
+  },
+  {
+    name: 'AMenuItemGroup',
+    alias: 'ItemGroup',
+    childIncludes: ['AMenuItem'],
+    parent: 'Menu',
+    label: '导航菜单项组',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/menu-cn',
+    props: [
+      {
+        name: 'title',
+        label: 'title',
+        title: '分组标题',
+        setters: 'StringSetter'
+      }
+    ],
+    slots: ['title'],
+    snippet: {
+      //? children 只能为 AMenuItem
+      children: [
+        {
+          name: 'AMenuItem',
+          children: '菜单项',
+          props: {
+            key: 'key',
+            title: 'Navigation One -- AMenuItem'
+          }
+        }
+      ]
+    }
+  },
+  {
+    name: 'AMenuDivider',
+    alias: 'Divider',
+    parent: 'Menu',
+    label: '菜单项分割线',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/menu-cn',
+    props: [
+      {
+        name: 'dashed',
+        label: 'dashed',
+        title: '是否虚线',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      }
+    ]
+  }
+];
+export default components;

package/src/antdv/message.ts

@@ -0,0 +1,13 @@
+import type { MaterialDescription } from '@vtj/core';
+
+const components: MaterialDescription[] = [
+  {
+    name: 'AMessage',
+    alias: 'Message',
+    label: '全局提示',
+    categoryId: 'feedback',
+    doc: 'https://www.antdv.com/components/message-cn',
+    props: []
+  }
+];
+export default components;

package/src/antdv/modal.ts

@@ -0,0 +1,182 @@
+import type { MaterialDescription } from '@vtj/core';
+
+const components: MaterialDescription[] = [
+  {
+    name: 'AModal',
+    alias: 'Modal',
+    label: '对话框',
+    categoryId: 'feedback',
+    doc: 'https://www.antdv.com/components/modal-cn',
+    props: [
+      {
+        name: 'afterClose',
+        label: 'afterClose',
+        title: 'Modal 完全关闭后的回调',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'bodyStyle',
+        label: 'bodyStyle',
+        title: 'Modal body 样式',
+        setters: 'ObjectSetter',
+        defaultValue: {}
+      },
+      {
+        name: 'cancelButtonProps',
+        label: 'cancelButtonProps',
+        title: 'cancel 按钮 props',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'cancelText',
+        label: 'cancelText',
+        title: '取消按钮文字',
+        setters: 'StringSetter',
+        defaultValue: '取消'
+      },
+      {
+        name: 'centered',
+        label: 'centered',
+        title: '垂直居中展示 Modal',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'closable',
+        label: 'closable',
+        title: '是否显示右上角的关闭按钮',
+        setters: 'BooleanSetter',
+        defaultValue: true
+      },
+      {
+        name: 'confirmLoading',
+        label: 'confirmLoading',
+        title: '确定按钮 loading',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'destroyOnClose',
+        label: 'destroyOnClose',
+        title: '关闭时销毁 Modal 里的子元素',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'footer',
+        label: 'footer',
+        title: '底部内容，当不需要默认底部按钮时，可以设为 :footer="null"',
+        setters: 'StringSetter',
+        defaultValue: '确定取消按钮'
+      },
+      {
+        name: 'forceRender',
+        label: 'forceRender',
+        title: '强制渲染 Modal',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'getContainer',
+        label: 'getContainer',
+        title: '指定 Modal 挂载的 HTML 节点',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'keyboard',
+        label: 'keyboard',
+        title: '是否支持键盘 esc 关闭',
+        setters: 'BooleanSetter',
+        defaultValue: true
+      },
+      {
+        name: 'mask',
+        label: 'mask',
+        title: '是否展示遮罩',
+        setters: 'BooleanSetter',
+        defaultValue: true
+      },
+      {
+        name: 'maskClosable',
+        label: 'maskClosable',
+        title: '点击蒙层是否允许关闭',
+        setters: 'BooleanSetter',
+        defaultValue: true
+      },
+      {
+        name: 'maskStyle',
+        label: 'maskStyle',
+        title: '遮罩样式',
+        setters: 'ObjectSetter',
+        defaultValue: {}
+      },
+      {
+        name: 'okButtonProps',
+        label: 'okButtonProps',
+        title: 'ok 按钮 props',
+        setters: 'ArraySetter'
+      },
+      {
+        name: 'okText',
+        label: 'okText',
+        title: '确认按钮文字',
+        setters: 'StringSetter',
+        defaultValue: '确认'
+      },
+      {
+        name: 'okType',
+        label: 'okType',
+        title: '确认按钮类型',
+        setters: 'StringSetter',
+        defaultValue: 'primary'
+      },
+      {
+        name: 'title',
+        label: 'title',
+        title: '标题',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'open',
+        label: 'open',
+        title: '对话框是否可见',
+        setters: 'BooleanSetter',
+        defaultValue: false
+      },
+      {
+        name: 'width',
+        label: 'width',
+        title: '宽度',
+        setters: ['StringSetter', 'NumberSetter'],
+        defaultValue: 520
+      },
+      {
+        name: 'wrapClassName',
+        label: 'wrapClassName',
+        title: '对话框外层容器的类名',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'zIndex',
+        label: 'zIndex',
+        title: '设置 Modal 的 z-index',
+        setters: 'NumberSetter',
+        defaultValue: 1000
+      }
+    ],
+    events: ['cancel', 'ok', 'update:open'],
+    slots: ['cancelText', 'closeIcon', 'footer', 'okText', 'title'],
+    snippet: {
+      props: {
+        open: true,
+        title: 'Basic Modal'
+      },
+      children: [
+        { name: 'p', children: 'Some contents...' },
+        { name: 'p', children: 'Some contents...' },
+        { name: 'p', children: 'Some contents...' }
+      ]
+    }
+  }
+];
+export default components;

package/src/antdv/notification.ts

@@ -0,0 +1,117 @@
+import type { MaterialDescription } from '@vtj/core';
+const components: MaterialDescription[] = [
+  {
+    name: 'ANotification',
+    alias: 'Notification',
+    label: '通知提醒框',
+    categoryId: 'feedback',
+    doc: 'https://www.antdv.com/components/notification-cn',
+    props: [
+      {
+        name: 'bottom',
+        label: 'bottom',
+        title: '消息从底部弹出时，距离底部的位置，单位像素',
+        setters: 'StringSetter',
+        defaultValue: '24px'
+      },
+      {
+        name: 'btn',
+        label: 'btn',
+        title: '自定义关闭按钮',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'class',
+        label: 'class',
+        title: '自定义 CSS class',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'closeIcon',
+        label: 'closeIcon',
+        title: '自定义关闭图标',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'description',
+        label: 'description',
+        title: '通知提醒内容，必选',
+        setters: ['StringSetter', 'FunctionSetter']
+      },
+      {
+        name: 'duration',
+        label: 'duration',
+        title: '默认 4.5 秒后自动关闭，配置为 null 则不自动关闭',
+        setters: 'NumberSetter',
+        defaultValue: 4.5
+      },
+      {
+        name: 'getContainer',
+        label: 'getContainer',
+        title: '配置渲染节点的输出位置',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'icon',
+        label: 'icon',
+        title: '自定义图标',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'key',
+        label: 'key',
+        title: '当前通知唯一标志',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'message',
+        label: 'message',
+        title: '通知提醒标题，必选',
+        setters: ['StringSetter', 'FunctionSetter']
+      },
+      {
+        name: 'placement',
+        label: 'placement',
+        title:
+          '弹出位置，可选 top topLeft topRight bottom bottomLeft bottomRight',
+        setters: 'SelectSetter',
+        options: [
+          'top',
+          'topLeft',
+          'topRight',
+          'bottom',
+          'bottomLeft',
+          'bottomRight'
+        ],
+        defaultValue: 'topRight'
+      },
+      {
+        name: 'style',
+        label: 'style',
+        title: '自定义内联样式',
+        setters: ['ObjectSetter', 'StringSetter']
+      },
+      {
+        name: 'top',
+        label: 'top',
+        title: '消息从顶部弹出时，距离顶部的位置，单位像素',
+        setters: 'StringSetter',
+        defaultValue: '24px'
+      },
+      {
+        name: 'onClick',
+        label: 'onClick',
+        title: '点击通知时触发的回调函数',
+        setters: 'FunctionSetter'
+      },
+      {
+        name: 'onClose',
+        label: 'onClose',
+        title: '点击默认关闭按钮时触发的回调函数',
+        setters: 'FunctionSetter'
+      }
+    ],
+    slots: ['btn', 'closeIcon', 'description', 'message']
+  }
+];
+export default components;

package/src/antdv/pageHeader.ts

@@ -0,0 +1,79 @@
+import type { MaterialDescription } from '@vtj/core';
+
+const components: MaterialDescription[] = [
+  {
+    name: 'APageHeader',
+    alias: 'PageHeader',
+    label: '页头',
+    categoryId: 'nav',
+    doc: 'https://www.antdv.com/components/page-header-cn',
+    props: [
+      {
+        name: 'avatar',
+        label: 'avatar',
+        title: '标题栏旁的头像',
+        setters: 'ObjectSetter'
+      },
+      {
+        name: 'backIcon',
+        label: 'backIcon',
+        title: '自定义 back icon ，如果为 false 不渲染 back icon',
+        setters: 'StringSetter'
+      },
+      {
+        name: 'breadcrumb',
+        label: 'breadcrumb',
+        title: '面包屑的配置',
+        setters: 'ObjectSetter'
+      },
+      {
+        name: 'extra',
+        label: 'extra',
+        title: '操作区，位于 title 行的行尾',
+        setters: 'StringSetter' // slot
+      },
+      {
+        name: 'footer',
+        label: 'footer',
+        title: 'PageHeader 的页脚，一般用于渲染 TabBar',
+        setters: 'StringSetter' // slot
+      },
+      {
+        name: 'ghost',
+        label: 'ghost',
+        title: 'pageHeader 的类型，将会改变背景颜色',
+        setters: 'BooleanSetter',
+        defaultValue: 'true'
+      },
+      {
+        name: 'subTitle',
+        label: 'subTitle',
+        title: '自定义的二级标题文字',
+        setters: 'StringSetter' // slot
+      },
+      {
+        name: 'tags',
+        label: 'tags',
+        title: 'title 旁的 tag 列表',
+        setters: ['ObjectSetter', 'ArraySetter'] //?? 	Tag[] | Tag
+      },
+      {
+        name: 'title',
+        label: 'title',
+        title: '自定义标题文字',
+        setters: 'StringSetter' // slot
+      }
+    ],
+    events: ['back'],
+    slots: ['backIcon', 'extra', 'footer', 'subTitle', 'title'],
+    snippet: {
+      name: 'APageHeader',
+      props: {
+        title: 'Title',
+        subTitle: 'This is a subtitle',
+        style: { border: '1px solid rgb(235, 237, 240)' }
+      }
+    }
+  }
+];
+export default components;