Skip to content

Expose slideout widgets as dialogs to assistive technology #671

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
sean-cstk wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Expose slideout widgets as dialogs to assistive technology #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c01d90
Expose slideout widgets as dialogs to assistive technology
sean-cstk Aug 20, 2026
13a87de
Scope A/B spec selectors to the widget root
sean-cstk Aug 21, 2026
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
20 changes: 20 additions & 0 deletions dist/pathfora.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3359,6 +3359,26 @@
constructWidgetLayout(widget, config);
setupWidgetColors(widget, config);

// Slideout templates have no dialog container, so the root element carries the
// dialog semantics. Intentionally no aria-modal: a slideout does not block the
// page or trap focus, and claiming otherwise would mislead assistive technology.
if (config.layout === 'slideout') {
var headline = widget.querySelector('.pf-widget-headline');
var message = widget.querySelector('.pf-widget-message');

widget.setAttribute('role', 'dialog');

if (headline && headline.innerHTML) {
headline.id = config.id + '-headline';
widget.setAttribute('aria-labelledby', headline.id);
}

if (message && message.innerHTML) {
message.id = config.id + '-message';
widget.setAttribute('aria-describedby', message.id);
}
}

return widget;
}

Expand Down
2 changes: 1 addition & 1 deletion dist/pathfora.min.js
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions src/rollup/widgets/create-widget-html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,25 @@ export default function createWidgetHtml (config) {
constructWidgetLayout(widget, config);
setupWidgetColors(widget, config);

// Slideout templates have no dialog container, so the root element carries the
// dialog semantics. Intentionally no aria-modal: a slideout does not block the
// page or trap focus, and claiming otherwise would mislead assistive technology.
if (config.layout === 'slideout') {
var headline = widget.querySelector('.pf-widget-headline');
var message = widget.querySelector('.pf-widget-message');

widget.setAttribute('role', 'dialog');

if (headline && headline.innerHTML) {
headline.id = config.id + '-headline';
widget.setAttribute('aria-labelledby', headline.id);
}

if (message && message.innerHTML) {
message.id = config.id + '-message';
widget.setAttribute('aria-describedby', message.id);
}
}

return widget;
}
12 changes: 6 additions & 6 deletions test/acceptance/ab-testing.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ describe('a/b testing', function () {
pathfora.initializeABTesting([ab]);
pathfora.initializeWidgets([widgetA, widgetB]);

var w = $('[id*="ab-widget1"]');
var w = $('.pf-widget[id*="ab-widget1"]');
expect(w.length).toBe(1);
});

Expand Down Expand Up @@ -69,7 +69,7 @@ describe('a/b testing', function () {
pathfora.initializeABTesting([ab]);
pathfora.initializeWidgets([widget1A, widget2A, widget1B, widget2B]);

var w = $('[id*="ab-widget2"]');
var w = $('.pf-widget[id*="ab-widget2"]');
expect(w.length).toBe(2);

var first = w.first();
Expand Down Expand Up @@ -182,9 +182,9 @@ describe('a/b testing', function () {
pathfora.initializeABTesting([ab, ab2]);
pathfora.initializeWidgets([widgetA, widgetB, widgetC, widgetD]);

var w = $('[id*="ab-widget"]'),
w5 = $('[id*="ab-widget5"]'),
w6 = $('[id*="ab-widget6"]');
var w = $('.pf-widget[id*="ab-widget"]'),
w5 = $('.pf-widget[id*="ab-widget5"]'),
w6 = $('.pf-widget[id*="ab-widget6"]');

expect(w.length).toBe(2);
expect(w5.length).toBe(1);
Expand Down Expand Up @@ -233,7 +233,7 @@ describe('a/b testing', function () {
pathfora.initializeABTesting([ab]);
pathfora.initializeWidgets(widgets);

var w = $('[id*="ab-widget10"]');
var w = $('.pf-widget[id*="ab-widget10"]');
expect(w.length).toBe(1);
});

Expand Down
Loading