๐Ÿ“ฆ ionic-team / ionic-docs

๐Ÿ“„ breadcrumb.md ยท 64 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64---
title: 'ion-breadcrumb'
---

import Props from '@ionic-internal/component-api/v7/breadcrumb/props.md';
import Events from '@ionic-internal/component-api/v7/breadcrumb/events.md';
import Methods from '@ionic-internal/component-api/v7/breadcrumb/methods.md';
import Parts from '@ionic-internal/component-api/v7/breadcrumb/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/breadcrumb/custom-props.mdx';
import Slots from '@ionic-internal/component-api/v7/breadcrumb/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

<EncapsulationPill type="shadow" />

A Breadcrumb is a single navigation item that is a child of the Breadcrumbs component. A breadcrumb can link elsewhere in an app or it can be plain text. Each breadcrumb has a separator between it and the next breadcrumb and can optionally contain an icon.

See the [Breadcrumbs](./breadcrumbs) documentation for more information.

## Interfaces

### BreadcrumbCollapsedClickEventDetail

```typescript
interface BreadcrumbCollapsedClickEventDetail {
  collapsedBreadcrumbs?: HTMLIonBreadcrumbElement[];
}
```

### BreadcrumbCustomEvent

While not required, this interface can be used in place of the `CustomEvent` interface for stronger typing .

```typescript
interface BreadcrumbCustomEvent extends CustomEvent {
  detail: BreadcrumbCollapsedClickEventDetail;
  target: HTMLIonBreadcrumbElement;
}
```

## Properties

<Props />

## Events

<Events />

## Methods

<Methods />

## CSS Shadow Parts

<Parts />

## CSS Custom Properties

<CustomProps />

## Slots

<Slots />