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/content-services/components/dropdown-breadcrumb.component.md
Eugenio Romano d6a4f84161
generate documentation (#7006)
2021-05-10 10:47:48 +01:00

2.7 KiB
Raw Permalink Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Dropdown Breadcrumb Component v2.0.0 Active 2019-01-16

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 Node null Active node, builds UI based on folderNode.path.elements collection.
maxItems number Maximum number of nodes to display before wrapping them with a dropdown element.
readOnly boolean false If true, prevents the user from navigating away from the active node.
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<PathElement> Emitted when the user clicks on a breadcrumb.

Details

Although this component inherits the maxItems property from the Breadcrumb component, the "crumbs" are always shown on a menu. By contrast, the Breadcrumb component only falls back to a menu when its maximum number of nodes is exceeded.

See also