Skip to content

refactor(breadcrumb): 优化面包屑组件目录结构和文档 #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kagol merged 1 commit into from
Apr 15, 2022
Merged

refactor(breadcrumb): 优化面包屑组件目录结构和文档 #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions packages/devui-vue/devui/breadcrumb/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@ import type { App } from 'vue';
import Breadcrumb from './src/breadcrumb';
import BreadcrumbItem from './src/breadcrumb-item';

Breadcrumb.install = function (app: App): void {
app.component(Breadcrumb.name, Breadcrumb);
app.component(BreadcrumbItem.name, BreadcrumbItem);
};
export * from './src/breadcrumb-types';
export * from './src/breadcrumb-item-types';

export { Breadcrumb };

Expand All @@ -14,6 +12,7 @@ export default {
category: '导航',
status: '50%',
install(app: App): void {
app.use(Breadcrumb as any);
app.component(Breadcrumb.name, Breadcrumb);
app.component(BreadcrumbItem.name, BreadcrumbItem);
},
};
16 changes: 7 additions & 9 deletions packages/devui-vue/docs/components/breadcrumb/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,13 @@ export default defineComponent({
```
:::

### 可下拉的面包屑【TODO】
### 自定义分隔符的面包屑

:::demo
```vue
<template>
<div>
<d-breadcrumb separatorIcon=">">
<d-breadcrumb separator-icon=">">
<d-breadcrumb-item>
<a routerLink="/components/zh-cn/get-start">DevUI</a>
</d-breadcrumb-item>
Expand All @@ -84,25 +83,24 @@ export default defineComponent({
</template>
```
:::
### API

### d-breadcrumb 参数
### Breadcrumb 参数

| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
| :-----------: | :------------------------------------: | :--: | :------------------------------------------------- | --------------------------------------------- |
| separatorIcon | [`string`](#自定义分隔符的面包屑) | '/' | 可选，自定义分隔符样式 | [自定义分隔符的面包屑](#自定义分隔符的面包屑) |
| source | [`Array<SourceConfig>`](#SourceConfig) | [] | 可选，面包屑根据配置的 source 按照默认渲染方式显示 | [传入source](#传入source) |
| separator-icon | `string` | '/' | 可选，自定义分隔符样式 | [自定义分隔符的面包屑](#自定义分隔符的面包屑) |
| source | [SourceConfig\[\]](#sourceconfig) | [] | 可选，面包屑根据配置的 source 按照默认渲染方式显示 | [传入source](#传入source) |

### d-breadcrumb-item 参数
### BreadcrumbItem 参数

| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
| :------: | :--------------------------------: | :---: | :-----------------------------------------------------: | :-------------------------------- |
|to | `string/object` | — | 路由跳转对象，同 vue-router 的 to | [基础面包屑](#基础面包屑) |
|replace| `boolean` | false | 在使用 to 进行路由跳转时，启用 replace 将不会向 history 添加新记录 | [基础面包屑](#基础面包屑) |

### 接口 & 类型定义
### 类型定义

### SourceConfig
#### SourceConfig

```ts
export interface SourceConfig {
Expand Down