mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
900fd70d63
* [ADF-1769] Added prop tables and fixed script * [ADF-1769] Corrected JSDoc formatting errors * [ADF-1769] Restored default column to prop tables
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Dropdown Breadcrumb Component
|
|
|
|
Indicates the current position within a navigation hierarchy using a dropdown menu.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-dropdown-breadcrumb *ngIf="useDropdownBreadcrumb"
|
|
[target]="documentList"
|
|
[folderNode]="documentList.folderNode">
|
|
</adf-dropdown-breadcrumb>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| folderNode | `MinimalNodeEntryEntity` | `null` | Active node, builds UI based on folderNode.path.elements collection. |
|
|
| root | `string` | `null` | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
|
|
| rootId | `string` | `null` | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
|
|
| target | `DocumentListComponent` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. |
|
|
|
|
## See also
|
|
|
|
- [Document list component](document-list.component.md)
|
|
- [Breadcrumb component](breadcrumb.component.md)
|