element-plus/docs/en-US/component/breadcrumb.md
Jeremy d02193ea23
docs(components): [breadcrumb] (#10962)
* docs(components): [breadcrumb]

* Update doc file with new syntax.
* Move instances to a dedicated file for readabilities.

* chore: address PR comments

Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com>
2022-12-13 21:37:30 +08:00

1.8 KiB
Raw Blame History

title lang
Breadcrumb en-US

Breadcrumb

Displays the location of the current page, making it easier to browser back.

Basic usage

:::demo In el-breadcrumb, each el-breadcrumb-item is a tag that stands for every level starting from homepage. This component has a String attribute separator, and it determines the separator. Its default value is '/'.

breadcrumb/basic

:::

Icon separator

:::demo Set separator-icon to use svg icon as the separatorit will cover separator

breadcrumb/icon

:::

Breadcrumb API

Breadcrumb Attributes

Name Description Type Default
separator separator character ^[string] /
separator-icon icon component of icon separator ^[string] / ^[Component] -

Breadcrumb Slots

Name Description Subtags
default customize default content Breadcrumb Item

BreadcrumbItem API

BreadcrumbItem Attributes

Name Description Type Default
to target route of the link, same as to of vue-router ^[string] / ^[object]RouteLocationRaw ''
replace if true, the navigation will not leave a history record ^[boolean] false

BreadcrumbItem Slots

Name Description
default customize default content