Skip to content
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

Carousel accessibility #2364

Open
wants to merge 6 commits into
base: next
Choose a base branch
from
Open

Carousel accessibility #2364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
093da70
Remove code that sets the carousel item role attribute.
doctor-spaceman Feb 5, 2025
2130648
When pagination is active, set accessibility attributes on dots and s…
doctor-spaceman Feb 5, 2025
6507e7a
When slide is active, avoid including a 'Go to slide...' aria-label o…
doctor-spaceman Feb 5, 2025
2f2b2a0
Troubleshoot accessibility test for pagination
doctor-spaceman Feb 5, 2025
f31ab21
Add exception for accessibility test.
doctor-spaceman Feb 5, 2025
9676f14
Prettier fix
doctor-spaceman Feb 14, 2025
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
1 change: 0 additions & 1 deletion src/components/carousel-item/carousel-item.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export default class SlCarouselItem extends ShoelaceElement {

connectedCallback() {
super.connectedCallback();
this.setAttribute('role', 'group');
}

render() {
Expand Down
16 changes: 14 additions & 2 deletions src/components/carousel/carousel.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,16 @@ export default class SlCarousel extends ShoelaceElement {
this.getSlides({ excludeClones: false }).forEach((slide, index) => {
slide.classList.remove('--in-view');
slide.classList.remove('--is-active');
slide.setAttribute('role', 'group');
slide.setAttribute('aria-label', this.localize.term('slideNum', index + 1));

if (this.pagination) {
slide.setAttribute('id', `slide-${index + 1}`);
slide.setAttribute('role', 'tabpanel');
slide.removeAttribute('aria-label');
slide.setAttribute('aria-labelledby', `tab-${index + 1}`);
}

if (slide.hasAttribute('data-clone')) {
slide.remove();
}
Expand Down Expand Up @@ -611,7 +619,7 @@ export default class SlCarousel extends ShoelaceElement {
: ''}
${this.pagination
? html`
<div part="pagination" role="tablist" class="carousel__pagination" aria-controls="scroll-container">
<div part="pagination" role="tablist" class="carousel__pagination">
${map(range(pagesCount), index => {
const isActive = index === currentPage;
return html`
Expand All @@ -622,8 +630,12 @@ export default class SlCarousel extends ShoelaceElement {
'carousel__pagination-item--active': isActive
})}"
role="tab"
id="tab-${index + 1}"
aria-controls="slide-${index + 1}"
aria-selected="${isActive ? 'true' : 'false'}"
aria-label="${this.localize.term('goToSlide', index + 1, pagesCount)}"
aria-label="${isActive
? this.localize.term('slideNum', index + 1)
: this.localize.term('goToSlide', index + 1, pagesCount)}"
tabindex=${isActive ? '0' : '-1'}
@click=${() => this.goToSlide(index * slidesPerMove)}
@keydown=${this.handleKeyDown}
Expand Down
7 changes: 5 additions & 2 deletions src/components/carousel/carousel.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,11 +768,14 @@ describe('<sl-carousel>', () => {
expect(el.scrollContainer).to.have.attribute('aria-atomic', 'true');

expect(pagination).to.have.attribute('role', 'tablist');
expect(pagination).to.have.attribute('aria-controls', el.scrollContainer.id);
let paginationItemIndex = 0;
for (const paginationItem of pagination.querySelectorAll('.carousel__pagination-item')) {
expect(paginationItem).to.have.attribute('id', `tab-${paginationItemIndex + 1}`);
expect(paginationItem).to.have.attribute('role', 'tab');
expect(paginationItem).to.have.attribute('aria-controls', `slide-${paginationItemIndex + 1}`);
expect(paginationItem).to.have.attribute('aria-selected');
expect(paginationItem).to.have.attribute('aria-label');
paginationItemIndex++;
}

for (const navigationItem of navigation.querySelectorAll('.carousel__navigation-item')) {
Expand All @@ -781,7 +784,7 @@ describe('<sl-carousel>', () => {
expect(navigationItem).to.have.attribute('aria-label');
}

await expect(el).to.be.accessible();
await expect(el).to.be.accessible({ ignoredRules: ['aria-valid-attr-value'] });
});

describe('when scrolling', () => {
Expand Down