Skip to content

feat(eslint-plugin): add new @elastic/eui/no-unnamed-radio-group rule #8929

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

Merged
weronikaolejniczak merged 2 commits into from
Jul 31, 2025
Merged

feat(eslint-plugin): add new @elastic/eui/no-unnamed-radio-group rule #8929

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
40ee53c
feat(eslint-plugin): add new `@elastic/eui/no-unnamed-radio-group` rule
alexwizp Jul 30, 2025
5e2ec1c
changelog
alexwizp Jul 30, 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
4 changes: 4 additions & 0 deletions packages/eslint-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,10 @@ Ensures `disableScreenReaderOutput` is set when `EuiToolTip` content matches `Eu

Ensure `EuiIconTip` is used rather than `<EuiToolTip><EuiIcon/></EuiToolTip>`, as it provides better accessibility and improved support for assistive technologies.

### `@elastic/eui/no-unnamed-radio-group`

Ensure that all radio input components (`EuiRadio`, `EuiRadioGroup`) have a `name` attribute. The `name` attribute is required for radio inputs to be grouped correctly, allowing users to select only one option from a set. Without a `name`, radios may not behave as expected and can cause accessibility issues for assistive technologies.

## Testing

### Running unit tests
Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/changelogs/upcoming/8929.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Added new `no-unnamed-radio-group` rule.
3 changes: 3 additions & 0 deletions packages/eslint-plugin/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { RequireAriaLabelForModals } from './rules/a11y/require_aria_label_for_m
import { ConsistentIsInvalidProps } from './rules/a11y/consistent_is_invalid_props';
import { ScreenReaderOutputDisabledTooltip } from './rules/a11y/sr_output_disabled_tooltip';
import { PreferEuiIconTip } from './rules/a11y/prefer_eui_icon_tip';
import { NoUnnamedRadioGroup } from './rules/a11y/no_unnamed_radio_group';

const config = {
rules: {
Expand All @@ -35,6 +36,7 @@ const config = {
'consistent-is-invalid-props': ConsistentIsInvalidProps,
'sr-output-disabled-tooltip': ScreenReaderOutputDisabledTooltip,
'prefer-eui-icon-tip': PreferEuiIconTip,
'no-unnamed-radio-group' : NoUnnamedRadioGroup,
},
configs: {
recommended: {
Expand All @@ -47,6 +49,7 @@ const config = {
'@elastic/eui/consistent-is-invalid-props': 'warn',
'@elastic/eui/sr-output-disabled-tooltip': 'warn',
'@elastic/eui/prefer-eui-icon-tip': 'warn',
'@elastic/eui/no-unnamed-radio-group': 'warn',
},
},
},
Expand Down
99 changes: 99 additions & 0 deletions packages/eslint-plugin/src/rules/a11y/no_unnamed_radio_group.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import dedent from 'dedent';
import { RuleTester } from '@typescript-eslint/rule-tester';
import { NoUnnamedRadioGroup } from './no_unnamed_radio_group';

const languageOptions = {
parserOptions: {
ecmaFeatures: {
jsx: true,
},
},
};

const ruleTester = new RuleTester();

ruleTester.run('no-unnamed-radio-group', NoUnnamedRadioGroup, {
valid: [
{
code: dedent`
const MyComponent = () => (
<EuiRadio name="group1" />
)
`,
languageOptions,
},
{
code: dedent`
const MyComponent = () => (
<EuiRadioGroup name="group2" />
)
`,
languageOptions,
},
{
code: dedent`
const MyComponent = () => (
<div>Not a radio</div>
)
`,
languageOptions,
},
{
code: dedent`
const MyComponent = () => (
<EuiRadio name={dynamicName} />
)
`,
languageOptions,
},
],
invalid: [
{
code: dedent`
const MyComponent = () => (
<EuiRadio />
)
`,
languageOptions,
errors: [
{
messageId: 'missingRadioName',
data: { component: 'EuiRadio' },
},
],
},
{
code: dedent`
const MyComponent = () => (
<EuiRadioGroup />
)
`,
languageOptions,
errors: [
{
messageId: 'missingRadioName',
data: { component: 'EuiRadioGroup' },
},
],
},
],
});
63 changes: 63 additions & 0 deletions packages/eslint-plugin/src/rules/a11y/no_unnamed_radio_group.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { ESLintUtils } from '@typescript-eslint/utils';

const radioComponents = ['EuiRadio', 'EuiRadioGroup'];

export const NoUnnamedRadioGroup = ESLintUtils.RuleCreator.withoutDocs({
create(context) {
return {
JSXOpeningElement(node) {
if (
node.name.type === 'JSXIdentifier' &&
radioComponents.includes(node.name.name)
) {
const hasNameAttr = node.attributes.some(
(attr) =>
attr.type === 'JSXAttribute' &&
attr.name.type === 'JSXIdentifier' &&
attr.name.name === 'name'
);

if (!hasNameAttr) {
context.report({
node,
messageId: 'missingRadioName',
data: { component: node.name.name },
});
}
}
},
};
},
meta: {
type: 'problem',
docs: {
description:
'Ensure that all radio input components have a `name` attribute. The `name` attribute is required for radio inputs to be grouped correctly, allowing users to select only one option from a set. Without a `name`, radios may not behave as expected and can cause accessibility issues for assistive technologies.',
},
schema: [],
messages: {
missingRadioName:
'{{ component }} must have a `name` attribute. The `name` attribute is required for radio inputs to be grouped correctly, ensuring only one option can be selected and improving accessibility for all users.',
},
},
defaultOptions: [],
});