Visitar URL original
Add aria-current support to ActiveLink by MohamedAhmedGalhoum · Pull Request #933 · dojo/framework · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Add aria-current support to ActiveLink
  • Loading branch information
MohamedAhmedGalhoum committed Nov 8, 2026
commit 7f352d9935ae0cbe661ddf687cfd3d94aca85fb9
9 changes: 7 additions & 2 deletions src/routing/ActiveLink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import Router from './Router';

export interface ActiveLinkProperties extends LinkProperties {
activeClasses: SupportedClassName[];
ariaCurrent?: 'page' | 'step' | 'location' | 'date' | 'time' | true;
isExact?: boolean;
}

Expand All @@ -23,7 +24,7 @@ export const ActiveLink = factory(function ActiveLink({
children
}) {
const { to, routerKey = 'router', params } = properties();
let { activeClasses, isExact, classes = [], ...props } = properties();
let { activeClasses, ariaCurrent, isExact, classes = [], ...props } = properties();

diffProperty('to', (current: ActiveLinkProperties, next: ActiveLinkProperties) => {
if (current.to !== next.to) {
Expand Down Expand Up @@ -57,10 +58,14 @@ export const ActiveLink = factory(function ActiveLink({
const context = router.getRoute(to);
const isActive = context && paramsEqual(params, { ...context.params, ...context.queryParams });
const contextIsExact = context && context.isExact();
const linkIsActive = isActive && (!isExact || contextIsExact);

classes = Array.isArray(classes) ? classes : [classes];
if (isActive && (!isExact || contextIsExact)) {
if (linkIsActive) {
classes = [...classes, ...activeClasses];
if (ariaCurrent !== undefined) {
props['aria-current'] = ariaCurrent === true ? 'true' : ariaCurrent;
}
}
props = { ...props, classes };
}
Expand Down
24 changes: 24 additions & 0 deletions tests/routing/unit/ActiveLink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,30 @@ describe('ActiveLink', () => {
r.expect(template);
});

it('Should add and remove aria-current as the outlet match status changes', () => {
router.setPath('/other');
const r = renderer(() => w(ActiveLink, { to: 'foo', activeClasses: ['foo'], ariaCurrent: 'page' }), {
middleware: [[getRegistry, mockGetRegistry]]
});
const WrappedLink = wrap(Link);
r.expect(assertion(() => w(WrappedLink, { classes: [], to: 'foo' })));

router.setPath('/foo');
r.expect(assertion(() => w(WrappedLink, { classes: ['foo'], to: 'foo', 'aria-current': 'page' })));

router.setPath('/other');
r.expect(assertion(() => w(WrappedLink, { classes: [], to: 'foo' })));
});

it('Should support true as an aria-current value', () => {
router.setPath('/foo');
const r = renderer(() => w(ActiveLink, { to: 'foo', activeClasses: ['foo'], ariaCurrent: true }), {
middleware: [[getRegistry, mockGetRegistry]]
});
const WrappedLink = wrap(Link);
r.expect(assertion(() => w(WrappedLink, { classes: ['foo'], to: 'foo', 'aria-current': 'true' })));
});

it('Should render the ActiveLink children when matching query params', () => {
router.setPath('/query/path?query=query');
const r = renderer(
Expand Down