Skip to content

label-has-associated-control not checking an actual valid configuration #956

@tomdglenn91

Description

@tomdglenn91

Apologies if I've misunderstood the rule or configured this wrong.

I'm noticing in our code base that labels are often misconfigured, using name as the matcher, not id, which isn't a valid pairing.

I want to ensure that every (custom) input element has an associated label, and it's configured correctly. So the following works out the box:

Given the following configuration:

    'jsx-a11y/label-has-associated-control': [
      'warn',
      {
        labelComponents: ['FormLabel'],
        controlComponents: ['Input', 'Select']
      },
    ],

I expect this to fail, as no HtmlFor, which it fails.

<>
   <FormLabel>Foo</FormLabel>
   <Input name="foo" />
</>

I expect this to fail, as the htmlFor doesn't link to anything, but it doesn't fail. This is the scenario i see in our code base a lot that i want to protect against.

<>
   <FormLabel htmlFor="foo">Foo</FormLabel>
   <Input name="foo" />
</>

Then expect this to pass

<>
   <FormLabel htmlFor="foo">Foo</FormLabel>
   <Input id="foo" name="foo" />
</>

Given that:

This rule checks that any label tag (or an indicated custom component that will output a label tag) either (1) wraps an input element (or an indicated custom component that will output an input tag) or (2) has an htmlFor attribute and that the label tag has text content.

I feel like my expected behaviour is not the reality, but I wasn't quite sure.

Should my expectation work, or am I just misunderstanding the library/rule? Thanks.

Activity

ljharb

ljharb commented on Oct 9, 2023

@ljharb
Member

I would agree that has an htmlFor attribute and that the label tag has text content. matches the reality and not your expectation.

However, I would expect that 2 should also be checking that the htmlFor value matches the label's id value.

That seems like a useful option to add.

michaelfaith

michaelfaith commented on Dec 23, 2024

@michaelfaith
Contributor

I have this change ready to go, but want to land this change making the error messages more specific to the assert type first: #1041

The follow-up change adding the option proposed here builds on that change.

michaelfaith

michaelfaith commented on Jan 12, 2025

@michaelfaith
Contributor

This should be ready for review, when you're able: #1042

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @ljharb@michaelfaith@tomdglenn91

      Issue actions

        label-has-associated-control not checking an actual valid configuration · Issue #956 · jsx-eslint/eslint-plugin-jsx-a11y