fix: support form-associated custom elements in isLabelable#1380
Open
mixelburg wants to merge 1 commit into
Open
fix: support form-associated custom elements in isLabelable#1380mixelburg wants to merge 1 commit into
mixelburg wants to merge 1 commit into
Conversation
Form-associated custom elements using the ElementInternals API (static formAssociated = true) can be targeted by <label> elements and should be considered labelable by getByLabelText(). Previously, isLabelable() only checked for standard HTML form elements (BUTTON, INPUT, METER, OUTPUT, PROGRESS, SELECT, TEXTAREA), causing getByLabelText() to fail for form-associated custom elements with the error: 'the element associated with this label is non-labellable'. The fix adds a check for custom elements (tags containing a hyphen) that have the attachInternals() method. When available, we call it and check if internals.formAssociated is true. This is wrapped in a try-catch to handle environments that don't support ElementInternals. All 666 existing tests pass. Fixes testing-library#1343
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 9e553dd:
|
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.
Description
Form-associated custom elements using the
ElementInternalsAPI (static formAssociated = true) can be targeted by<label>elements and should be considered labelable bygetByLabelText().Previously,
isLabelable()only checked for standard HTML form elements (BUTTON,INPUT,METER,OUTPUT,PROGRESS,SELECT,TEXTAREA), causinggetByLabelText()to fail for form-associated custom elements with the error:Solution
Added a check for custom elements (tags containing a hyphen) that have the
attachInternals()method. When available, we call it and check ifinternals.formAssociated === true. This is wrapped in a try-catch to gracefully handle:ElementInternalsattachInternals()is called on non-form-associated custom elementsChanges
src/label-helpers.ts: ExtendedisLabelable()to detect form-associated custom elementsTesting
ElementInternalssupport (older jsdom), behavior is unchangedFixes #1343