@kelvininc/ui-components
Version:
Kelvin UI Components
62 lines (37 loc) • 1.4 kB
Markdown
<!-- Auto Generated Below -->
## Usage
### React
```tsx
import React from 'react';
import { KvBreadcrumb } from '@kelvininc/react-ui-components';
export const KvBreadcrumbExample: React.FC = (props) => (
<>
{/*-- With items --*/}
<KvBreadcrumb items={props.items}></KvLink>
</>
);
```
## Properties
| Property | Attribute | Description | Type | Default |
| -------- | --------- | ------------------------------ | ------------------- | ------- |
| `items` | `items` | (required) List of breadcrumbs | `IBreadcrumbItem[]` | `[]` |
## Events
| Event | Description | Type |
| --------------------- | ---------------------------------------------- | ------------------------------ |
| `breadcrumbItemClick` | Emitted when the user clicks on the breadcrumb | `CustomEvent<IBreadcrumbItem>` |
## Shadow Parts
| Part | Description |
| -------- | -------------------- |
| `"item"` | The breadcrumb item. |
## Dependencies
### Depends on
- [kv-breadcrumb-list](../breadcrumb-list)
- [kv-breadcrumb-item](../breadcrumb-item)
### Graph
```mermaid
graph TD;
kv-breadcrumb --> kv-breadcrumb-list
kv-breadcrumb --> kv-breadcrumb-item
style kv-breadcrumb fill:#f9f,stroke:#333,stroke-width:4px
```
----------------------------------------------