LmnBreadcrumbsComponent

No documentation has been provided.

Properties

Name	Type	Description
#element r	`HTMLElement`
#linksForCurrentWidthZone r	`Signal<{ displayedLinks: LmnBreadcrumbsLink[]; collapsedLinks: LmnBreadcrumbsLink[]; }>`
#sizeService r	`LmnSizeService`
#sizeWatcherId r	`string`	Unique id for sizeService
#widthZone r	`Signal<LmnWidthZone \| undefined>`	Set width zone of viewport
#widthZone$ r	`Observable<LmnWidthZone>`	The current width zone of the data browser.
ariaCurrent r	`InputSignal<LmnBreadcrumbsAriaCurrentRole>`	Accessibility
collapsedLinks p r	`Signal<LmnBreadcrumbsLink[]>`
customLinkTemplate p r	`Signal<LmnBreadcrumbsCustomLinkDirective \| undefined>`
displayedLinks p r	`Signal<LmnBreadcrumbsLink[]>`
hideBackButton r	`InputSignalWithTransform<boolean, unknown>`	Hide back button
items r	`InputSignal<LmnBreadcrumbsLink[]>`	Array of links to display in the breadcrumbs
LABELS p r	{ common: { disabledStatusDetails: WritableSignal<string>; close: WritableSignal<string>; clear: WritableSignal<string>; requiredMarker: WritableSignal<string>; disabledMarker: WritableSignal<string>; opensInANewTab: WritableSignal<string>; toolForVisualCustomization: WritableSignal<string>; error: WritableSignal<string>; alert: WritableSignal<string>; }; accordion: { collapsePanel: WritableSignal<string>; expandPanel: WritableSignal<string>; }; breadcrumbs: { previousPathLevel: WritableSignal<string>; showPath: WritableSignal<string>; }; calendar: { previousYearsRange: WritableSignal<string>; nextYearsRange: WritableSignal<string>; yearsRange: WritableSignal<string>; nextYear: WritableSignal<string>; previousYear: WritableSignal<string>; nextMonth: WritableSignal<string>; previousMonth: WritableSignal<string>; monthsList: WritableSignal<string>; daysList: WritableSignal<string>; years: WritableSignal<string>; months: WritableSignal<string>; chooseYear: WritableSignal<string>; chooseMonthAndYear: WritableSignal<string>; currentYear: WritableSignal<string>; currentMonth: WritableSignal<string>; today: WritableSignal<string>; minDateDisabled: WritableSignal<string>; maxDateDisabled: WritableSignal<string>; }; carousel: { nextPage: WritableSignal<string>; previousPage: WritableSignal<string>; currentOfTotalPages: WritableSignal<string>; previousPageDisabled: WritableSignal<string>; nextPageDisabled: WritableSignal<string>; }; chipSet: { delete: WritableSignal<string>; useBackspaceToDeleteFocusedItems: WritableSignal<string>; }; date: { cancel: WritableSignal<string>; confirm: WritableSignal<string>; chooseDate: WritableSignal<string>; close: WritableSignal<string>; dateAndTimeSelection: WritableSignal<string>; keyboardShortcuts: WritableSignal<string>; legend: WritableSignal<string>; backToCalendar: WritableSignal<string>; borderedNumber: WritableSignal<string>; numberOnly: WritableSignal<string>; numberWithBackground: WritableSignal<string>; numberWithLowOpacity: WritableSignal<string>; date: WritableSignal<string>; time: WritableSignal<string>; period: WritableSignal<string>; am: WritableSignal<string>; pm: WritableSignal<string>; enterSpaceBarKey: WritableSignal<string>; leftAndRightArrowKeys: WritableSignal<string>; upAndDownArrowKeys: WritableSignal<string>; pageUpAndPageDownKeys: WritableSignal<string>; escKey: WritableSignal<string>; errorTitle: WritableSignal<string>; errorDescription: WritableSignal<string>; timeError: WritableSignal<string>; moveDay: WritableSignal<string>; moveDayRtl: WritableSignal<string>; moveWeek: WritableSignal<string>; closeCalendar: WritableSignal<string>; currentDay: WritableSignal<string>; selectableDay: WritableSignal<string>; selectedDay: WritableSignal<string>; disabledDay: WritableSignal<string>; selectADate: WritableSignal<string>; }; expandableContent: { showMore: WritableSignal<string>; showLess: WritableSignal<string>; }; facet: { changePosition: WritableSignal<string>; moveToPosition: WritableSignal<string>; moveToPositionDisabledReason: WritableSignal<string>; collapsePanel: WritableSignal<string>; expandPanel: WritableSignal<string>; }; inputRating: { star: WritableSignal<string>; stars: WritableSignal<string>; }; inputSelect: { addQuery: WritableSignal<string>; charactersInserted: WritableSignal<string>; optionsInserted: WritableSignal<string>; itemsAlreadySelected: WritableSignal<string>; useBackspaceToCancelSelectedItems: WritableSignal<string>; nResultsAvailableWithInstructions: WritableSignal<string>; }; inputSlider: { currentOfMax: WritableSignal<string>; invalidValueNumbersOnly: WritableSignal<string>; }; inputText: { showPassword: WritableSignal<string>; hidePassword: WritableSignal<string>; charactersInserted: WritableSignal<string>; }; inputUpload: { currentOfMaxFiles: WritableSignal<string>; files: WritableSignal<string>; }; menu: { closeSubMenu: WritableSignal<string>; backToParentMenu: WritableSignal<string>; }; paginationBar: { currentOfMax: WritableSignal<string>; currentPage: WritableSignal<string>; currentPageAlternative: WritableSignal<string>; currentSelection: WritableSignal<string>; goToPage: WritableSignal<string>; itemsCount: WritableSignal<string>; ofManyPages: WritableSignal<string>; countOfManyPages: WritableSignal<string>; rangeOfManyPages: WritableSignal<string>; rangeOfManyPagesAlternative: WritableSignal<string>; nextPage: WritableSignal<string>; nextPageButtonDisabledReason: WritableSignal<string>; onePageIsAvailable: WritableSignal<string>; page: WritableSignal<string>; pages: WritableSignal<string>; pagesAreAvailable: WritableSignal<string>; pagesCount: WritableSignal<string>; paginatorRange: WritableSignal<string>; paginatorRangeAlternative: WritableSignal<string>; previousPage: WritableSignal<string>; previousPageButtonDisabledReason: WritableSignal<string>; replacedPageNumber: WritableSignal<string>; rowsPerPage: WritableSignal<string>; }; stepper: { currentOfTotalSteps: WritableSignal<string>; nextStep: WritableSignal<string>; stepPending: WritableSignal<string>; stepInProgress: WritableSignal<string>; stepPartiallyCompleted: WritableSignal<string>; stepCompleted: WritableSignal<string>; stepError: WritableSignal<string>; stepErrors: WritableSignal<string>; backToStep: WritableSignal<string>; }; toast: { platformFeedback: WritableSignal<string>; }; search: { searchInScope: WritableSignal<string>; search: WritableSignal<string>; searchOptions: WritableSignal<string>; }; dataBrowser: { close: WritableSignal<string>; }; filterMultipleSelection: { showMore: WritableSignal<string>; showLess: WritableSignal<string>; showMoreAriaLabel: WritableSignal<string>; showLessAriaLabel: WritableSignal<string>; results: WritableSignal<string>; resultsAnnouncement: WritableSignal<string>; noResults: WritableSignal<string>; tryDifferentCriteria: WritableSignal<string>; }; table: { resizeColumn: WritableSignal<string>; sortingColumn: WritableSignal<string>; sortAscending: WritableSignal<string>; sortDescending: WritableSignal<string>; removeSorting: WritableSignal<string>; selectRow: WritableSignal<string>; selectAllRows: WritableSignal<string>; }; }
listName r	`InputSignal<string \| Signal<string>>`
nativeElement r	`HTMLElement`
negative r	`InputSignalWithTransform<boolean, unknown>`	Set negative state
shouldShowBackButton p r	`Signal<number \| false>`	Whether to show the back button based on: backButtonHidden is false there are more than 1 displayed links there are collapsed links
shouldShowCollapsedMenu p r	`Signal<boolean>`
shouldShowDivider p r	`Signal<boolean>`
triggerBackButton r	`OutputEmitterRef<Event>`
triggerLink r	`OutputEmitterRef<LmnBreadcrumbsLinkTriggerEvent>`
triggerListItem r	`OutputEmitterRef<LmnListItemTriggerEvent>`
visibleElementThresholds r	`InputSignal<Partial<Record<LmnWidthZone, number>>>`	Maximum number of links to display based on width zone

Methods

#getMaxLinksForWidthZone()

Get the maximum number of links to display based on the current width zone. The method merges default values (lg: 6, md: 4, sm: 3) with any custom values provided through the input, ensuring that each width zone has a valid number of links to display.

Presentation

#getMaxLinksForWidthZone(widthZone: LmnWidthZone): number;

Parameters

Name	Type	Description
widthZone	`LmnWidthZone`	@param widthZone - The current width zone ('lg', 'md', 'sm')

Returns

number -

The maximum number of links to display for the given width zone

protected

onLinkClick()

Handle link click or keyboard event

Presentation

protected onLinkClick(event: Event, link: LmnBreadcrumbsLink): void;

Parameters

Name	Type	Description
event	`Event`	@param event - The mouse or keyboard event
link	`LmnBreadcrumbsLink`	@param link - The clicked breadcrumb link

Returns

void

Decorators:	`@Component`
Selectors:	`lmn-breadcrumbs`