5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
5 changes: 5 additions & 0 deletions .changeset/empty-laws-boil.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Ensure inputs are properly connected to feedback messages via `aria-describedby` usage.
3 changes: 1 addition & 2 deletions packages/clerk-js/src/ui/elements/FieldControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,12 +154,11 @@ const FieldLabelRow = (props: PropsWithChildren) => {
};

const FieldFeedback = (props: Pick<FormFeedbackProps, 'elementDescriptors' | 'center'>) => {
const { fieldId, debouncedFeedback, errorMessageId } = useFormField();
const { fieldId, debouncedFeedback } = useFormField();

return (
<FormFeedback
center={props.center}
errorMessageId={errorMessageId}
{...{
...debouncedFeedback,
elementDescriptors: props.elementDescriptors,
Expand Down
13 changes: 6 additions & 7 deletions packages/clerk-js/src/ui/elements/FormControl.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ function useFormTextAnimation() {
transitionTimingFunction: t.transitionTiming.$common,
});
},
[prefersReducedMotion],
[prefersReducedMotion, appearanceAnimations],
);

return {
Expand DownExpand Up@@ -71,14 +71,13 @@ export type FormFeedbackDescriptorsKeys = 'error' | 'warning' | 'info' | 'succes
type Feedback = { feedback?: string; feedbackType?: FeedbackType; shouldEnter: boolean };

export type FormFeedbackProps = Partial<ReturnType<typeof useFormControlFeedback>['debounced'] & { id: FieldId }> & {
errorMessageId?: string;
elementDescriptors?: Partial<Record<FormFeedbackDescriptorsKeys, ElementDescriptor>>;
center?: boolean;
sx?: ThemableCssProp;
};

export const FormFeedback = (props: FormFeedbackProps) => {
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false, errorMessageId } = props;
const { id, elementDescriptors, sx, feedback, feedbackType = 'info', center = false } = props;
const feedbacksRef = useRef<{
a?: Feedback;
b?: Feedback;
Expand DownExpand Up@@ -143,10 +142,8 @@ export const FormFeedback = (props: FormFeedbackProps) => {
return {
elementDescriptor: descriptor,
elementId: id ? descriptor?.setId?.(id) : undefined,
// We only want the id applied when the feedback type is an error
// to avoid having multiple elements in the dom with the same id attribute.
// We also only have aria-describedby applied to the input when it is an error.
id: type === 'error' ? errorMessageId : undefined,
// Use legacy pattern for errors (backwards compatible), new pattern for other types
id: type === 'error' ? `error-${id}` : `${id}-${type}-feedback`,
};
};

Expand DownExpand Up@@ -182,6 +179,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.a?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.a?.feedback)}
aria-live={feedbacks.a?.shouldEnter ? 'polite' : 'off'}
/>
<InfoComponentB
{...getElementProps(feedbacks.b?.feedbackType)}
Expand All@@ -193,6 +191,7 @@ export const FormFeedback = (props: FormFeedbackProps) => {
getFormTextAnimation(!!feedbacks.b?.shouldEnter, { inDelay: true }),
]}
localizationKey={titleize(feedbacks.b?.feedback)}
aria-live={feedbacks.b?.shouldEnter ? 'polite' : 'off'}
/>
</Flex>
);
Expand Down
104 changes: 100 additions & 4 deletions packages/clerk-js/src/ui/elements/__tests__/PlainInput.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,9 @@ const createField = (...params: Parameters<typeof useFormControl>) => {
{...props}
/>
<button onClick={() => field.setError('some error')}>set error</button>
<button onClick={() => field.setSuccess('some success')}>set success</button>
<button onClick={() => field.setWarning('some warning')}>set warning</button>
<button onClick={() => field.setInfo('some info')}>set info</button>
</>
);
});
Expand DownExpand Up@@ -132,15 +135,20 @@ describe('PlainInput', () => {
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText } = render(<Field />, { wrapper });
const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set error/i }));

expect(await findByText(/Some Error/i)).toBeInTheDocument();

const label = getByLabelText(/some label/i);
expect(label).toHaveAttribute('aria-invalid', 'true');
expect(label).toHaveAttribute('aria-describedby', 'error-firstname');
const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Verify the error message element has the correct ID
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toBeInTheDocument();
expect(errorElement).toHaveTextContent(/Some Error/i);
});

it('with info', async () => {
Expand All@@ -157,4 +165,92 @@ describe('PlainInput', () => {
fireEvent.focus(await findByLabelText(/some label/i));
expect(await findByText(/some info/i)).toBeInTheDocument();
});

it('with success feedback and aria-describedby', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

await userEvent.click(getByRole('button', { name: /set success/i }));

expect(await findByText(/Some Success/i)).toBeInTheDocument();

const input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify the success message element has the correct ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('transitions between error and success feedback types', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, getByLabelText, findByText, container } = render(<Field />, { wrapper });

// Start with error
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

let input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'true');
expect(input).toHaveAttribute('aria-describedby', 'error-firstname');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

input = getByLabelText(/some label/i);
expect(input).toHaveAttribute('aria-invalid', 'false');
expect(input).toHaveAttribute('aria-describedby', 'firstname-success-feedback');

// Verify success element exists with proper ID
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toBeInTheDocument();
expect(successElement).toHaveTextContent(/Some Success/i);
});

it('aria-live attribute is correctly applied', async () => {
const { wrapper } = await createFixtures();
const { Field } = createField('firstname', 'init value', {
type: 'text',
label: 'some label',
placeholder: 'some placeholder',
});

const { getByRole, findByText, container } = render(<Field />, { wrapper });

// Set error feedback
await userEvent.click(getByRole('button', { name: /set error/i }));
expect(await findByText(/Some Error/i)).toBeInTheDocument();

// Verify the visible error message has aria-live="polite"
const errorElement = container.querySelector('#error-firstname');
expect(errorElement).toHaveAttribute('aria-live', 'polite');

// Transition to success
await userEvent.click(getByRole('button', { name: /set success/i }));
expect(await findByText(/Some Success/i)).toBeInTheDocument();

// Verify the visible success message has aria-live="polite"
const successElement = container.querySelector('#firstname-success-feedback');
expect(successElement).toHaveAttribute('aria-live', 'polite');

// The previous error message should now have aria-live="off" (though it might still exist in DOM but hidden)
// Verify exactly one element has aria-live="polite" at a time
const allAriaLivePolite = container.querySelectorAll('[aria-live="polite"]');
expect(allAriaLivePolite.length).toBe(1);
});
});
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormErrorText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ const { applyVariants } = createVariants(theme => ({
type FormErrorTextProps = React.PropsWithChildren<StyleVariants<typeof applyVariants>>;

export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -35,8 +35,6 @@ export const FormErrorText = forwardRef<HTMLElement, FormErrorTextProps>((props,
<Text
ref={ref}
colorScheme='danger'
aria-live='polite'
id={errorMessageId}
{...rest}
css={applyVariants(props)}
>
Expand Down
4 changes: 1 addition & 3 deletions packages/clerk-js/src/ui/primitives/FormInfoText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import { useFormField } from './hooks/useFormField';
import { Text } from './Text';

export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref) => {
const { hasError, errorMessageId } = useFormField() || {};
const { hasError } = useFormField() || {};

if (!hasError && !props.children) {
return null;
Expand All@@ -16,8 +16,6 @@ export const FormInfoText = forwardRef<HTMLElement, FormTextProps>((props, ref)
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
id={errorMessageId}
{...props}
css={applyVariants(props)}
/>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormSuccessText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,6 @@ export const FormSuccessText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/primitives/FormWarningText.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,6 @@ export const FormWarningText = forwardRef<HTMLElement, FormTextProps>((props, re
<Text
ref={ref}
colorScheme='secondary'
aria-live='polite'
{...rest}
css={applyVariants(props) as any}
>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/primitives/Input.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,10 +63,10 @@ export type InputProps = PrimitiveProps<'input'> & StyleVariants<typeof applyVar

export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref) => {
const fieldControl = useFormField() || {};
// @ts-expect-error Typescript is complaining that `errorMessageId` does not exist. We are clearly passing them from above.
const { errorMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
// @ts-expect-error Typescript is complaining that `feedbackMessageId` does not exist. We are clearly passing them from above.
const { feedbackMessageId, ignorePasswordManager, feedbackType, ...fieldControlProps } = sanitizeInputProps(
fieldControl,
['errorMessageId', 'ignorePasswordManager', 'feedbackType'],
['feedbackMessageId', 'ignorePasswordManager', 'feedbackType'],
);

const propsWithoutVariants = filterProps({
Expand DownExpand Up@@ -106,7 +106,7 @@ export const Input = React.forwardRef<HTMLInputElement, InputProps>((props, ref)
required={_required}
id={props.id || fieldControlProps.id}
aria-invalid={_hasError}
aria-describedby={errorMessageId ? errorMessageId : undefined}
aria-describedby={feedbackMessageId || undefined}
aria-required={_required}
aria-disabled={_disabled}
data-feedback={feedbackType}
Expand Down
19 changes: 12 additions & 7 deletions packages/clerk-js/src/ui/primitives/hooks/useFormField.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ type FormFieldProviderProps = ReturnType<typeof useFormControlUtil<FieldId>>['pr
};

type FormFieldContextValue = Omit<FormFieldProviderProps, 'id'> & {
errorMessageId?: string;
feedbackMessageId?: string;
id?: string;
fieldId?: FieldId;
hasError: boolean;
Expand DownExpand Up@@ -49,17 +49,22 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
// Both html attributes (e.g. data-invalid) and css styles depend on hasError being debounced
const hasError = debounced.feedbackType === 'error';

// Track whether the `FormErrorText` has been rendered.
// Track whether any feedback message has been rendered.
// We use this to append its id the `aria-describedby` of the `input`.
const errorMessageId = hasError ? `error-${propsId}` : '';
// Use legacy pattern for errors (backwards compatible), new pattern for other types
const feedbackMessageId = debounced.feedback
? debounced.feedbackType === 'error'
? `error-${propsId}`
: `${propsId}-${debounced.feedbackType}-feedback`
: '';
const value = React.useMemo(
() => ({
isRequired,
isDisabled,
hasError,
id,
fieldId: propsId,
errorMessageId,
feedbackMessageId,
setError,
setSuccess,
setWarning,
Expand All@@ -75,7 +80,7 @@ export const FormFieldContextProvider = (props: React.PropsWithChildren<FormFiel
hasError,
id,
propsId,
errorMessageId,
feedbackMessageId,
isDisabled,
setError,
setSuccess,
Expand DownExpand Up@@ -128,7 +133,7 @@ export const sanitizeInputProps = (
setSuccess,
setError,
setInfo,
errorMessageId,
feedbackMessageId,
fieldId,
label,
clearFeedback,
Expand All@@ -143,7 +148,7 @@ export const sanitizeInputProps = (
/**
* Ignore error for the index type as we have defined it explicitly above
*/
// @ts-ignore
// @ts-ignore - Dynamic property access for form field props
inputProps[key] = obj[key];
});

Expand Down
Loading