@opentiny/vue-docs 2.2.22 → 3.16.0

package/demos/apis/carousel.js

@@ -8,7 +8,7 @@ export default {
         {
           name: 'arrow',
           type: 'string',
-          defaultValue: "该属性的默认值为 'hover'",
+          defaultValue: "'hover'",
           desc: {
             'zh-CN': '切换箭头的显示效果，该属性的可选值为 always / hover / never',
             'en-US': 'Switch the display effect of arrows,The optional values for this attribute are always/hover/never'
@@ -31,7 +31,7 @@ export default {
         {
           name: 'autoplay',
           type: 'boolean',
-          defaultValue: '该属性的默认值为 false',
+          defaultValue: 'false',
           desc: {
             'zh-CN': '是否自动切换',
             'en-US': 'Whether to automatically switch'
@@ -57,7 +57,7 @@ export default {
           type: 'string',
           defaultValue: '',
           desc: {
-            'zh-CN': '指示器的位置。该属性的可选值为 outside / none',
+            'zh-CN': '指示器的位置，该属性的可选值为 outside / none',
             'en-US': 'The position of the indicator. The optional values for this attribute are outside/none'
           },
           mode: ['pc', 'mobile-first'],
@@ -67,10 +67,10 @@ export default {
         {
           name: 'indicator-style',
           type: 'String',
-          defaultValue: '该属性的可选值为 light/dark ，默认为light。',
+          defaultValue: "'light'",
           desc: {
-            'zh-CN': '指示器的样式。',
-            'en-US': 'The style of the indicator.'
+            'zh-CN': '指示器的样式，该属性的可选值为 light/dark',
+            'en-US': 'The style of the indicator, The optional values for this attribute are light/mark.'
           },
           mode: ['mobile-first'],
           mfDemo: 'indicator-style'
@@ -78,7 +78,7 @@ export default {
         {
           name: 'initial-index',
           type: 'number',
-          defaultValue: '该属性的默认值为 0',
+          defaultValue: '0',
           desc: {
             'zh-CN': '初始状态激活的幻灯片的索引，从 0 开始',
             'en-US': 'Index of slides activated in initial state, starting from 0'
@@ -90,7 +90,7 @@ export default {
         {
           name: 'interval',
           type: 'number',
-          defaultValue: '该属性的默认值为 3000',
+          defaultValue: '3000',
           desc: {
             'zh-CN': '自动切换的时间间隔，单位为毫秒',
             'en-US': 'The time interval for automatic switching, in milliseconds'
@@ -102,7 +102,7 @@ export default {
         {
           name: 'loop',
           type: 'boolean',
-          defaultValue: '该属性的默认值为 true',
+          defaultValue: 'true',
           desc: {
             'zh-CN': '是否循环显示',
             'en-US': 'Whether to display in a loop'
@@ -114,7 +114,7 @@ export default {
         {
           name: 'show-title',
           type: 'boolean',
-          defaultValue: '该属性的默认值为 false',
+          defaultValue: 'false',
           desc: {
             'zh-CN': '是否显示标题',
             'en-US': 'Is the title displayed'
@@ -126,11 +126,10 @@ export default {
         {
           name: 'trigger',
           type: 'string',
-          defaultValue: "该属性的默认值为 'hover'",
+          defaultValue: "'hover'",
           desc: {
-            'zh-CN': '指示器的触发方式，默认为 hover。该属性的可选值为 click',
-            'en-US':
-              'The triggering method of the indicator is hover by default. The optional value for this attribute is click'
+            'zh-CN': '指示器的触发方式，该属性的可选值为 hover / click',
+            'en-US': 'The triggering method of the indicator. The optional value for this attribute is click'
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'indicator-trigger',
@@ -139,7 +138,7 @@ export default {
         {
           name: 'type',
           type: 'string',
-          defaultValue: "该属性的默认值为 'horizontal'",
+          defaultValue: "'horizontal'",
           desc: {
             'zh-CN': '走马灯的类型，该属性的可选值为 horizontal / vertical / card',
             'en-US': 'The type of horse lantern,The optional values for this attribute are horizontal/vertical/card'
@@ -152,11 +151,12 @@ export default {
       events: [
         {
           name: 'change',
-          type: '',
+          type: '(curIndex: number, preIndex: number) => void',
           defaultValue: '',
           desc: {
-            'zh-CN': '幻灯片切换时触发',
-            'en-US': 'Trigger during slide transition'
+            'zh-CN': '幻灯片切换时触发，第一个参数为当前幻灯片索引，第二个参数为上一张幻灯片索引',
+            'en-US':
+              'Trigger during slide transition, The first parameter is the current slide index, and the second parameter is the index of the previous slide'
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'carousel-events',
@@ -193,8 +193,9 @@ export default {
           type: '',
           defaultValue: '',
           desc: {
-            'zh-CN': '手动切换幻灯片',
-            'en-US': 'Manually switch slides'
+            'zh-CN': '手动切换幻灯片，参数为需要切换的幻灯片的索引，从 0 开始',
+            'en-US':
+              'Manually switch slides,the parameter is the index of the slides that need to be switched, starting from 0'
           },
           mode: ['pc', 'mobile-first'],
           pcDemo: 'manual-play',

package/demos/apis/chart-attributes-demo.js

@@ -0,0 +1,297 @@
+export default {
+    mode: ['pc'],
+    apis: [
+        {
+            name: 'chart',
+            type: 'component',
+            props: [
+                {
+                    name: 'cancel-resize-check',
+                    type: 'boolean',
+                    defaultValue: 'false',
+                    desc: {
+                        'zh-CN': '是否禁用 resize 时的容器检测',
+                        'en-US': 'Whether to disable container detection during resize'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/question#question-base'
+                },
+                {
+                    name: 'change-delay',
+                    type: 'number',
+                    defaultValue: "'0'",
+                    desc: {
+                        'zh-CN': '属性修改触发图表重绘回调的延迟',
+                        'en-US': 'Delay for triggering chart redrawing callback after attribute modification'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/question#question-base'
+                },
+                {
+                    name: 'data',
+                    type: 'object',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '数据由指标和维度组成,“维度” 指的是数据的属性,“指标” 是量化衡量标准',
+                        'en-US':
+                            'Data consists of indicators and dimensions. Dimension refers to data attributes, and indicator refers to quantitative measurement standards.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart'
+                },
+                {
+                    name: 'events',
+                    type: 'object',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '事件绑定',
+                        'en-US': 'Event binding'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart-events'
+                },
+                {
+                    name: 'extend',
+                    typeAnchorName: 'chart#IChartProps',
+                    type: 'IChartProps',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': 'echarts 的配置项',
+                        'en-US': 'Configuration items of echarts'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart'
+                },
+                {
+                    name: 'height',
+                    type: 'string',
+                    defaultValue: "'400px'",
+                    desc: {
+                        'zh-CN': '设置图表容器的高度。',
+                        'en-US': 'Set the height of the chart container.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'init-options',
+                    type: 'object',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': 'init 附加参数',
+                        'en-US': 'Init Additional Parameters'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'judge-width',
+                    type: 'boolean',
+                    defaultValue: 'false',
+                    desc: {
+                        'zh-CN': '是否处理生成图表时的宽度问题',
+                        'en-US': 'Do you want to process the width issue when generating charts?'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart-events'
+                },
+                {
+                    name: 'legend-visible',
+                    type: 'boolean',
+                    defaultValue: 'true',
+                    desc: {
+                        'zh-CN': '是否显示图例',
+                        'en-US': 'Display legend'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'not-set-unchange',
+                    type: 'array',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '未发生变化时不参加 setOption 的属性',
+                        'en-US': 'The setOption attribute does not change.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: ''
+                },
+                {
+                    name: 'resize-delay',
+                    type: 'number',
+                    defaultValue: "'200'",
+                    desc: {
+                        'zh-CN': '窗口 resize 事件回调的延迟',
+                        'en-US': 'Delay of the window resize event callback'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'resizeable',
+                    type: 'boolean',
+                    defaultValue: 'true',
+                    desc: {
+                        'zh-CN': '是否处理窗口 resize 事件',
+                        'en-US': 'Whether to process the window resize event'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/question#question-base'
+                },
+                {
+                    name: 'set-option-opts',
+                    type: 'boolean | object',
+                    defaultValue: 'true',
+                    desc: {
+                        'zh-CN': 'echarts setOption 的第二个参数',
+                        'en-US': 'Echarts setOption second parameter'
+                    },
+                    mode: ['pc'],
+                    pcDemo: ''
+                },
+                {
+                    mode: []
+                },
+                {
+                    name: 'theme',
+                    type: 'object',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '自定义主题名称。;自定义主题对象。',
+                        'en-US': 'User-defined theme name. ;User-defined theme object.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart#base'
+                },
+                {
+                    name: 'theme-name',
+                    type: 'string',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '自定义主题名称,如果设置了 theme-name, 则 theme 无效',
+                        'en-US': 'User-defined theme name. If theme-name is set, the theme is invalid.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart#base'
+                },
+                {
+                    name: 'tooltip-visible',
+                    type: 'boolean',
+                    defaultValue: 'true',
+                    desc: {
+                        'zh-CN': '是否显示提示框',
+                        'en-US': 'Display dialog box'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'width',
+                    type: 'string',
+                    defaultValue: "'auto'",
+                    desc: {
+                        'zh-CN': '设置图表容器的宽度。',
+                        'en-US': 'Set the width of the chart container.'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/attributes-demo#props-demo10'
+                },
+                {
+                    name: 'width-change-delay',
+                    type: 'number',
+                    defaultValue: "'300'",
+                    desc: {
+                        'zh-CN': '容器宽度变化的延迟',
+                        'en-US': 'Container width change delay'
+                    },
+                    mode: ['pc'],
+                    pcDemo: 'chart/question#question-base'
+                },
+                {
+                    name: 'options',
+                    type: 'object',
+                    defaultValue: '',
+                    desc: {
+                        'zh-CN': '图表配置项(无法与settings混用)',
+                        'en-US': 'Chart Configuration item (cannot be used together with settings)'
+                    },
+                    mode: ['pc'],
+                    pcDemo: ''
+                }
+            ],
+
+            events: [],
+            methods: [],
+            slots: []
+        }
+    ],
+    types: [
+        {
+            name: 'IChartProps',
+            type: 'interface',
+            code: `
+  interface IChartProps {
+    afterConfig: () => void 
+    afterSetOption: () => void 
+    afterSetOptionOnce: () => void 
+    animation: object
+    axisPointer: object | array
+    backgroundColor: object | string
+    beforeConfig: () => void 
+    brush: object | array
+    cancelResizeCheck: boolean
+    changeDelay: number // 默认值 0 
+    colorMode: string
+    colors: array 
+    data: object | array
+    dataEmpty: boolean
+    dataZoom: object | array
+    events: object 
+    extend: object
+    geo: object | array
+    graphic: object | array
+    grid: object | array
+    height: string // 默认值 '400px' 
+    initOptions: object
+    judgeWidth: boolean // 默认值 false 
+    legend: object | array
+    legendPosition: string 
+    legendVisible: boolean // 默认值 true 
+    loading: boolean
+    markArea: object 
+    markLine: object 
+    markPoint: object 
+    notSetUnchange: array
+    radar: object
+    resizeDelay: number // 默认值 200 
+    resizeable: boolean // 默认值 true 
+    series: object | array
+    setOptionOpts: boolean | object // 默认值 true 
+    settings: object
+    textStyle: object | array
+    theme: object
+    themeName: object | string
+    timeline: object | array
+    title: object | array
+    toolbox: object | array
+    tooltip: object
+    tooltipFormatter: () => void 
+    tooltipVisible: boolean // 默认值 true 
+    visualMap: object | array 
+    width: string // 默认值 'auto' 
+    widthChangeDelay: number // 默认值 300 
+    xAxis: object | array
+    yAxis: object | array
+  }`
+        },
+        {
+            name: 'IChartSettings',
+            type: 'interface',
+            code: `
+  interface IChartSettings {
+    type: string // 图表类型，可选值' bar '，' histogram '，' line ',' pie '，' ring '，' funnel '，' radar '，' waterfall '
+  }`
+        }
+    ]
+}