fix(checkbox-group): fix the checkbox-group to get it working properly with tooltips#3322
Draft
anna-lach wants to merge 13 commits into
Draft
fix(checkbox-group): fix the checkbox-group to get it working properly with tooltips#3322anna-lach wants to merge 13 commits into
anna-lach wants to merge 13 commits into
Conversation
…y with tooltips, unit tests and WithTooltips story
🦋 Changeset detectedLatest commit: 3bb66db The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR 💥 An error occurred when fetching the changed packages and changesets in this PR |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes sl-checkbox-group behavior when non-checkbox elements (e.g., sl-tooltip) are present in its default slot, ensuring the group only operates on actual checkboxes.
Changes:
- Restrict the group’s slotted-element query to
sl-checkboxelements only. - Add a Storybook scenario demonstrating a checkbox group with tooltips in the slot.
- Add regression tests verifying the group ignores
sl-tooltipelements when computingboxesandvalue.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/components/checkbox/src/checkbox-group.ts | Filters @queryAssignedElements to only return sl-checkbox, preventing tooltip elements from being treated as checkboxes. |
| packages/components/checkbox/src/checkbox-group.stories.ts | Adds a WithTooltips story to reproduce/verify checkbox-group behavior with tooltips present. |
| packages/components/checkbox/src/checkbox-group.spec.ts | Adds regression coverage for tooltip-in-slot scenarios and registers the tooltip element for the test environment. |
Contributor
🕸 Website previewYou can view a preview here (commit |
Contributor
🕸 Storybook previewYou can view a preview here (commit |
anna-lach
requested review from
Diaan,
a11ymiko,
jpzwarte and
michal-sanoma
as code owners
a11ymiko
reviewed
May 14, 2026
Contributor
a11ymiko
left a comment
a11ymiko
left a comment
There was a problem hiding this comment.
Text from tooltips is not announced by VoiceOver nor NVDA.
Adding aria-describedby=TOOLTIP_ID to input instead of sl-checkbox may fix this issue.
Current behavior:
Screen.Recording.2026-05-14.at.16.48.56.mov
Screen.Recording.2026-05-14.at.16.51.37.mov
Possible solution:
a11ymiko
reviewed
May 14, 2026
Contributor
a11ymiko
left a comment
a11ymiko
left a comment
There was a problem hiding this comment.
Checkbox labels are not announced by NVDA in browse mode (navigation with arrows) for Checkbox With Tooltip story. Checkboxes are announced as 'clicable chechk box required invalid entry' without name, that is provided by label.
This is announced properly in Checkbox group With Tooltips story.
Current behavior:
Screen.Recording.2026-05-14.at.17.42.26.mov
Expected behavior:
Screen.Recording.2026-05-14.at.17.43.06.mov
…ltip-breaks-sl-checkbox-group
…rying to get tooltips working properly with checkboxes
…y (issues with plain label)
…th labels properly
…ltip-breaks-sl-checkbox-group
Comment on lines
+293
to
+297
| // If no elements could be resolved at all and the target is in the same | ||
| // scope, just remove the attribute from the host — there's nothing useful | ||
| // to set as a string attribute. For cross-scope targets, still forward the | ||
| // empty array so consumers reading the native property get a deterministic []. | ||
| if (elements.length === 0) { |
| --- | ||
|
|
||
| Fix checkbox group not working with tooltips (only `sl-checkbox` elements are tracked by `@queryAssignedElements`). | ||
| Use `ForwardAriaMixin` to forward `aria-describedby` as element references to the inner input element, enabling screen reader support. |
Comment on lines
+341
to
+342
| resolves IDs to element references and forwards them to the focusable input element, which | ||
| properly crosses the shadow DOM boundary. |
Comment on lines
+213
to
+220
| <sl-checkbox ${tooltip('Newsletter tooltip')} value="newsletter" | ||
| >Newsletter</sl-checkbox | ||
| > | ||
| <sl-checkbox value="promotions" aria-describedby="tooltip1">Promotions</sl-checkbox> | ||
| <sl-tooltip id="tooltip1">Promotions tooltip</sl-tooltip> | ||
| <sl-checkbox ${tooltip('Product updates tooltip')} value="updates" | ||
| >Product updates</sl-checkbox | ||
| > |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3287