alfresco-ng2-components/docs/dropdown-breadcrumb.component.md
Andy Stark c9a3b048b4 [ADF-1769] Added JSDocs and updated prop table script (#2838)
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
2018-01-17 17:11:22 +00:00

1.7 KiB

Dropdown Breadcrumb Component

Indicates the current position within a navigation hierarchy using a dropdown menu.

Dropdown Breadcrumb screenshot

Basic Usage

<adf-dropdown-breadcrumb  *ngIf="useDropdownBreadcrumb"
    [target]="documentList"
    [folderNode]="documentList.folderNode">
</adf-dropdown-breadcrumb>

Properties

Name Type Description
target DocumentListComponent (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update.
folderNode MinimalNodeEntryEntity Active node, builds UI based on folderNode.path.elements collection.
root string (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 i18n resource key for the property value.
rootId string (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with.

Events

Name Returned Type Description
navigate PathElementEntity emitted when user clicks on a breadcrumb

See also