docs(breadcrumb): optimize breadcrumb docs (#547)

* docs(breadcrumb): modify component description

* docs(breadcrumb): adjust the order of api

* docs(breadcrumb): optimize api docs

* docs(breadcrumb): optimize demo docs

* docs(breadcrumb): adjust the order of  api
This commit is contained in:
Binks_ 2023-10-02 11:06:29 +08:00 committed by GitHub
parent b2600ce1f7
commit 0ff09c23c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 52 additions and 51 deletions

View File

@ -8,7 +8,7 @@
</tiny-breadcrumb> </tiny-breadcrumb>
</template> </template>
<script setup lang="jsx"> <script setup>
import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem, Notify } from '@opentiny/vue' import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem, Notify } from '@opentiny/vue'
function breadcrumbClick(value) { function breadcrumbClick(value) {

View File

@ -6,7 +6,7 @@
</tiny-breadcrumb> </tiny-breadcrumb>
</template> </template>
<script setup lang="jsx"> <script setup>
import { computed } from 'vue' import { computed } from 'vue'
import { useRoute } from 'vue-router' import { useRoute } from 'vue-router'
import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue' import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue'

View File

@ -6,7 +6,7 @@
</tiny-breadcrumb> </tiny-breadcrumb>
</template> </template>
<script lang="jsx"> <script>
import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue' import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue'
export default { export default {

View File

@ -8,7 +8,7 @@
</tiny-breadcrumb> </tiny-breadcrumb>
</template> </template>
<script lang="jsx"> <script>
import { Breadcrumb, BreadcrumbItem, Notify } from '@opentiny/vue' import { Breadcrumb, BreadcrumbItem, Notify } from '@opentiny/vue'
export default { export default {

View File

@ -5,7 +5,7 @@
</div> </div>
</template> </template>
<script setup lang="jsx"> <script setup>
import { ref } from 'vue' import { ref } from 'vue'
import { Breadcrumb as TinyBreadcrumb, Notify } from '@opentiny/vue' import { Breadcrumb as TinyBreadcrumb, Notify } from '@opentiny/vue'

View File

@ -5,7 +5,7 @@
</div> </div>
</template> </template>
<script lang="jsx"> <script>
import { Breadcrumb, Notify } from '@opentiny/vue' import { Breadcrumb, Notify } from '@opentiny/vue'
export default { export default {

View File

@ -18,7 +18,7 @@
</div> </div>
</template> </template>
<script setup lang="jsx"> <script setup>
import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue' import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue'
import { iconBoat } from '@opentiny/vue-icon' import { iconBoat } from '@opentiny/vue-icon'

View File

@ -18,7 +18,7 @@
</div> </div>
</template> </template>
<script lang="jsx"> <script>
import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue' import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue'
import { IconBoat } from '@opentiny/vue-icon' import { IconBoat } from '@opentiny/vue-icon'

View File

@ -10,6 +10,6 @@
</div> </div>
</template> </template>
<script setup lang="jsx"> <script setup>
import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue' import { Breadcrumb as TinyBreadcrumb, BreadcrumbItem as TinyBreadcrumbItem } from '@opentiny/vue'
</script> </script>

View File

@ -10,7 +10,7 @@
</div> </div>
</template> </template>
<script lang="jsx"> <script>
import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue' import { Breadcrumb, BreadcrumbItem } from '@opentiny/vue'
export default { export default {

View File

@ -4,4 +4,4 @@ title: Breadcrumb 面包屑
# Breadcrumb 面包屑 # Breadcrumb 面包屑
<div>Breadcrumb 面包屑导航,作用是告诉访问者他们目前在网站中的位置以及如何返回</div> <div>显示当前页面的位置,并能返回之前的任意页面</div>

View File

@ -4,4 +4,4 @@ title: Breadcrumb
# Breadcrumb # Breadcrumb
<div>Breadcrumb navigation, which tells visitors where they are currently on the site and how to get back.</div> <div>Shows the location of the current page and can return to any previous page.</div>

View File

@ -34,9 +34,9 @@ export default {
'name': { 'zh-CN': 'options 配置', 'en-US': 'options configuration' }, 'name': { 'zh-CN': 'options 配置', 'en-US': 'options configuration' },
'desc': { 'desc': {
'zh-CN': 'zh-CN':
'<p>通过 <code>options</code> 总体配置每个 <code>BreadcrumbItem</code>。 </p> 设置<code>text-field</code> 指定显示字段,默认显示字段为 <code>label</code>\n', '<p>通过 <code>options</code> 总体配置每个 <code>BreadcrumbItem</code>。 </p> 设置<code>text-field</code> 指定显示字段,默认显示字段为 <code>label</code>\n',
'en-US': 'en-US':
'<p>Totally configure each <code>BreadcrumbItem</code> via <code>options</code>. </p>Set <code>text-field</code> to specify the field to be displayed. The default field to be displayed is <code>label</code>\n' '<p>Totally configure each <code>BreadcrumbItem</code> via <code>options</code>. </p>Set <code>text-field</code> to specify the field to be displayed. The default field to be displayed is <code>label</code>.\n'
}, },
'codeFiles': ['options.vue'] 'codeFiles': ['options.vue']
} }
@ -45,10 +45,17 @@ export default {
{ {
'name': 'breadcrumb', 'name': 'breadcrumb',
'type': 'component', 'type': 'component',
'properties': [], 'props': [
'events': [], {
'slots': [], 'name': 'options',
'breadcrumb-attrs': [ 'type': 'Array',
'defaultValue': '该属性的默认值为 []',
'desc': {
'zh-CN': '配置 options ,可以单独使用 tiny-breadcrumb 组件',
'en-US': 'Configure options. The tiny-breadcrumb component can be used independently.'
},
'demoId': 'options'
},
{ {
'name': 'separator', 'name': 'separator',
'type': 'String', 'type': 'String',
@ -63,16 +70,6 @@ export default {
'desc': { 'zh-CN': '图标分隔符 class', 'en-US': 'Icon separator class' }, 'desc': { 'zh-CN': '图标分隔符 class', 'en-US': 'Icon separator class' },
'demoId': 'separator' 'demoId': 'separator'
}, },
{
'name': 'options',
'type': 'Array',
'defaultValue': '[]',
'desc': {
'zh-CN': '配置 options ,可以单独使用 tiny-breadcrumb 组件',
'en-US': 'Configure options. The tiny-breadcrumb component can be used independently.'
},
'demoId': 'options'
},
{ {
'name': 'text-field', 'name': 'text-field',
'type': 'String', 'type': 'String',
@ -85,7 +82,7 @@ export default {
'demoId': 'options' 'demoId': 'options'
} }
], ],
'breadcrumb-events': [ 'events': [
{ {
'name': 'select', 'name': 'select',
'type': 'Function', 'type': 'Function',
@ -96,17 +93,18 @@ export default {
}, },
'demoId': 'options' 'demoId': 'options'
} }
], ]
'breadcrumbItem-attrs': [ },
{
'name': 'breadcrumbItem',
'type': 'component',
'props': [
{ {
'name': 'to', 'name': 'label',
'type': 'String , Object', 'type': 'String',
'defaultValue': '', 'defaultValue': '',
'desc': { 'desc': { 'zh-CN': '定义面包屑的显示值', 'en-US': 'Define the breadcrumb display value.' },
'zh-CN': '路由跳转对象,同 vue-router 的 to', 'demoId': 'base'
'en-US': 'Route redirection object, which is the same as to of vue-router'
},
'demoId': 'slot-default'
}, },
{ {
'name': 'replace', 'name': 'replace',
@ -119,23 +117,17 @@ export default {
'demoId': 'slot-default' 'demoId': 'slot-default'
}, },
{ {
'name': 'label', 'name': 'to',
'type': 'String', 'type': 'String , Object',
'defaultValue': '', 'defaultValue': '',
'desc': { 'zh-CN': '定义面包屑的显示值', 'en-US': 'Define the breadcrumb display value.' }, 'desc': {
'demoId': 'base' 'zh-CN': '路由跳转对象,同 vue-router 的 to',
} 'en-US': 'Route redirection object, which is the same as to of vue-router'
], },
'breadcrumbItem-slots': [
{
'name': 'default',
'type': '',
'defaultValue': '',
'desc': { 'zh-CN': '默认插槽', 'en-US': 'Default slot' },
'demoId': 'slot-default' 'demoId': 'slot-default'
} }
], ],
'breadcrumbItem-events': [ 'events': [
{ {
'name': 'select', 'name': 'select',
'type': '', 'type': '',
@ -146,6 +138,15 @@ export default {
}, },
'demoId': 'base' 'demoId': 'base'
} }
],
'slots': [
{
'name': 'default',
'type': '',
'defaultValue': '',
'desc': { 'zh-CN': '默认插槽', 'en-US': 'Default slot' },
'demoId': 'slot-default'
}
] ]
} }
] ]