inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/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.3 KiB
Raw Blame History

Breadcrumb Component

Indicates the current position within a navigation hierarchy.

Breadcrumb

Basic Usage

<adf-breadcrumb
    [target]="documentList"
    [folderNode]="documentList.folderNode">
</adf-breadcrumb>

Properties

Name Type Description
folderNode MinimalNodeEntryEntity Active node, builds UI based on folderNode.path.elements collection.
Default value: null
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 an i18n resource key for the property value.
Default value: null
rootId string (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with.
Default value: null
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