Breadcrumb

A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy.

Examples

Basic

Home / Application Center / Application List / An Application /
<Breadcrumb>
  <BreadcrumbItem>Home</BreadcrumbItem>
  <BreadcrumbItem href="/">Application Center</BreadcrumbItem>
  <BreadcrumbItem href="/">Application List</BreadcrumbItem>
  <BreadcrumbItem>An Application</BreadcrumbItem>
</Breadcrumb>

<script>
  import { Breadcrumb, BreadcrumbItem } from "svant";
</script>

With Icons

/ Application List / Application /
<Breadcrumb>
  <BreadcrumbItem href="/">
    <HomeOutlined />
  </BreadcrumbItem>
  <BreadcrumbItem href="/">
    <UserOutlined />
    <span>Application List</span>
  </BreadcrumbItem>
  <BreadcrumbItem>Application</BreadcrumbItem>
</Breadcrumb>

<script>
  import { Breadcrumb, BreadcrumbItem } from "svant";
  import { HomeOutlined, UserOutlined } from "svant/icons";
</script>

Configuring the Separator

The separator can be changed using the separator prop on the Breadcrumb component. Either a string or a Svelte component (for example - an icon component) can be passed.

Home > Application Center > Application List > An Application >

Home [object Object] Application Center [object Object] Application List [object Object] An Application [object Object]
<Breadcrumb separator=">">
  <BreadcrumbItem>Home</BreadcrumbItem>
  <BreadcrumbItem href="/">Application Center</BreadcrumbItem>
  <BreadcrumbItem href="/">Application List</BreadcrumbItem>
  <BreadcrumbItem>An Application</BreadcrumbItem>
</Breadcrumb>

<br />

<Breadcrumb separator="{CaretRightOutlined}">
  <BreadcrumbItem>Home</BreadcrumbItem>
  <BreadcrumbItem href="/">Application Center</BreadcrumbItem>
  <BreadcrumbItem href="/">Application List</BreadcrumbItem>
  <BreadcrumbItem>An Application</BreadcrumbItem>
</Breadcrumb>

<script>
  import { Breadcrumb, BreadcrumbItem } from "svant";
  import { CaretRightOutlined } from "svant/icons";
</script>

Using Multiple Separators

The separator can be changed using the separator prop on the Breadcrumb component. Either a string or a Svelte component (for example - an icon component) can be passed.

Home [object Object] Application Center / Application List [object Object] An Application /
<Breadcrumb separator="/">
  <BreadcrumbItem separator="{CaretRightOutlined}">Home</BreadcrumbItem>
  <BreadcrumbItem href="/">Application Center</BreadcrumbItem>
  <BreadcrumbItem href="/" separator="{CaretRightOutlined}">
    Application List
  </BreadcrumbItem>
  <BreadcrumbItem>An Application</BreadcrumbItem>
</Breadcrumb>

<script>
  import { Breadcrumb, BreadcrumbItem } from "svant";
  import { CaretRightOutlined } from "svant/icons";
</script>

API

Breadcrumb Attributes

PropertyDescriptionTypeDefault
separatorSets the separator used for the componentString or Svelte component/

BreadcrumbItem Attributes

PropertyDescriptionTypeDefault
hrefIf set, the item will be wrapper in a linkString
separatorSets the individual separator for the itemString or Svelte component/