alfresco-ng2-components/docs/content-services/dropdown-breadcrumb.component.md
Andy Stark c8f04193c7 [ADF-2764] Updated doc files with latest script features (#3368)
* [ADF-2764] Updated doc files with latest script features

* [ADF-2764] Rebuilt full index instead of just content services index
2018-05-23 00:40:02 +01:00

1.9 KiB

Added, Status
Added Status
v2.0.0 Active

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>

Class members

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.
transform function Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function.

Events

Name Type Description
navigate EventEmitter<PathElementEntity> Emitted when the user clicks on a breadcrumb.

See also