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(TextField): adjust position of maxLength's screen reader label #1283

Merged
merged 4 commits into from
Oct 30, 2024
Merged

fix(TextField): adjust position of maxLength's screen reader label #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bea681c
fix screen reader text position
marcoskolodny Oct 30, 2024
f77637d
added right helper text describedby aria attr
marcoskolodny Oct 30, 2024
09de145
fix typo
marcoskolodny Oct 30, 2024
c3bab03
fix
marcoskolodny Oct 30, 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
10 changes: 7 additions & 3 deletions src/text-field-base.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,8 @@ export const TextFieldBase = React.forwardRef<any, TextFieldBaseProps>(
preventCopy = preventCopy ?? preventCopyInFormFields;
const reactId = React.useId();
const id = idProp || reactId;
const helperTextid = React.useId();
const leftHelperTextid = React.useId();
const rightHelperTextid = React.useId();

const [inputState, setInputState] = React.useState<InputState>(
defaultValue?.length || value?.length ? 'filled' : 'default'
Expand Down Expand Up @@ -317,7 +318,8 @@ export const TextFieldBase = React.forwardRef<any, TextFieldBaseProps>(
<HelperText
error={error}
leftText={helperText}
id={helperTextid}
leftTextId={leftHelperTextid}
rightTextId={rightHelperTextid}
rightText={multiline && maxLength ? `${characterCount}/${maxLength}` : undefined}
rightTextLabel={
multiline && maxLength
Expand Down Expand Up @@ -439,7 +441,9 @@ export const TextFieldBase = React.forwardRef<any, TextFieldBaseProps>(
defaultValue,
value,
...(error && {'aria-invalid': true}),
...(helperText && {'aria-describedby': helperTextid}),
...((helperText || (multiline && maxLength)) && {
'aria-describedby': `${leftHelperTextid} ${rightHelperTextid}`,
}),
...(preventCopy && {
onCopy: preventCopyHandler,
onCut: preventCopyHandler,
Expand Down
22 changes: 12 additions & 10 deletions src/text-field-components.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,16 +81,18 @@ type HelperTextProps = {
rightText?: string;
rightTextLabel?: string;
error?: boolean;
id?: string;
leftTextId?: string;
rightTextId?: string;
children?: void;
};

export const HelperText = ({
leftText,
leftTextId,
rightText,
rightTextId,
rightTextLabel,
error,
id,
}: HelperTextProps): JSX.Element => {
const isInverse = useIsInverseOrMediaVariant();
const leftColor = isInverse
Expand All @@ -112,7 +114,7 @@ export const HelperText = ({
<IconWarningRegular color={leftColor} className={styles.warnIcon} />
</Text1>
)}
<Text1 color={leftColor} regular id={id}>
<Text1 color={leftColor} regular id={leftTextId}>
{leftText}
</Text1>
</p>
Expand All @@ -122,20 +124,20 @@ export const HelperText = ({
className={classnames(styles.helperText, {[styles.rightHelperText]: !!leftText})}
data-testid="endHelperText"
>
{rightTextLabel && (
<ScreenReaderOnly>
<span>{rightTextLabel}</span>
</ScreenReaderOnly>
)}
<Text1
color={rightColor}
regular
as="p"
textAlign="right"
wordBreak={false}
aria-hidden={rightTextLabel !== undefined}
id={rightTextId}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Associate this text with the corresponding input field

>
{rightText}
{rightTextLabel && (
<ScreenReaderOnly>
<span>{rightTextLabel}</span>
</ScreenReaderOnly>
)}
<span aria-hidden={rightTextLabel !== undefined}>{rightText}</span>
</Text1>
</div>
)}
Expand Down
Loading