mirror of
https://github.com/directus/directus.git
synced 2026-02-16 23:51:50 -05:00
* move component docs to documentation * update app docs tables for components * update docs * Add components to docs sidebar * fix generated tables * fix tables * rename transitions * update tables * update nested components * update tables * update tables * update tables * update v-table table * add basic documentation to each component * remove all stories of storybook * add missing documentation * undate tables * update tables * update docs sidebar * update app docs * remove unused references * add general readme * update docs * make reference titiles smaller * add reference tag * improve docs * update order of tabs in sidebar * remove all readmes and stories from interfaces/displays * Cleanup menu * Remove storybook Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
# Breadcrumb
|
|
|
|
A breadcrumb can help you display on what site you are currently on by displaying a structure like `my / custom / page`.
|
|
|
|
```html
|
|
<v-breadcrumb :items="[{name: 'Collections', to: '/collections'}]" />
|
|
```
|
|
|
|
## Breadcrumb Item
|
|
|
|
An item for the items prop has these 4 options: | Prop | Description |
|
|
|------------|-----------------------------------------------------------| | `to` | The reroute link | | `name` | The
|
|
name which will be displayed | | `icon` | Displays an icon with the given name in front of the name | | `disabled` | If
|
|
the router link should be clickable |
|
|
|
|
## Reference
|
|
|
|
#### Props
|
|
|
|
| Prop | Description | Default | Type |
|
|
| ------- | -------------------------------------------------------- | ---------- | -------------- |
|
|
| `items` | An array of objects which information about each section | `() => []` | `Breadcrumb[]` |
|
|
|
|
#### CSS Variables
|
|
|
|
| Variable | Default |
|
|
| ------------------------------- | --------------------------- |
|
|
| `--v-breadcrumb-color` | `var(--foreground-subdued)` |
|
|
| `--v-breadcrumb-color-hover` | `var(--foreground-normal)` |
|
|
| `--v-breadcrumb-color-disabled` | `var(--foreground-subdued)` |
|
|
| `--v-breadcrumb-divider-color` | `var(--foreground-subdued)` |
|