docs: change props type VueComponent to Component (#1244)

This commit is contained in:
Kagol 2024-01-03 16:54:20 +08:00 committed by GitHub
parent c3af3083f8
commit f5da8acbcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 60 additions and 57 deletions

View File

@ -173,7 +173,7 @@ export default {
},
{
'name': 'suffix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '下拉触发源图标',
@ -259,7 +259,7 @@ interface IItemData {
disabled: boolean // 是否禁用
divided: boolean // 是否显示分割线
children: IItemData[] // 菜单项子集
icon: VueComponent // 菜单项图标
icon: Component // 菜单项图标
}
`
},

View File

@ -132,7 +132,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': {
'zh-CN': '传入图标组件自定义警告的图标,默认会根据 type 值自动使用对应图标',

View File

@ -271,14 +271,14 @@ export default {
},
{
'name': 'prefix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '输入框头部图标', 'en-US': 'Icon on the header of the text box' },
'demoId': 'custom-icon'
},
{
'name': 'suffix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '输入框尾部图标', 'en-US': 'Icon at the end of the text box' },
'demoId': 'custom-icon'

View File

@ -160,7 +160,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': {
'zh-CN': '按钮左侧展示的图标接收为Icon组件',

View File

@ -271,7 +271,7 @@ export default {
},
{
'name': 'suffix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '下拉触发源图标',
@ -473,7 +473,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '内嵌图标',

View File

@ -743,7 +743,7 @@ interface IThumbOption {
showTooltip: boolean // 文件名超出隐藏显示时是否启用tip默认false
popperClass: string // 弹窗列表自定义类名
downloadFile: (file) => void // 点击下载按钮执行函数
icon: string | VueComponent // 列表结果前 icon ,默认为 'icon-attachment'
icon: string | Component // 列表结果前 icon ,默认为 'icon-attachment'
}
`
}

View File

@ -634,7 +634,7 @@ export default {
},
{
name: 'validate-icon',
type: 'VueComponent',
type: 'Component',
'defaultValue': '--',
desc: {
'zh-CN': '校验提示框的图标,类型为组件',

View File

@ -373,7 +373,7 @@ export default {
},
{
'name': 'loading-component',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': { 'zh-CN': '自定义表格loading', 'en-US': 'Whether the table is being loaded.' },
'demoId': 'grid-loading#loading-grid-custom-loading'
@ -1589,7 +1589,7 @@ export default {
},
{
'name': 'cancel-page-change',
'type': '($grid: VueComponent)=> void',
'type': '($grid: Component)=> void',
'defaultValue': '--',
'desc': {
'zh-CN': '切换分页时有未保存的数据时,提示框确定按钮事件',
@ -1778,7 +1778,7 @@ export default {
},
{
'name': 'radio-change',
'type': '($table: VueComponent, event: Event)=> void',
'type': '($table: Component, event: Event)=> void',
'defaultValue': '--',
'desc': {
'zh-CN': '只对 type=radio 有效,当手动勾选并且值发生改变时触发的事件',
@ -2196,7 +2196,7 @@ export default {
},
{
'name': 'editor',
'type': 'IEditorConfig | (h, {row:Row, column: IColumnConfig})=> VueComponent',
'type': 'IEditorConfig | (h, {row:Row, column: IColumnConfig})=> Component',
'typeAnchorName': 'IEditorConfig',
'defaultValue': '--',
'desc': {
@ -2219,7 +2219,7 @@ export default {
},
{
'name': 'renderer',
'type': 'IEditorConfig | (h, {row: IRow, column: IColumnConfig})=> VueComponent',
'type': 'IEditorConfig | (h, {row: IRow, column: IColumnConfig})=> Component',
'typeAnchorName': 'IEditorConfig',
'defaultValue': '--',
'desc': {
@ -2500,7 +2500,7 @@ interface IColumnConfig {
type: 'interface',
code: `
interface IPagerConfig {
component?: VueComponent
component?: Component
attrs: {
currentPage: number
pageSize: number
@ -2833,7 +2833,7 @@ interface IRecordset {
code: `
interface IPageChangeArgs {
// table组件vue实例
$grid: VueComponent
$grid: Component
// 当前页码
currentPage: number
//当前分页组件布局信息 'total, prev, pager, next, jumper, sizes'
@ -2873,7 +2873,7 @@ interface IBeforePageChangeArgs {
code: `
interface IToolbarButtonClickArgs {
//表格组件实例对象信息
$grid: VueComponent
$grid: Component
//按钮信息对象
button: {
code: string
@ -2994,7 +2994,7 @@ interface IEditDisabledArgs {
code: `
interface IFilterChangeArgs {
//表格的信息对象
$table: VueComponent
$table: Component
//过滤列的过滤数据信息
filters: object
}
@ -3008,7 +3008,7 @@ interface IFooterCellClickArgs {
$columnIndex: number
$rowIndex: number
// table组件vue实例
$table: VueComponent
$table: Component
// 当前单元格节点
cell: HTMLElement
// 当前列信息
@ -3025,7 +3025,7 @@ interface IContextMenuArgs {
$columnIndex: number
$rowIndex: number
// table组件vue实例
$table: VueComponent
$table: Component
// 当前单元格节点
cell: HTMLElement
// 当前列信息
@ -3046,7 +3046,7 @@ interface IFooterCellDblClickArgs {
$columnIndex: number
$rowIndex: number
// table组件vue实例
$table: VueComponent
$table: Component
// 当前单元格节点
cell: HTMLElement
// 当前列信息
@ -3063,7 +3063,7 @@ interface IHeaderCellClickArgs {
$columnIndex: number
$rowIndex: number
// table组件vue实例
$table: VueComponent
$table: Component
// 点击表头单元格
cell: HTMLElement
// 当前列信息
@ -3086,7 +3086,7 @@ interface IHeaderCellDblClickArgs {
// 列索引
columnIndex: number
// table组件 vue实例
$table: VueComponent
$table: Component
// 点击的单元格dom
cell: HTMLElement
}
@ -3098,7 +3098,7 @@ interface IHeaderCellDblClickArgs {
code: `
interface IResizableChangeArgs {
// table组件的vue 实例
$table: VueComponent,
$table: Component,
// 列配置信息
column: object
// 拖动列的索引
@ -3114,7 +3114,7 @@ interface IResizableChangeArgs {
code: `
interface IScrollArgs {
// 表格实例对象信息
$table: VueComponent
$table: Component
fixed: boolean
// X轴滚动
isX: boolean
@ -3137,7 +3137,7 @@ interface ISelectAllArgs {
$rowIndex: number
$seq: string
// 表格实例对象信息
$table: VueComponent
$table: Component
// 勾选状态
checked: boolean
// 列信息
@ -3165,7 +3165,7 @@ interface ISelectAllArgs {
code: `
interface IToggleExpandChangeArgs {
// 表格实例对象信息
$table: VueComponent,
$table: Component,
//点击展开行的数据信息对象
row: IRow
// 点击展开行的下标
@ -3179,7 +3179,7 @@ interface IToggleExpandChangeArgs {
code: `
interface IToggleTreeChangeArgs {
// 表格实例对象信息
$table: VueComponent,
$table: Component,
//点击展开行的数据信息对象
row: IRow
// 点击展开行的下标
@ -3209,7 +3209,7 @@ interface IValidErrorArgs {
code: `
interface ISortChangeArgs {
// 表格实例对象信息
$grid: VueComponent
$grid: Component
// 列信息
column: IColumnConfig
// 排序的字段名
@ -3272,7 +3272,7 @@ interface IFormatConfig {
code: `
interface IButtonClick {
// 表格组件实例对象信息
$grid: VueComponent
$grid: Component
// 按钮列表信息对象
button: {
code: string
@ -3333,7 +3333,7 @@ interface IExportCsvOptions {
code: `
interface IEditorConfig {
// 内置组件名称或者自定义组件实例
component: 'input' | 'select' | VueComponent
component: 'input' | 'select' | Component
// 传递给组件的事件集合
events?: {
[event]: ()=> void

View File

@ -357,7 +357,7 @@ export default {
},
{
'name': 'prefix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '输入框头部图标',
@ -438,7 +438,7 @@ export default {
},
{
'name': 'suffix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '输入框尾部图标',

View File

@ -79,7 +79,7 @@ export default {
'props': [
{
'name': 'delimiter',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '设置IP段之间的分隔符默认图标为IconDotIpv4',

View File

@ -95,7 +95,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '图标组件', 'en-US': 'Icon component' },
'demoId': 'custom-icon'

View File

@ -148,7 +148,7 @@ export default {
},
{
'name': 'spinner',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '自定义加载图标', 'en-US': 'Customized loading icon class name' },
'demoId': 'spinner'

View File

@ -109,7 +109,10 @@ export default {
{
'demoId': 'verticalOffset',
'name': { 'zh-CN': '垂直偏移量', 'en-US': 'Vertical Offset' },
'desc': { 'zh-CN': '<p>可通过 <code>verticalOffset</code> 设置垂直方向偏离距离。', 'en-US': '<p> The vertical deviation distance can be set by using <code>verticalOffset</code>.' },
'desc': {
'zh-CN': '<p>可通过 <code>verticalOffset</code> 设置垂直方向偏离距离。',
'en-US': '<p> The vertical deviation distance can be set by using <code>verticalOffset</code>.'
},
'codeFiles': ['verticalOffset.vue']
},
{
@ -120,13 +123,13 @@ export default {
<div>可通过 <code>beforeClose</code> </div>
<div>可通过 <code>onClose</code> </div>
</p>`,
'en-US':`<p>
'en-US': `<p>
<div> The property <code>beforeClose</code> sets the event before the notification box closes. </div>
<div> can be set through the <code>onClose</code> property to notify the event that is triggered when the close button is clicked. </div>
</p>`
},
'codeFiles': ['notify-events.vue']
},
}
],
apis: [
{
@ -135,7 +138,7 @@ export default {
'props': [
{
'name': 'type',
'type':`'info' | 'success' | 'warning' | 'error'`,
'type': `'info' | 'success' | 'warning' | 'error'`,
'defaultValue': 'info',
'desc': {
'zh-CN': '通知消息类型',
@ -205,14 +208,14 @@ export default {
},
{
'name': 'closeIcon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': 'IconClose',
'desc': { 'zh-CN': '关闭图标组件对象', 'en-US': 'Close icon component object' },
'demoId': 'closeIcon'
},
{
'name': 'statusIcon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': 'IconInfoSolid',
'desc': { 'zh-CN': '类型图标组件对象', 'en-US': 'Type icon component object' },
'demoId': 'statusIcon'

View File

@ -156,7 +156,7 @@ export default {
},
{
'name': 'type',
'type': "'info' | 'success' | 'warning' | 'error' | VueComponent",
'type': "'info' | 'success' | 'warning' | 'error' | Component",
'defaultValue': '--',
'desc': {
'zh-CN': '提示图标类型,可以传入自定义图标',

View File

@ -1077,7 +1077,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '自定义选项的图标',
@ -1140,7 +1140,7 @@ interface IOption {
value?: string | number
label?: string
disabled?: boolean
icon?: VueComponent
icon?: Component
required?:boolean
}
`

View File

@ -366,12 +366,12 @@ export default {
},
{
'name': 'click',
'type': '(TabItem: VueComponent, event: Event) => void',
'type': '(TabItem: Component, event: Event) => void',
'defaultValue': '',
'desc': {
'zh-CN': '点击页签项时触发tab 被选中时触发; TabItem: 点中页签项的vueComponent对象信息',
'en-US':
'Trigger an event when clicking on a tab item, Triggered when tab is selected; TabItem: Click on the VueComponent object information of the tab item in the middle'
'Trigger an event when clicking on a tab item, Triggered when tab is selected; TabItem: Click on the Component object information of the tab item in the middle'
},
'demoId': 'tabs-events-click'
},

View File

@ -310,9 +310,9 @@ export default {
'defaultValue': '',
'desc': {
'zh-CN':
'展开节点后的事件。;节点被展开时触发的事件;//参数arg1:\n{children: 点击节点的子节点, id: 点击节点的id, label: 点击节点的title}\n//参数arg2:\nVueComponent 点击节点的componet对象信息\n//参数arg3:\n{ children: 点击节点的子节点id: 点击节点的id, label: 点击节点的title}',
'展开节点后的事件。;节点被展开时触发的事件;//参数arg1:\n{children: 点击节点的子节点, id: 点击节点的id, label: 点击节点的title}\n//参数arg2:\nComponent 点击节点的componet对象信息\n//参数arg3:\n{ children: 点击节点的子节点id: 点击节点的id, label: 点击节点的title}',
'en-US':
'Event after a node is expanded. ; Event triggered when a node is expanded; / / Parameter arg1:\n{children: child node of the clicked node, id: ID of the clicked node, label: title of the clicked node}\n//Parameter arg2:\nVueComponent Componet object information of the clicked node\n//Parameter arg3:\n{children: subnode ID of the clicked node: ID of the clicked node, label: Click title} of the node'
'Event after a node is expanded. ; Event triggered when a node is expanded; / / Parameter arg1:\n{children: child node of the clicked node, id: ID of the clicked node, label: title of the clicked node}\n//Parameter arg2:\nComponent Componet object information of the clicked node\n//Parameter arg3:\n{children: subnode ID of the clicked node: ID of the clicked node, label: Click title} of the node'
},
'demoId': 'node-expand'
},

View File

@ -561,7 +561,7 @@ export default {
},
{
'name': 'prefix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': {
'zh-CN': '自定义前置图标',
@ -571,7 +571,7 @@ export default {
},
{
'name': 'suffix-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': {
'zh-CN': '自定义后置图标',
@ -581,7 +581,7 @@ export default {
},
{
'name': 'search-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '--',
'desc': {
'zh-CN': '自定义搜索图标',
@ -848,7 +848,7 @@ interface ITreeNodeData {
// show-number 时展示的字段
"number"?: number | string
// 自定义每个节点的图标
"customIcon": VueComponent
"customIcon": Component
}
`
},

View File

@ -471,7 +471,7 @@ export default {
},
{
'name': 'icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': {
'zh-CN': '自定义节点图标',
@ -481,7 +481,7 @@ export default {
},
{
'name': 'expand-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '指示展开的图标', 'en-US': 'Indicates the expanded icon' },
'demoId': 'icons'
@ -498,7 +498,7 @@ export default {
},
{
'name': 'shrink-icon',
'type': 'VueComponent',
'type': 'Component',
'defaultValue': '',
'desc': { 'zh-CN': '指示收缩的图标', 'en-US': 'Icon indicating shrink' },
'demoId': 'icons'