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

fix(radiobuttongroup): accessibility #17885

Closed
wants to merge 3 commits into from
Closed

fix(radiobuttongroup): accessibility #17885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2325787
feat: added new prop to control the visibility of legendText
guidari Oct 25, 2024
c5289b2
feat: added new style to hide
guidari Oct 25, 2024
88b8a50
test: updated snapshots
guidari Oct 25, 2024
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
3 changes: 3 additions & 0 deletions packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6591,6 +6591,9 @@ Map {
"helperText": Object {
"type": "node",
},
"hideLegendText": Object {
"type": "bool",
},
"invalid": Object {
"type": "bool",
},
Expand Down
8 changes: 8 additions & 0 deletions packages/react/src/components/RadioButton/RadioButton.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ Playground.args = {
invalidText: 'Invalid selection',
warn: false,
warnText: 'Please notice the warning',
hideLegendText: false,
};

Playground.argTypes = {
Expand Down Expand Up @@ -272,6 +273,13 @@ Playground.argTypes = {
type: 'text',
},
},
hideLegendText: {
description:
'Specify whether the `legendText` should be hidden, or not. Provide a `legendText` to meet accessibility standards if `hideLegendText` is true',
control: {
type: 'boolean',
},
},
orientation: {
description: 'Provide how radio buttons should be displayed',
control: 'select',
Expand Down
17 changes: 16 additions & 1 deletion packages/react/src/components/RadioButtonGroup/RadioButtonGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ export interface RadioButtonGroupProps
*/
helperText?: ReactNode;

/**
* Specify whether the `legendText` should be hidden, or not. Provide a `legendText` to meet accessibility standards if `hideLegendText` is true
*/
hideLegendText?: boolean;

/**
* Specify whether the control is currently invalid
*/
Expand Down Expand Up @@ -135,6 +140,7 @@ const RadioButtonGroup = React.forwardRef(
defaultSelected,
disabled,
helperText,
hideLegendText = false,
invalid = false,
invalidText,
labelPosition = 'right',
Expand Down Expand Up @@ -247,6 +253,10 @@ const RadioButtonGroup = React.forwardRef(
});
}

const legendTextClasses = classNames(`${prefix}--label`, {
[`${prefix}--visually-hidden`]: hideLegendText,
});

return (
<div className={wrapperClasses} ref={mergeRefs(divRef, ref)}>
<fieldset
Expand All @@ -256,7 +266,7 @@ const RadioButtonGroup = React.forwardRef(
aria-describedby={showHelper && helperText ? helperId : undefined}
{...rest}>
{legendText && (
<Legend className={`${prefix}--label`}>
<Legend className={legendTextClasses}>
{legendText}
{normalizedSlug}
</Legend>
Expand Down Expand Up @@ -313,6 +323,11 @@ RadioButtonGroup.propTypes = {
*/
helperText: PropTypes.node,

/**
* Specify whether the `legendText` should be hidden, or not. Provide a `legendText` to meet accessibility standards if `hideLegendText` is true
*/
hideLegendText: PropTypes.bool,

/**
* Specify whether the control is currently invalid
*/
Expand Down
Loading