Indicates the current position within a navigation hierarchy.
<adf-breadcrumb
[target]="documentList">
</adf-breadcrumb>
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. |
Name | Type | Description |
---|---|---|
navigate | EventEmitter < PathElement > | Emitted when the user clicks on a breadcrumb. |
The maxItems
property sets the maximum number of "crumbs" in the breadcrumb trail. If
the actual path contains more nodes than this then the earliest items in the path will be
removed and kept in a menu as with the
Dropdown breadcrumb component.
The function supplied in the transform
property lets you modify the Node
object that the component
uses to find the "crumbs" for the list. You can use this, for example, to remove unwanted items from
the list by altering the node's path.elements
property.
Below is an example of how you might do this with the
Content Node Selector component. In this case, you pass the
transform function via the breadcrumbTransform
property of ContentNodeSelectorComponentData
during
initialization:
const data: ContentNodeSelectorComponentData = { title: title, actionName: action, currentFolderId: contentEntry.parentId, imageResolver: this.imageResolver.bind(this), rowFilter : this.rowFilter.bind(this, contentEntry.id), isSelectionValid: this.hasEntityCreatePermission.bind(this), breadcrumbTransform: this.changeBreadcrumbPath.bind(this), // here is the transform function select: select }; this.openContentNodeDialog(data, 'adf-content-node-selector-dialog', '630px');
A transform function to remove the "Sites" folder from the path would look something like this:
private changeBreadcrumbPath(node: Node) { if (node && node.path && node.path.elements) { const elements = node.path.elements; if (elements.length > 1) { if (elements[1].name === 'Sites') { elements.splice(1, 1); } } } return node; }
Below, the breadcrumb is shown before and after the transform function is applied:
© 2023 Alfresco Software, Inc. All Rights Reserved.
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.