- Accordion
- Alert
- Alert Dialog
- Aspect Ratio
- Attachment
- Autocomplete
- Avatar
- Badge
- Breadcrumb
- Bubble
- Button
- Button Group
- Calendar
- Card
- Carousel
- Chart
- Checkbox
- Code Block
- Collapsible
- Combobox
- Command
- Context Menu
- Data Table
- Date Picker
- Dialog
- Drawer
- Dropdown Menu
- Empty
- Field
- Hover Card
- Input Group
- Input OTP
- Input
- Item
- Kbd
- Label
- Marker
- Menubar
- Message
- Message Scroller
- Native Select
- Navigation Menu
- Pagination
- Popover
- Progress
- Questionnaire
- Radio Group
- Resizable
- Scroll Area
- Select
- Separator
- Sheet
- Sidebar
- Skeleton
- Slider
- Sonner (Toast)
- Spinner
- Switch
- Table
- Tabs
- Textarea
- Toggle
- Toggle Group
- Tooltip
- Trace
Breadcrumb
Displays the path to the current resource using a hierarchy of links.
import { Component } from '@angular/core';
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';
import { HlmDropdownMenuImports } from '@spartan-ng/helm/dropdown-menu';
@Component({
selector: 'spartan-breadcrumb-preview',
imports: [HlmBreadcrumbImports, HlmDropdownMenuImports],
template: `
<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">Home</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<button [hlmDropdownMenuTrigger]="breadcrumbDropdown">
<hlm-breadcrumb-ellipsis />
<span class="sr-only">Toggle menu</span>
</button>
<ng-template #breadcrumbDropdown>
<hlm-dropdown-menu>
<button hlmDropdownMenuItem id="document">
<span>Documentation</span>
</button>
<button hlmDropdownMenuItem id="themes">
<span>Themes</span>
</button>
<button hlmDropdownMenuItem id="github">
<span>Github</span>
</button>
</hlm-dropdown-menu>
</ng-template>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/components">Components</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>Breadcrumb</span>
</li>
</ol>
</nav>
`,
})
export class BreadcrumbPreview {}Installation
ng g @spartan-ng/cli:ui breadcrumbnx g @spartan-ng/cli:ui breadcrumbimport { OVERLAY_DEFAULT_CONFIG } from '@angular/cdk/overlay';
import { brnClasses, type BrnClassesOptions } from '@spartan-ng/brain/core';
import { cn, type ClassValue } from 'cn';
import { createCn } from 'cn/config';
import { makeEnvironmentProviders, type EnvironmentProviders } from '@angular/core';
import { provideSpartanHlm } from '@spartan-ng/helm/utils';
/**
* Merges class values and resolves Tailwind CSS conflicts.
*
* To customize the merge (e.g. register custom theme values), create your own instance:
*
* @example
* ```ts
*
*
* export const hlm = createCn({
* extend: { classGroups: { 'font-size': [{ text: ['hero'] }] } },
* });
* ```
*/
export const hlm = cn;
/**
* This function dynamically adds and removes classes for a given element without requiring
* the a class binding (e.g. `[class]="..."`) which may interfere with other class bindings.
* The classes are merged with `hlm`.
*/
export function classes(computed: () => ClassValue[] | string, options: Omit<BrnClassesOptions, 'merge'> = {}) {
brnClasses(computed, { ...options, merge: hlm });
}
/**
* Provides default configuration for Spartan Helm components.
*
* This utility configures the Angular CDK overlay to disable the `usePopover`
* behavior introduced in Angular 21, which causes CDK overlay-based components
* (sheets, dialogs, tooltips, etc.) to render above `position: fixed` elements
* like `<hlm-toaster>`.
*
* @returns {EnvironmentProviders} Environment providers to be added to the application config.
*
* @example
* ```ts
* // app.config.ts
*
*
* export const appConfig: ApplicationConfig = {
* providers: [
* provideSpartanHlm(),
* // ... other providers
* ],
* };
* ```
*/
export function provideSpartanHlm(): EnvironmentProviders {
return makeEnvironmentProviders([
{
provide: OVERLAY_DEFAULT_CONFIG,
useValue: { usePopover: false },
},
]);
}import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-5 [&>ng-icon]:text-[length:--spacing(4)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-sm flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-5 [&>ng-icon]:text-[length:--spacing(4)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1.5 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-sm sm:gap-2.5 flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-5 [&>ng-icon]:text-[length:--spacing(4)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-xs flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-5 [&>ng-icon]:text-[length:--spacing(4)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1.5 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-sm sm:gap-2.5 flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-4 [&>ng-icon]:text-[length:--spacing(3.5)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-xs/relaxed flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;import { ChangeDetectionStrategy, Component, Directive, input } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { RouterLink } from '@angular/router';
import { classes } from '@spartan-ng/helm/utils';
import { lucideChevronRight, lucideEllipsis } from '@ng-icons/lucide';
@Component({
selector: 'hlm-breadcrumb-ellipsis',
exportAs: 'hlmBreadcrumbEllipsis',
imports: [NgIcon],
providers: [provideIcons({ lucideEllipsis })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-ellipsis',
role: 'presentation',
},
template: `
<ng-icon name="lucideEllipsis" />
<span class="sr-only">{{ srOnlyText() }}</span>
`,
})
export class HlmBreadcrumbEllipsis {
/** Screen reader only text for the ellipsis */
public readonly srOnlyText = input<string>('More');
constructor() {
classes(() => 'size-5 [&>ng-icon]:text-[length:--spacing(4)] flex items-center justify-center');
}
}
@Directive({
selector: '[hlmBreadcrumbItem]',
exportAs: 'hlmBreadcrumbItem',
host: {
'data-slot': 'breadcrumb-item',
},
})
export class HlmBreadcrumbItem {
constructor() {
classes(() => 'gap-1.5 inline-flex items-center');
}
}
@Directive({
selector: '[hlmBreadcrumbLink]',
exportAs: 'hlmBreadcrumbLink',
hostDirectives: [
{
directive: RouterLink,
inputs: [
'target',
'queryParams',
'fragment',
'queryParamsHandling',
'state',
'info',
'relativeTo',
'preserveFragment',
'skipLocationChange',
'replaceUrl',
'routerLink: link',
],
},
],
host: {
'data-slot': 'breadcrumb-link',
},
})
export class HlmBreadcrumbLink {
/** The link to navigate to the page. */
public readonly link = input<RouterLink['routerLink']>();
constructor() {
classes(() => 'hover:text-foreground transition-colors');
}
}
@Directive({
selector: '[hlmBreadcrumbList]',
exportAs: 'hlmBreadcrumbList',
host: {
'data-slot': 'breadcrumb-list',
},
})
export class HlmBreadcrumbList {
constructor() {
classes(() => 'text-muted-foreground gap-1.5 text-sm sm:gap-2.5 flex flex-wrap items-center wrap-break-word');
}
}
@Directive({
selector: '[hlmBreadcrumbPage]',
exportAs: 'hlmBreadcrumbPage',
host: {
'data-slot': 'breadcrumb-page',
role: 'link',
'aria-disabled': 'true',
'aria-current': 'page',
},
})
export class HlmBreadcrumbPage {
constructor() {
classes(() => 'text-foreground font-normal');
}
}
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: '[hlmBreadcrumbSeparator]',
exportAs: 'hlmBreadcrumbSeparator',
imports: [NgIcon],
providers: [provideIcons({ lucideChevronRight })],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
'data-slot': 'breadcrumb-separator',
role: 'presentation',
'aria-hidden': 'true',
},
template: `
<ng-content>
<ng-icon name="lucideChevronRight" />
</ng-content>
`,
})
export class HlmBreadcrumbSeparator {
constructor() {
classes(() => '[&>ng-icon]:text-[length:--spacing(3.5)] [&>ng-icon]:flex');
}
}
@Directive({
selector: '[hlmBreadcrumb]',
exportAs: 'hlmBreadcrumb',
host: {
'data-slot': 'breadcrumb',
role: 'navigation',
'[attr.aria-label]': 'ariaLabel()',
},
})
export class HlmBreadcrumb {
public readonly ariaLabel = input<string>('breadcrumb', { alias: 'aria-label' });
}
export const HlmBreadcrumbImports = [
HlmBreadcrumb,
HlmBreadcrumbEllipsis,
HlmBreadcrumbSeparator,
HlmBreadcrumbItem,
HlmBreadcrumbLink,
HlmBreadcrumbPage,
HlmBreadcrumbList,
] as const;Usage
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">Home</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<hlm-breadcrumb-ellipsis />
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/components">Components</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>Breadcrumb</span>
</li>
</ol>
</nav>Examples
Custom separator
Use a custom component as children for HlmBreadcrumbSeparator to create a custom separator.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideSlash } from '@ng-icons/lucide';
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';
@Component({
selector: 'spartan-breadcrumb-custom-separator',
imports: [HlmBreadcrumbImports, NgIcon],
providers: [provideIcons({ lucideSlash })],
template: `
<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">Home</a>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideSlash" />
</li>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/components">Components</a>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideSlash" />
</li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>Breadcrumb</span>
</li>
</ol>
</nav>
`,
})
export class BreadcrumbCustomSeparator {}Dropdown
You can compose HlmBreadcrumbItem for HlmDropdownMenu to create a custom separator.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideChevronDown, lucideSlash } from '@ng-icons/lucide';
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';
import { HlmDropdownMenuImports } from '@spartan-ng/helm/dropdown-menu';
@Component({
selector: 'spartan-breadcrumb-dropdown',
imports: [HlmBreadcrumbImports, NgIcon, HlmDropdownMenuImports],
providers: [provideIcons({ lucideChevronDown, lucideSlash })],
template: `
<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">Home</a>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideSlash" />
</li>
<li hlmBreadcrumbItem>
<button class="flex items-center gap-1" [hlmDropdownMenuTrigger]="breadcrumbDropdown">
Components
<ng-icon name="lucideChevronDown" />
</button>
<ng-template #breadcrumbDropdown>
<hlm-dropdown-menu>
<button hlmDropdownMenuItem id="document">
<span>Documentation</span>
</button>
<button hlmDropdownMenuItem id="themes">
<span>Themes</span>
</button>
<button hlmDropdownMenuItem id="github">
<span>Github</span>
</button>
</hlm-dropdown-menu>
</ng-template>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideSlash" />
</li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>Breadcrumb</span>
</li>
</ol>
</nav>
`,
})
export class BreadcrumbDropdown {}Collapsed
We provide a HlmBreadcrumbEllipsis component to show a collapsed state when the breadcrumb is too long.
import { Component } from '@angular/core';
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';
@Component({
selector: 'spartan-breadcrumb-collapsed',
imports: [HlmBreadcrumbImports],
template: `
<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">Home</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<hlm-breadcrumb-ellipsis />
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/components">Components</a>
</li>
<li hlmBreadcrumbSeparator></li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>Breadcrumb</span>
</li>
</ol>
</nav>
`,
})
export class BreadcrumbCollapsed {}RTL
To enable RTL support in spartan-ng, see the RTL configuration guide.
import { Component, computed, inject } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideDot } from '@ng-icons/lucide';
import { TranslateService, Translations } from '@spartan-ng/app/app/shared/translate.service';
import { HlmBreadcrumbImports } from '@spartan-ng/helm/breadcrumb';
@Component({
selector: 'spartan-breadcrumb-rtl',
imports: [HlmBreadcrumbImports, NgIcon],
providers: [provideIcons({ lucideDot })],
host: {
'[dir]': '_dir()',
},
template: `
<nav hlmBreadcrumb>
<ol hlmBreadcrumbList>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/">{{ _t()['home'] }}</a>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideDot" />
</li>
<li hlmBreadcrumbItem>
<a hlmBreadcrumbLink link="/components">{{ _t()['components'] }}</a>
</li>
<li hlmBreadcrumbSeparator>
<ng-icon name="lucideDot" />
</li>
<li hlmBreadcrumbItem>
<span hlmBreadcrumbPage>{{ _t()['breadcrumb'] }}</span>
</li>
</ol>
</nav>
`,
})
export class BreadcrumbRtl {
private readonly _language = inject(TranslateService).language;
private readonly _translations: Translations = {
en: {
dir: 'ltr',
values: {
home: 'Home',
components: 'Components',
documentation: 'Documentation',
themes: 'Themes',
github: 'GitHub',
breadcrumb: 'Breadcrumb',
},
},
ar: {
dir: 'rtl',
values: {
home: 'الرئيسية',
components: 'المكونات',
documentation: 'التوثيق',
themes: 'السمات',
github: 'جيت هاب',
breadcrumb: 'مسار التنقل',
},
},
he: {
dir: 'rtl',
values: {
home: 'בית',
components: 'רכיבים',
documentation: 'תיעוד',
themes: 'ערכות נושא',
github: 'גיטהאב',
breadcrumb: 'פירורי לחם',
},
},
};
private readonly _translation = computed(() => this._translations[this._language()]);
protected readonly _t = computed(() => this._translation().values);
protected readonly _dir = computed(() => this._translation().dir);
}Helm API
HlmBreadcrumbEllipsis
Selector: hlm-breadcrumb-ellipsis
ExportAs: hlmBreadcrumbEllipsis
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| srOnlyText | string | 'More' | Screen reader only text for the ellipsis |
HlmBreadcrumbItem
Selector: [hlmBreadcrumbItem]
ExportAs: hlmBreadcrumbItem
HlmBreadcrumbLink
Selector: [hlmBreadcrumbLink]
ExportAs: hlmBreadcrumbLink
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| link | RouterLink['routerLink'] | - | The link to navigate to the page. |
HlmBreadcrumbList
Selector: [hlmBreadcrumbList]
ExportAs: hlmBreadcrumbList
HlmBreadcrumbPage
Selector: [hlmBreadcrumbPage]
ExportAs: hlmBreadcrumbPage
HlmBreadcrumbSeparator
Selector: [hlmBreadcrumbSeparator]
ExportAs: hlmBreadcrumbSeparator
HlmBreadcrumb
Selector: [hlmBreadcrumb]
ExportAs: hlmBreadcrumb
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| aria-label | string | 'breadcrumb' | - |
On This Page