Skip to main content

Breadcrumb

<gstock-breadcrumb> | GstockBreadcrumb

By default, breadcrumb items are rendered as buttons so you can use them to navigate single-page applications. In this case, you’ll need to add event listeners to handle clicks.

For websites, you’ll probably want to use links instead. You can make any breadcrumb item a link by applying an href attribute to it. Now, when the user activates it, they’ll be taken to the corresponding page — no event listeners required.

Homepage Our Services Digital Media Web Design
<gstock-breadcrumb>
  <gstock-breadcrumb-item href="https://example.com/home">Homepage</gstock-breadcrumb-item>
  <gstock-breadcrumb-item href="https://example.com/home/services">Our Services</gstock-breadcrumb-item>
  <gstock-breadcrumb-item href="https://example.com/home/services/digital">Digital Media</gstock-breadcrumb-item>
  <gstock-breadcrumb-item href="https://example.com/home/services/digital/web-design">Web Design</gstock-breadcrumb-item>
</gstock-breadcrumb>

Custom Separators

Use the separator slot to change the separator that goes between breadcrumb items. Icons work well, but you can also use text or an image.

First Second Third
First Second Third
/ First Second Third
<gstock-breadcrumb>
  <gstock-icon name="more-horizontal" slot="separator"></gstock-icon>
  <gstock-breadcrumb-item>First</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Second</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Third</gstock-breadcrumb-item>
</gstock-breadcrumb>

<br />

<gstock-breadcrumb>
  <gstock-icon name="arrow-right" slot="separator"></gstock-icon>
  <gstock-breadcrumb-item>First</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Second</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Third</gstock-breadcrumb-item>
</gstock-breadcrumb>

<br />

<gstock-breadcrumb>
  <span slot="separator">/</span>
  <gstock-breadcrumb-item>First</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Second</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Third</gstock-breadcrumb-item>
</gstock-breadcrumb>

Prefixes

Use the prefix slot to add content before any breadcrumb item.

Home Articles Traveling
<gstock-breadcrumb>
  <gstock-breadcrumb-item>
    <gstock-icon slot="prefix" name="home"></gstock-icon>
    Home
  </gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Articles</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Traveling</gstock-breadcrumb-item>
</gstock-breadcrumb>

Suffixes

Use the suffix slot to add content after any breadcrumb item.

Documents Policies Security
<gstock-breadcrumb>
  <gstock-breadcrumb-item>Documents</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Policies</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>
    Security
    <gstock-icon slot="suffix" name="shield"></gstock-icon>
  </gstock-breadcrumb-item>
</gstock-breadcrumb>

With Dropdowns

Dropdown menus can be placed in a prefix or suffix slot to provide additional options.

Homepage Our Services Digital Media Web Design Web Design Web Development Marketing
<gstock-breadcrumb>
  <gstock-breadcrumb-item>Homepage</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Our Services</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>Digital Media</gstock-breadcrumb-item>
  <gstock-breadcrumb-item>
    Web Design
    <gstock-dropdown slot="suffix">
      <gstock-button slot="trigger" size="small" variant="plain">
        <gstock-icon label="More options" name="more-horizontal"></gstock-icon>
      </gstock-button>
      <gstock-menu>
        <gstock-menu-item type="checkbox" checked>Web Design</gstock-menu-item>
        <gstock-menu-item type="checkbox">Web Development</gstock-menu-item>
        <gstock-menu-item type="checkbox">Marketing</gstock-menu-item>
      </gstock-menu>
    </gstock-dropdown>
  </gstock-breadcrumb-item>
</gstock-breadcrumb>