chore(site): [input, cascader, autocomplete] Perfect document format (#1044)
This commit is contained in:
parent
53a0cf020a
commit
9a295ede51
|
@ -6,8 +6,8 @@ export default {
|
||||||
'demoId': 'basic-usage',
|
'demoId': 'basic-usage',
|
||||||
'name': { 'zh-CN': '基础用法', 'en-US': 'Basic Usage' },
|
'name': { 'zh-CN': '基础用法', 'en-US': 'Basic Usage' },
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '',
|
'zh-CN': '<p>通过设置 <code>fetch-suggestions</code> 方法设置输入建议。</p>',
|
||||||
'en-US': ''
|
'en-US': '<p> Set input suggestions by setting the <code>fetch-suggestions</code> method.'
|
||||||
},
|
},
|
||||||
'codeFiles': ['basic-usage.vue']
|
'codeFiles': ['basic-usage.vue']
|
||||||
},
|
},
|
||||||
|
@ -43,8 +43,10 @@ export default {
|
||||||
'demoId': 'slot',
|
'demoId': 'slot',
|
||||||
'name': { 'zh-CN': '插槽', 'en-US': 'slot' },
|
'name': { 'zh-CN': '插槽', 'en-US': 'slot' },
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '<p>分别配置 <code>prepend</code>、<code>append</code>、<code>prefix</code>、<code>suffix</code>、<code>default</code> 插槽。</p>',
|
'zh-CN':
|
||||||
'en-US': '<p>Configure <code>prepend</code>, <code>append</code>, <code>prefix</code>, <code>default</code>, and <code>suffix</code> slots.</p>'
|
'<p>分别配置 <code>prepend</code>、<code>append</code>、<code>prefix</code>、<code>suffix</code>、<code>default</code> 插槽。</p>',
|
||||||
|
'en-US':
|
||||||
|
'<p>Configure <code>prepend</code>, <code>append</code>, <code>prefix</code>, <code>default</code>, and <code>suffix</code> slots.</p>'
|
||||||
},
|
},
|
||||||
'codeFiles': ['slot.vue']
|
'codeFiles': ['slot.vue']
|
||||||
},
|
},
|
||||||
|
@ -113,8 +115,7 @@ export default {
|
||||||
'demoId': 'placement',
|
'demoId': 'placement',
|
||||||
'name': { 'zh-CN': '菜单弹出位置', 'en-US': 'Menu Pop-up Position' },
|
'name': { 'zh-CN': '菜单弹出位置', 'en-US': 'Menu Pop-up Position' },
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN':
|
'zh-CN': '<p><code>placement</code> 属性可以设置菜单弹出位置,默认为 <code>bottom-start</code>。</p>\n',
|
||||||
'<p><code>placement</code> 属性可以设置菜单弹出位置,默认为 <code>bottom-start</code>。</p>\n',
|
|
||||||
'en-US':
|
'en-US':
|
||||||
'<p><code>placement</code> property can be used to set the menu pop-up position. The default value is <code>bottom-start</code>. </p>\n'
|
'<p><code>placement</code> property can be used to set the menu pop-up position. The default value is <code>bottom-start</code>. </p>\n'
|
||||||
},
|
},
|
||||||
|
@ -182,7 +183,7 @@ export default {
|
||||||
{
|
{
|
||||||
'name': 'value-key',
|
'name': 'value-key',
|
||||||
'type': 'string',
|
'type': 'string',
|
||||||
'defaultValue': 'value',
|
'defaultValue': `'value'`,
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '在输入建议对象中,用于显示和匹配输入的键名',
|
'zh-CN': '在输入建议对象中,用于显示和匹配输入的键名',
|
||||||
'en-US': 'In the Input Suggestion object, key names for displaying and matching inputs'
|
'en-US': 'In the Input Suggestion object, key names for displaying and matching inputs'
|
||||||
|
@ -210,8 +211,7 @@ export default {
|
||||||
'defaultValue': `'bottom-start'`,
|
'defaultValue': `'bottom-start'`,
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '菜单弹出位置',
|
'zh-CN': '菜单弹出位置',
|
||||||
'en-US':
|
'en-US': 'Menu pop-up position'
|
||||||
'Menu pop-up position'
|
|
||||||
},
|
},
|
||||||
'demoId': 'placement'
|
'demoId': 'placement'
|
||||||
},
|
},
|
||||||
|
@ -249,7 +249,7 @@ export default {
|
||||||
'name': 'name',
|
'name': 'name',
|
||||||
'type': 'string',
|
'type': 'string',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': 'input元素的原生属性', 'en-US': 'Native attributes of the input element' }
|
'desc': { 'zh-CN': 'input 元素的原生属性', 'en-US': 'Native attributes of the input element' }
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'select-when-unmatched',
|
'name': 'select-when-unmatched',
|
||||||
|
@ -271,14 +271,14 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'prefix-icon',
|
'name': 'prefix-icon',
|
||||||
'type': 'Component',
|
'type': 'VueComponent',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '输入框头部图标', 'en-US': 'Icon on the header of the text box' },
|
'desc': { 'zh-CN': '输入框头部图标', 'en-US': 'Icon on the header of the text box' },
|
||||||
'demoId': 'custom-icon'
|
'demoId': 'custom-icon'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'suffix-icon',
|
'name': 'suffix-icon',
|
||||||
'type': 'Component',
|
'type': 'VueComponent',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '输入框尾部图标', 'en-US': 'Icon at the end of the text box' },
|
'desc': { 'zh-CN': '输入框尾部图标', 'en-US': 'Icon at the end of the text box' },
|
||||||
'demoId': 'custom-icon'
|
'demoId': 'custom-icon'
|
||||||
|
@ -330,10 +330,11 @@ export default {
|
||||||
'events': [
|
'events': [
|
||||||
{
|
{
|
||||||
'name': 'select',
|
'name': 'select',
|
||||||
'type': '(selection: object) => void',
|
'type': '(selection: IAutocompleteSuggestionItem) => void',
|
||||||
|
'typeAnchorName': 'IAutocompleteSuggestionItem',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '点击选中建议项时触发,回调参数为fetch-suggestions中传入的项',
|
'zh-CN': '点击选中建议项时触发,回调参数为 fetch-suggestions 中传入的项',
|
||||||
'en-US':
|
'en-US':
|
||||||
'Triggered when you click to select a suggestion item. The callback parameter is the item passed in fetch-suggestions'
|
'Triggered when you click to select a suggestion item. The callback parameter is the item passed in fetch-suggestions'
|
||||||
},
|
},
|
||||||
|
@ -373,13 +374,26 @@ export default {
|
||||||
'name': 'default',
|
'name': 'default',
|
||||||
'type': '',
|
'type': '',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '下拉列表项插槽,插槽参数: arg: { slotScope: object }, 其中object是fetch-suggestions中传入的项', 'en-US': 'Drop-down list item slot, slot parameter: arg: {slotScope: object}, where object is the item passed in fetch-suggestions' },
|
'desc': {
|
||||||
|
'zh-CN':
|
||||||
|
'下拉列表项插槽,插槽参数: arg: { slotScope: IAutocompleteSuggestionItem }, 其中 slotScope 是 fetch-suggestions 中传入的项',
|
||||||
|
'en-US':
|
||||||
|
'Drop-down list item slot, slot parameter: arg: { slotScope: IAutocompleteSuggestionItem }, where slotScope is the item passed in fetch-suggestions'
|
||||||
|
},
|
||||||
'demoId': 'slot'
|
'demoId': 'slot'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
types: [
|
types: [
|
||||||
|
{
|
||||||
|
name: 'IAutocompleteSuggestionItem',
|
||||||
|
type: 'type',
|
||||||
|
code: `interface IAutocompleteSuggestionItem {
|
||||||
|
[key: string]: string | undefined
|
||||||
|
value?: string
|
||||||
|
}`
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: 'IAutocompletePlacement',
|
name: 'IAutocompletePlacement',
|
||||||
type: 'type',
|
type: 'type',
|
||||||
|
@ -388,7 +402,7 @@ export default {
|
||||||
{
|
{
|
||||||
name: 'IAutocompleteFetchSuggestions',
|
name: 'IAutocompleteFetchSuggestions',
|
||||||
type: 'type',
|
type: 'type',
|
||||||
code: 'type IAutocompleteFetchSuggestions = (queryString: string, callback: (suggestions: object[]) => void) => void'
|
code: 'type IAutocompleteFetchSuggestions = (queryString: string, callback: (suggestions: IAutocompleteSuggestionItem[]) => void) => void'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
@ -317,7 +317,7 @@ export default {
|
||||||
'name': 'collapse-tags',
|
'name': 'collapse-tags',
|
||||||
'type': 'boolean',
|
'type': 'boolean',
|
||||||
'defaultValue': 'false',
|
'defaultValue': 'false',
|
||||||
'desc': { 'zh-CN': '多选模式下是否折叠Tag', 'en-US': 'Whether to collapse tags in multi-choice mode' },
|
'desc': { 'zh-CN': '多选模式下是否折叠 Tag', 'en-US': 'Whether to collapse tags in multi-choice mode' },
|
||||||
'demoId': 'collapse-tags'
|
'demoId': 'collapse-tags'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
@ -193,7 +193,7 @@ export default {
|
||||||
{
|
{
|
||||||
'name': 'autocomplete',
|
'name': 'autocomplete',
|
||||||
'type': 'string',
|
'type': 'string',
|
||||||
'defaultValue': 'off',
|
'defaultValue': `'off'`,
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '原生 autocomplete 属性',
|
'zh-CN': '原生 autocomplete 属性',
|
||||||
'en-US': 'Native autocomplete attribute'
|
'en-US': 'Native autocomplete attribute'
|
||||||
|
@ -317,7 +317,7 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'modelValue / v-model',
|
'name': 'modelValue / v-model',
|
||||||
'type': 'string , number',
|
'type': 'string | number',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '设置文本的绑定值',
|
'zh-CN': '设置文本的绑定值',
|
||||||
|
@ -347,7 +347,7 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'prefix-icon',
|
'name': 'prefix-icon',
|
||||||
'type': 'Component',
|
'type': 'VueComponent',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '输入框头部图标',
|
'zh-CN': '输入框头部图标',
|
||||||
|
@ -367,7 +367,7 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'resize',
|
'name': 'resize',
|
||||||
'type': '"both" | "horizontal" | "vertical" | "none"',
|
'type': `'both' | 'horizontal' | 'vertical' | 'none'`,
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '控制是否能被用户缩放',
|
'zh-CN': '控制是否能被用户缩放',
|
||||||
|
@ -408,7 +408,7 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'size',
|
'name': 'size',
|
||||||
'type': '"medium" | "small" | "mini"',
|
'type': `'medium' | 'small' | 'mini'`,
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '输入框尺寸,只在 type!="textarea" 时有效',
|
'zh-CN': '输入框尺寸,只在 type!="textarea" 时有效',
|
||||||
|
@ -428,7 +428,7 @@ export default {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'suffix-icon',
|
'name': 'suffix-icon',
|
||||||
'type': 'Component',
|
'type': 'VueComponent',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '输入框尾部图标',
|
'zh-CN': '输入框尾部图标',
|
||||||
|
@ -441,19 +441,19 @@ export default {
|
||||||
'type': 'string',
|
'type': 'string',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '原生属性,输入框的tabindex',
|
'zh-CN': '原生属性,输入框的 tabindex',
|
||||||
'en-US': 'Native attribute, tabindex in the text box'
|
'en-US': 'Native attribute, tabindex in the text box'
|
||||||
},
|
},
|
||||||
'demoId': ''
|
'demoId': ''
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'type',
|
'name': 'type',
|
||||||
'type': '"text" | "textarea" | "password" | InputHTMLAttributes.type',
|
'type': `'text' | 'textarea' | 'password' | InputHTMLAttributes.type`,
|
||||||
'defaultValue': 'text',
|
'defaultValue': `'text'`,
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN': '设置input框的type属性,默认为 text,可选值 text,textarea 和其他 原生 input 的 type 值',
|
'zh-CN': '设置 input 框的 type 属性,默认为 "text",可选值 "text","textarea" 和其他 原生 input 的 type 值',
|
||||||
'en-US':
|
'en-US':
|
||||||
'Set the type attribute of the input box. The default value is text. The options are text, textarea, and type values of other native inputs.'
|
'Set the type attribute of the input box. The default value is "text". The options are "text", "textarea", and type values of other native inputs.'
|
||||||
},
|
},
|
||||||
'demoId': 'type'
|
'demoId': 'type'
|
||||||
},
|
},
|
||||||
|
|
Loading…
Reference in New Issue