@wordpress/components 39.0.0 → 40.1.0

package/src/validated-form-controls/test/control-with-error.tsx

@@ -1,577 +0,0 @@
-import { render, screen, waitFor, act } from '@testing-library/react';
-import userEvent from '@testing-library/user-event';
-import { useState, useCallback, useId, useRef } from '@wordpress/element';
-import { ValidatedInputControl, ValidatedRangeControl } from '../components';
-
-describe( 'ControlWithError', () => {
-	describe( 'Async Validation', () => {
-		beforeEach( () => {
-			jest.useFakeTimers();
-		} );
-
-		afterEach( () => {
-			jest.useRealTimers();
-		} );
-
-		const AsyncValidatedInputControl = ( {
-			serverDelayMs,
-			...restProps
-		}: {
-			serverDelayMs: number;
-		} & React.ComponentProps< typeof ValidatedInputControl > ) => {
-			const [ text, setText ] = useState( '' );
-			const [ customValidity, setCustomValidity ] =
-				useState<
-					React.ComponentProps<
-						typeof ValidatedInputControl
-					>[ 'customValidity' ]
-				>( undefined );
-
-			const onChange = useCallback(
-				( value?: string ) => {
-					setCustomValidity( {
-						type: 'validating',
-						message: 'Validating...',
-					} );
-
-					// Simulate delayed server response
-					setTimeout( () => {
-						if ( value?.toLowerCase() === 'error' ) {
-							setCustomValidity( {
-								type: 'invalid',
-								message: 'The word "error" is not allowed.',
-							} );
-						} else {
-							setCustomValidity( {
-								type: 'valid',
-								message: 'Validated',
-							} );
-						}
-					}, serverDelayMs );
-
-					setText( value ?? '' );
-				},
-				[ serverDelayMs ]
-			);
-
-			return (
-				<ValidatedInputControl
-					label="Text"
-					value={ text }
-					onChange={ onChange }
-					customValidity={ customValidity }
-					{ ...restProps }
-				/>
-			);
-		};
-
-		it( 'should not show "validating" state if it takes less than 1000ms', async () => {
-			const user = userEvent.setup( {
-				advanceTimers: jest.advanceTimersByTime,
-			} );
-			render( <AsyncValidatedInputControl serverDelayMs={ 500 } /> );
-
-			const input = screen.getByRole( 'textbox' );
-
-			await user.type( input, 'valid text' );
-
-			// Blur to trigger validation
-			await user.tab();
-
-			// Fast-forward to right before the server response
-			act( () => jest.advanceTimersByTime( 499 ) );
-
-			// The validating state should not be shown
-			await waitFor( () => {
-				expect(
-					screen.queryByText( 'Validating...' )
-				).not.toBeInTheDocument();
-			} );
-
-			// Fast-forward past the server delay to show validation result
-			act( () => jest.advanceTimersByTime( 1 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validated' ) ).toBeVisible();
-			} );
-		} );
-
-		it( 'should show "validating" state if it takes more than 1000ms', async () => {
-			const user = userEvent.setup( {
-				advanceTimers: jest.advanceTimersByTime,
-			} );
-			render( <AsyncValidatedInputControl serverDelayMs={ 1200 } /> );
-
-			const input = screen.getByRole( 'textbox' );
-
-			await user.type( input, 'valid text' );
-
-			// Blur to trigger validation
-			await user.tab();
-
-			// Initially, no validating message should be shown (before 1s delay)
-			expect(
-				screen.queryByText( 'Validating...' )
-			).not.toBeInTheDocument();
-
-			// Fast-forward past the 1s delay to show validating state
-			act( () => jest.advanceTimersByTime( 1000 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validating...' ) ).toBeVisible();
-			} );
-
-			// Fast-forward past the server delay to show validation result
-			act( () => jest.advanceTimersByTime( 200 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validated' ) ).toBeVisible();
-			} );
-
-			// Test error case
-			await user.clear( input );
-			await user.type( input, 'error' );
-
-			// Blur to trigger validation
-			await user.tab();
-
-			act( () => jest.advanceTimersByTime( 1000 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validating...' ) ).toBeVisible();
-			} );
-
-			act( () => jest.advanceTimersByTime( 200 ) );
-
-			await waitFor( () => {
-				expect(
-					screen.getByText( 'The word "error" is not allowed.' )
-				).toBeVisible();
-			} );
-
-			// Test editing after error
-			await user.type( input, '{backspace}' );
-
-			act( () => jest.advanceTimersByTime( 1000 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validating...' ) ).toBeVisible();
-			} );
-
-			act( () => jest.advanceTimersByTime( 200 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validated' ) ).toBeVisible();
-			} );
-		} );
-
-		it( 'should not show a "valid" state until the server response is received, even if locally valid', async () => {
-			const user = userEvent.setup( {
-				advanceTimers: jest.advanceTimersByTime,
-			} );
-			render(
-				<AsyncValidatedInputControl serverDelayMs={ 1200 } required />
-			);
-
-			const input = screen.getByRole( 'textbox' );
-
-			await user.type( input, 'valid text' );
-
-			await user.tab();
-			act( () => jest.advanceTimersByTime( 1200 ) );
-
-			await waitFor( () => {
-				expect( screen.getByText( 'Validated' ) ).toBeVisible();
-			} );
-
-			await user.clear( input );
-
-			act( () => jest.advanceTimersByTime( 1000 ) );
-
-			await waitFor( () => {
-				expect(
-					screen.getByText( 'Constraints not satisfied' )
-				).toBeVisible();
-			} );
-
-			await user.type( input, 'error' );
-
-			act( () => jest.advanceTimersByTime( 200 ) );
-
-			expect( screen.queryByText( 'Validated' ) ).not.toBeInTheDocument();
-
-			act( () => jest.advanceTimersByTime( 1000 ) );
-
-			await waitFor( () => {
-				expect(
-					screen.getByText( 'The word "error" is not allowed.' )
-				).toBeVisible();
-			} );
-		} );
-	} );
-
-	describe( 'Form submission', () => {
-		const CustomValidatedInputControl = ( {
-			...restProps
-		}: React.ComponentProps< typeof ValidatedInputControl > ) => {
-			const [ customValidity, setCustomValidity ] =
-				useState<
-					React.ComponentProps<
-						typeof ValidatedInputControl
-					>[ 'customValidity' ]
-				>( undefined );
-			return (
-				<ValidatedInputControl
-					onChange={ ( value ) =>
-						value === 'error'
-							? setCustomValidity( {
-									type: 'invalid',
-									message: 'The word "error" is not allowed.',
-							  } )
-							: setCustomValidity( undefined )
-					}
-					customValidity={ customValidity }
-					{ ...restProps }
-				/>
-			);
-		};
-
-		it( 'should show custom validity messages regardless of "touched" state if parent form is submitted', async () => {
-			const user = userEvent.setup();
-			const onSubmit = jest.fn();
-			render(
-				<form onSubmit={ onSubmit }>
-					<CustomValidatedInputControl label="Text" />
-					<button type="submit">Submit</button>
-				</form>
-			);
-
-			const input = screen.getByRole< HTMLInputElement >( 'textbox', {
-				name: 'Text',
-			} );
-
-			// User has interacted, but not blurred
-			await user.type( input, 'error' );
-			await user.keyboard( '{enter}' );
-
-			// Input is marked as invalid at the HTML level
-			await waitFor( () => {
-				expect( input.checkValidity() ).toBe( false );
-			} );
-			expect( input.validationMessage ).toBe(
-				'The word "error" is not allowed.'
-			);
-
-			// Field is showing the error message
-			expect(
-				screen.getByText( 'The word "error" is not allowed.' )
-			).toBeVisible();
-
-			// Form is not submitted
-			expect( onSubmit ).not.toHaveBeenCalled();
-		} );
-	} );
-
-	describe( 'aria-describedby', () => {
-		it( 'should connect the error message to the input via aria-describedby', async () => {
-			const user = userEvent.setup();
-			render(
-				<form>
-					<ValidatedInputControl label="URL" required />
-					<button type="submit">Submit</button>
-				</form>
-			);
-
-			const input = screen.getByRole( 'textbox', { name: /^URL/ } );
-
-			expect( input ).not.toHaveAttribute( 'aria-describedby' );
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Submit' } )
-			);
-
-			await waitFor( () => {
-				expect( input ).toHaveAccessibleDescription(
-					expect.stringContaining( 'Constraints not satisfied' )
-				);
-			} );
-		} );
-
-		it( 'should preserve existing aria-describedby values', async () => {
-			const user = userEvent.setup();
-
-			function TestComponent() {
-				const hintId = useId();
-				return (
-					<form>
-						<ValidatedInputControl
-							label="URL"
-							required
-							aria-describedby={ hintId }
-						/>
-						<p id={ hintId }>Enter a full URL.</p>
-						<button type="submit">Submit</button>
-					</form>
-				);
-			}
-
-			render( <TestComponent /> );
-
-			const input = screen.getByRole( 'textbox', { name: /^URL/ } );
-
-			expect( input ).toHaveAccessibleDescription( 'Enter a full URL.' );
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Submit' } )
-			);
-
-			await waitFor( () => {
-				expect( input ).toHaveAccessibleDescription(
-					expect.stringContaining( 'Constraints not satisfied' )
-				);
-			} );
-			expect( input ).toHaveAccessibleDescription(
-				expect.stringContaining( 'Enter a full URL.' )
-			);
-		} );
-
-		it( 'should connect a custom validity error to the input via aria-describedby', async () => {
-			const user = userEvent.setup();
-
-			function TestComponent() {
-				const [ customValidity, setCustomValidity ] =
-					useState<
-						React.ComponentProps<
-							typeof ValidatedInputControl
-						>[ 'customValidity' ]
-					>( undefined );
-				const inputRef = useRef< HTMLInputElement >( null );
-
-				return (
-					<>
-						<ValidatedInputControl
-							ref={ inputRef }
-							label="URL"
-							customValidity={ customValidity }
-						/>
-						<button
-							type="button"
-							onClick={ () => {
-								setCustomValidity( {
-									type: 'invalid',
-									message: 'Please enter a valid URL.',
-								} );
-								requestAnimationFrame(
-									() => inputRef.current?.reportValidity()
-								);
-							} }
-						>
-							Validate
-						</button>
-					</>
-				);
-			}
-
-			render( <TestComponent /> );
-
-			const input = screen.getByRole( 'textbox', { name: 'URL' } );
-			expect( input ).not.toHaveAttribute( 'aria-describedby' );
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Validate' } )
-			);
-
-			await waitFor( () => {
-				expect( input ).toHaveAccessibleDescription(
-					expect.stringContaining( 'Please enter a valid URL.' )
-				);
-			} );
-		} );
-
-		it( 'should remove aria-describedby when the error is resolved', async () => {
-			const user = userEvent.setup();
-
-			function TestComponent() {
-				const [ customValidity, setCustomValidity ] =
-					useState<
-						React.ComponentProps<
-							typeof ValidatedInputControl
-						>[ 'customValidity' ]
-					>( undefined );
-				const inputRef = useRef< HTMLInputElement >( null );
-
-				return (
-					<>
-						<ValidatedInputControl
-							ref={ inputRef }
-							label="URL"
-							customValidity={ customValidity }
-						/>
-						<button
-							type="button"
-							onClick={ () => {
-								setCustomValidity( {
-									type: 'invalid',
-									message: 'Please enter a valid URL.',
-								} );
-								requestAnimationFrame(
-									() => inputRef.current?.reportValidity()
-								);
-							} }
-						>
-							Validate
-						</button>
-						<button
-							type="button"
-							onClick={ () => setCustomValidity( undefined ) }
-						>
-							Clear
-						</button>
-					</>
-				);
-			}
-
-			render( <TestComponent /> );
-
-			const input = screen.getByRole( 'textbox', { name: 'URL' } );
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Validate' } )
-			);
-
-			await waitFor( () => {
-				expect( input ).toHaveAccessibleDescription(
-					expect.stringContaining( 'Please enter a valid URL.' )
-				);
-			} );
-
-			await user.click( screen.getByRole( 'button', { name: 'Clear' } ) );
-
-			await waitFor( () => {
-				expect( input ).not.toHaveAttribute( 'aria-describedby' );
-			} );
-		} );
-	} );
-
-	describe( 'ValidatedRangeControl', () => {
-		it( 'should accessibly label the internal slider and spin button', () => {
-			render(
-				<ValidatedRangeControl
-					label="Opacity"
-					required
-					min={ 0 }
-					max={ 100 }
-					onChange={ () => {} }
-				/>
-			);
-
-			// The slider is styled with `opacity: 0`, so it's not "visible"
-			// in the DOM sense, but it's still accessible.
-			expect(
-				screen.getByRole( 'slider', {
-					name: 'Opacity (Required)',
-				} )
-			).toBeInTheDocument();
-			expect(
-				screen.getByRole( 'spinbutton', {
-					name: 'Opacity (Required)',
-				} )
-			).toBeVisible();
-		} );
-	} );
-
-	describe( 'Focus behavior', () => {
-		it( 'should focus the first error in the form', async () => {
-			const user = userEvent.setup();
-			render(
-				<form>
-					<ValidatedInputControl label="Text1" required />
-					<ValidatedInputControl label="Text2" required />
-					<button type="submit">Submit</button>
-				</form>
-			);
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Submit' } )
-			);
-
-			expect(
-				screen.getByRole( 'textbox', { name: /^Text1/ } )
-			).toHaveFocus();
-		} );
-
-		it( 'should focus the field on an `invalid` event, even if there is no enclosing form', async () => {
-			const user = userEvent.setup();
-			function ValidatedInputControlWithRef(
-				props: React.ComponentProps< typeof ValidatedInputControl >
-			) {
-				const ref = useRef< HTMLInputElement >( null );
-				return (
-					<>
-						<ValidatedInputControl ref={ ref } { ...props } />
-						<button
-							type="button"
-							onClick={ () => ref.current?.reportValidity() }
-						>
-							Report Validity
-						</button>
-					</>
-				);
-			}
-
-			render( <ValidatedInputControlWithRef label="Text" required /> );
-
-			await user.click(
-				screen.getByRole( 'button', { name: 'Report Validity' } )
-			);
-
-			await waitFor( () => {
-				expect(
-					screen.getByRole( 'textbox', { name: /^Text/ } )
-				).toHaveFocus();
-			} );
-		} );
-
-		it( 'should show the error message without moving focus on a synthetic `invalid` event', async () => {
-			const user = userEvent.setup();
-			function ValidatedInputControlWithRef(
-				props: React.ComponentProps< typeof ValidatedInputControl >
-			) {
-				const ref = useRef< HTMLInputElement >( null );
-				return (
-					<>
-						<ValidatedInputControl ref={ ref } { ...props } />
-						<button
-							type="button"
-							onClick={ () =>
-								ref.current?.dispatchEvent(
-									new Event( 'invalid', {
-										cancelable: true,
-									} )
-								)
-							}
-						>
-							Show errors
-						</button>
-					</>
-				);
-			}
-
-			render( <ValidatedInputControlWithRef label="Text" required /> );
-
-			const button = screen.getByRole( 'button', {
-				name: 'Show errors',
-			} );
-			await user.click( button );
-
-			// The error message is revealed...
-			await waitFor( () => {
-				expect(
-					screen.getByText( 'Constraints not satisfied' )
-				).toBeVisible();
-			} );
-			// ...but focus is not moved to the invalid field.
-			expect( button ).toHaveFocus();
-		} );
-	} );
-} );

package/src/validated-form-controls/test/form-token-field.tsx

@@ -1,52 +0,0 @@
-import { render, screen, waitFor } from '@testing-library/react';
-import userEvent from '@testing-library/user-event';
-import { ValidatedFormTokenField } from '../components';
-
-describe( 'ValidatedFormTokenField', () => {
-	it( 'should preserve the built-in howto description', () => {
-		render(
-			<ValidatedFormTokenField
-				label="Tags"
-				value={ [] }
-				onChange={ () => {} }
-			/>
-		);
-
-		expect(
-			screen.getByRole( 'combobox', { name: 'Tags' } )
-		).toHaveAccessibleDescription(
-			expect.stringContaining( 'Separate with commas or the Enter key.' )
-		);
-	} );
-
-	it( 'should preserve the built-in howto description when validation is active', async () => {
-		const user = userEvent.setup();
-		render(
-			<form>
-				<ValidatedFormTokenField
-					label="Tags"
-					value={ [] }
-					onChange={ () => {} }
-					required
-				/>
-				<button type="submit">Submit</button>
-			</form>
-		);
-
-		const input = screen.getByRole( 'combobox', { name: /^Tags/ } );
-
-		await user.click( screen.getByRole( 'button', { name: 'Submit' } ) );
-
-		// The validation error targets the hidden delegate input, not the
-		// interactive combobox. The combobox's built-in description should
-		// be unaffected.
-		await waitFor( () => {
-			expect(
-				screen.getByText( 'Constraints not satisfied' )
-			).toBeVisible();
-		} );
-		expect( input ).toHaveAccessibleDescription(
-			expect.stringContaining( 'Separate with commas or the Enter key.' )
-		);
-	} );
-} );

package/src/validated-form-controls/test/toggle-control.tsx

@@ -1,49 +0,0 @@
-import { render, screen, waitFor } from '@testing-library/react';
-import userEvent from '@testing-library/user-event';
-import { ValidatedToggleControl } from '../components';
-
-describe( 'ValidatedToggleControl', () => {
-	it( 'should preserve the help description', () => {
-		render(
-			<ValidatedToggleControl
-				label="Dark mode"
-				help="Enable dark mode."
-				onChange={ () => {} }
-			/>
-		);
-
-		expect(
-			screen.getByRole( 'checkbox', { name: 'Dark mode' } )
-		).toHaveAccessibleDescription( 'Enable dark mode.' );
-	} );
-
-	it( 'should append the validation error alongside the help description', async () => {
-		const user = userEvent.setup();
-		render(
-			<form>
-				<ValidatedToggleControl
-					label="Dark mode"
-					help="Enable dark mode."
-					onChange={ () => {} }
-					required
-				/>
-				<button type="submit">Submit</button>
-			</form>
-		);
-
-		const toggle = screen.getByRole( 'checkbox', {
-			name: /^Dark mode/,
-		} );
-
-		await user.click( screen.getByRole( 'button', { name: 'Submit' } ) );
-
-		await waitFor( () => {
-			expect( toggle ).toHaveAccessibleDescription(
-				expect.stringContaining( 'Constraints not satisfied' )
-			);
-		} );
-		expect( toggle ).toHaveAccessibleDescription(
-			expect.stringContaining( 'Enable dark mode.' )
-		);
-	} );
-} );

package/src/validated-form-controls/test/toggle-group-control.tsx

@@ -1,28 +0,0 @@
-import { render, screen } from '@testing-library/react';
-import { ValidatedToggleGroupControl } from '../components';
-import { ToggleGroupControlOption } from '../../toggle-group-control';
-
-// The `help` prop is rendered visually by BaseControl but is not
-// programmatically associated with the toggle group via aria-describedby.
-// Additionally, the validity target is a hidden delegate radio input, not the
-// toggle group itself. These are pre-existing bugs, not caused by ControlWithError.
-describe( 'ValidatedToggleGroupControl', () => {
-	// eslint-disable-next-line jest/no-disabled-tests
-	it.skip( 'should preserve the help description', () => {
-		render(
-			<ValidatedToggleGroupControl
-				label="Alignment"
-				help="Choose text alignment."
-				value="left"
-				onChange={ () => {} }
-			>
-				<ToggleGroupControlOption label="Left" value="left" />
-				<ToggleGroupControlOption label="Center" value="center" />
-			</ValidatedToggleGroupControl>
-		);
-
-		expect(
-			screen.getByRole( 'radiogroup', { name: 'Alignment' } )
-		).toHaveAccessibleDescription( 'Choose text alignment.' );
-	} );
-} );