Skip to content

fix(breadcrumb): add nav landmark label inputs #19569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manichandra wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(breadcrumb): add nav landmark label inputs #19569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion packages/primeng/src/breadcrumb/breadcrumb.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Breadcrumb } from './breadcrumb';

@Component({
standalone: false,
template: ` <p-breadcrumb [model]="model" [home]="home" [style]="style" [styleClass]="styleClass" [homeAriaLabel]="homeAriaLabel" (onItemClick)="onItemClick($event)"> </p-breadcrumb> `
template: ` <p-breadcrumb [model]="model" [home]="home" [style]="style" [styleClass]="styleClass" [homeAriaLabel]="homeAriaLabel" [ariaLabel]="ariaLabel" [ariaLabelledBy]="ariaLabelledBy" (onItemClick)="onItemClick($event)"> </p-breadcrumb> `
})
class TestBasicBreadcrumbComponent {
model: MenuItem[] | undefined = [
Expand All @@ -22,6 +22,8 @@ class TestBasicBreadcrumbComponent {
style: { [key: string]: any } | undefined;
styleClass: string | undefined;
homeAriaLabel: string | undefined = 'Home';
ariaLabel: string | undefined;
ariaLabelledBy: string | undefined;
clickedItem: BreadcrumbItemClickEvent | undefined;

onItemClick(event: BreadcrumbItemClickEvent) {
Expand Down Expand Up @@ -231,6 +233,8 @@ describe('Breadcrumb', () => {
expect(freshBreadcrumb.style).toBeUndefined();
expect(freshBreadcrumb.styleClass).toBeUndefined();
expect(freshBreadcrumb.homeAriaLabel).toBeUndefined();
expect(freshBreadcrumb.ariaLabel).toBeUndefined();
expect(freshBreadcrumb.ariaLabelledBy).toBeUndefined();
});

it('should accept custom values', async () => {
Expand All @@ -241,6 +245,8 @@ describe('Breadcrumb', () => {
component.home = testHome;
component.styleClass = 'custom-class';
component.homeAriaLabel = 'Custom Home';
component.ariaLabel = 'Main breadcrumb';
component.ariaLabelledBy = 'breadcrumb-heading';
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
fixture.detectChanges();
Expand All @@ -249,6 +255,8 @@ describe('Breadcrumb', () => {
expect(breadcrumbInstance.home).toBe(testHome);
expect(breadcrumbInstance.styleClass).toBe('custom-class');
expect(breadcrumbInstance.homeAriaLabel).toBe('Custom Home');
expect(breadcrumbInstance.ariaLabel).toBe('Main breadcrumb');
expect(breadcrumbInstance.ariaLabelledBy).toBe('breadcrumb-heading');
});

it('should initialize templates properties', () => {
Expand Down Expand Up @@ -309,12 +317,34 @@ describe('Breadcrumb', () => {
expect(breadcrumbInstance.homeAriaLabel).toBe('Go to home page');
});

it('should bind aria label to the navigation landmark', async () => {
component.ariaLabel = 'Primary breadcrumb';
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
fixture.detectChanges();

const nav = fixture.debugElement.query(By.css('nav'));
expect(nav.nativeElement.getAttribute('aria-label')).toBe('Primary breadcrumb');
});

it('should bind aria labelledby to the navigation landmark', async () => {
component.ariaLabelledBy = 'breadcrumb-title';
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
fixture.detectChanges();

const nav = fixture.debugElement.query(By.css('nav'));
expect(nav.nativeElement.getAttribute('aria-labelledby')).toBe('breadcrumb-title');
});

it('should handle undefined inputs', async () => {
component.model = undefined as any;
component.home = undefined as any;
component.style = undefined as any;
component.styleClass = undefined as any;
component.homeAriaLabel = undefined as any;
component.ariaLabel = undefined as any;
component.ariaLabelledBy = undefined as any;
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
fixture.detectChanges();
Expand All @@ -324,6 +354,8 @@ describe('Breadcrumb', () => {
expect(breadcrumbInstance.style).toBeUndefined();
expect(breadcrumbInstance.styleClass).toBeUndefined();
expect(breadcrumbInstance.homeAriaLabel).toBeUndefined();
expect(breadcrumbInstance.ariaLabel).toBeUndefined();
expect(breadcrumbInstance.ariaLabelledBy).toBeUndefined();
});
});

Expand Down
12 changes: 11 additions & 1 deletion packages/primeng/src/breadcrumb/breadcrumb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const BREADCRUMB_INSTANCE = new InjectionToken<Breadcrumb>('BREADCRUMB_INSTANCE'
standalone: true,
imports: [CommonModule, RouterModule, RouterLink, RouterLinkActive, TooltipModule, ChevronRightIcon, HomeIcon, SharedModule, Bind, Badge],
template: `
<nav [pBind]="ptm('root')" [class]="cn(cx('root'), styleClass)" [style]="style">
<nav [pBind]="ptm('root')" [class]="cn(cx('root'), styleClass)" [style]="style" [attr.aria-label]="ariaLabel" [attr.aria-labelledby]="ariaLabelledBy">
<ol [class]="cx('list')" [pBind]="ptm('list')">
<li [attr.id]="home.id" [class]="cn(cx('homeItem'), home.styleClass)" [ngStyle]="home.style" *ngIf="home && home.visible !== false" pTooltip [tooltipOptions]="home.tooltipOptions" [pBind]="ptm('homeItem')" [unstyled]="unstyled()">
@if (itemTemplate || _itemTemplate) {
Expand Down Expand Up @@ -199,6 +199,16 @@ export class Breadcrumb extends BaseComponent<BreadcrumbPassThrough> {
* @group Props
*/
@Input() homeAriaLabel: string | undefined;
/**
* Defines a string value that labels the navigation landmark for accessibility.
* @group Props
*/
@Input() ariaLabel: string | undefined;
/**
* Identifier of the element that labels the navigation landmark for accessibility.
* @group Props
*/
@Input() ariaLabelledBy: string | undefined;
/**
* Fired when an item is selected.
* @param {BreadcrumbItemClickEvent} event - custom click event.
Expand Down
Loading