Skip to content

Ui3nBreadcrumbs / Ui3nBreadcrumb

Intro

Used to display information hierarchically.

API

Props (Breadcrumbs)

PropsRequiaredDescriptionTypeDefault
separatorNoSeparatorstring/
disabledNoWhether to disable all children breadcrumbs even if they has the active statusbooleanfalse

Props (Breadcrumb)

PropsRequiaredDescriptionTypeDefault
separatorNoSeparatorstring | undefinedundefined
isActiveNoWhether to set the breadcrumb activebooleanfalse
disabledNoWhether to disable the breadcrumb even if it has the active statusbooleanfalse

Events (Breadcrumb)

EventDescriptionArguments
clickTriggered when a breadcrumb is clickedevent: Event

Slots (Breadcrumbs)

NameDescriptionSlot props
defaultThe breadcrumbs content-

Slots (Breadcrumb)

NameDescriptionSlot props
defaultThe breadcrumbs content-
separatorCustomize the breadcrumb separator content-

Examples

The basic usage

Home
/
Link 1
/
Link 2

Click me to view the code
vue
<script setup>
  import { Ui3nBreadcrumb, Ui3nBreadcrumbs } from '@v1nt1248/3nclient-lib'
</script>


<template>
  <div>
    <ui3n-breadcrumbs>
      <ui3n-breadcrumb is-active>Home</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active>Link 1</ui3n-breadcrumb>
      <ui3n-breadcrumb>Link 2</ui3n-breadcrumb>
    </ui3n-breadcrumbs>
  </div>
</template>

Using common separator

Home
~
Link 1
~
Link 2

Click me to view the code
vue
<script setup>
  import { Ui3nBreadcrumb, Ui3nBreadcrumbs } from '@v1nt1248/3nclient-lib'
</script>


<template>
  <div>
    <ui3n-breadcrumbs separator="~">
      <ui3n-breadcrumb is-active>Home</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active>Link 1</ui3n-breadcrumb>
      <ui3n-breadcrumb>Link 2</ui3n-breadcrumb>
    </ui3n-breadcrumbs>
  </div>
</template>

Using different separators in children

Home
/
Link 1
~
Link 2
*
Link 3
/
Link 4

Click me to view the code
vue
<script setup>
  import { Ui3nBreadcrumb, Ui3nBreadcrumbs } from '@v1nt1248/3nclient-lib'
</script>


<template>
  <div>
    <ui3n-breadcrumbs>
      <ui3n-breadcrumb is-active>Home</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active separator="~">Link 1</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active separator="*">Link 2</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active>Link 3</ui3n-breadcrumb>
      <ui3n-breadcrumb>Link 4</ui3n-breadcrumb>
    </ui3n-breadcrumbs>
  </div>
</template>

Using the separator slot

Home
Link 1
Link 2

Click me to view the code
vue
<script setup>
  import { Ui3nBreadcrumb, Ui3nBreadcrumbs, Ui3nIcon } from '@v1nt1248/3nclient-lib'
</script>


<template>
  <div>
    <ui3n-breadcrumbs>
      <ui3n-breadcrumb is-active>
        Home
        <template #separator>
          <ui3n-icon icon="baseline-bookmark"></ui3n-icon>
        </template>
      </ui3n-breadcrumb>
      <ui3n-breadcrumb is-active>
        Link 1
        <template #separator>
          <ui3n-icon icon="baseline-insert-emoticon"></ui3n-icon>
        </template>
      </ui3n-breadcrumb>
      <ui3n-breadcrumb>Link 2</ui3n-breadcrumb>
    </ui3n-breadcrumbs>
  </div>
</template>

Click event

Home
/
Link 1
/
Link 2

Click me to view the code
vue
<script lang="ts" setup>
  import { Ui3nBreadcrumb, Ui3nBreadcrumbs } from '@v1nt1248/3nclient-lib'

  const onClick = (link: string) => {
    alert(link)
  }
</script>


<template>
  <div>
    <ui3n-breadcrumbs>
      <ui3n-breadcrumb is-active @click="onClick('Home')">Home</ui3n-breadcrumb>
      <ui3n-breadcrumb is-active @click="onClick('Link1')">Link 1</ui3n-breadcrumb>
      <ui3n-breadcrumb>Link 2</ui3n-breadcrumb>
    </ui3n-breadcrumbs>
  </div>
</template>