Skip to content

ComboboxControl: Display reset button only if there's a value #72595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 27, 2025
Merged

ComboboxControl: Display reset button only if there's a value #72595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3517b34
ComboboxControl: Show reset button only when there is a value
juanfra Oct 22, 2025
5fd3181
Fix reset button tests.
juanfra Oct 22, 2025
e7e201d
Add tests for the reset button when value is not set and when allowRe…
juanfra Oct 22, 2025
fb3ef66
Update changelog link with PR reference.
juanfra Oct 22, 2025
5bf1332
Merge branch 'trunk' into fix/72522-combobox-reset-when-value
juanfra Oct 25, 2025
9f85e15
Hide reset where there is technically a value set but it isn't visibl…
juanfra Oct 25, 2025
9055397
Remove `allowReset: false` from ComboboxControl story default args.
juanfra Oct 25, 2025
f1dcc83
Remove outdated test.
juanfra Oct 25, 2025
635ff1c
Remove value set via props as we're simulating the value picking.
juanfra Oct 25, 2025
5b75f8a
Add test to confirm that resetButton is not in document.
juanfra Oct 25, 2025
1657aa3
Update tests.
juanfra Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- `Button`: Update font weight to `500` ([#70787](https://github.com/WordPress/gutenberg/pull/70787)).
- `TabPanel`: Update tab font weight ([#72455](https://github.com/WordPress/gutenberg/pull/72455)).
- Consistently use font-weight 499 instead of 500 ([#72473](https://github.com/WordPress/gutenberg/pull/72473)).
- `ComboboxControl`: Show reset button only when there is a value ([#72595](https://github.com/WordPress/gutenberg/pull/72595)).

### Bug Fixes

Expand Down
5 changes: 1 addition & 4 deletions packages/components/src/combobox-control/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,13 +365,10 @@ function ComboboxControl( props: ComboboxControlProps ) {
/>
</FlexBlock>
{ isLoading && <Spinner /> }
{ allowReset && (
{ allowReset && Boolean( value ) && ! isExpanded && (
<Button
size="small"
icon={ closeSmall }
// Disable reason: Focus returns to input field when reset is clicked.
// eslint-disable-next-line no-restricted-syntax
disabled={ ! value }
onClick={ handleOnReset }
onKeyDown={ handleResetStopPropagation }
label={ __( 'Reset' ) }
Expand Down
1 change: 0 additions & 1 deletion packages/components/src/combobox-control/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ export const Default = Template.bind( {} );
Default.args = {
__next40pxDefaultSize: true,
__nextHasNoMarginBottom: true,
allowReset: false,
label: 'Select a country',
options: countryOptions,
};
Expand Down
27 changes: 20 additions & 7 deletions packages/components/src/combobox-control/test/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ describe.each( [
expect( input ).toHaveValue( targetOption.label );
} );

it( 'should render with Reset button disabled', () => {
it( 'should not render Reset button when no value is set', () => {
render(
<Component
options={ timezones }
Expand All @@ -365,10 +365,23 @@ describe.each( [
/>
);

const resetButton = screen.getByRole( 'button', { name: 'Reset' } );
const resetButton = screen.queryByRole( 'button', { name: 'Reset' } );

expect( resetButton ).not.toBeInTheDocument();
} );

it( 'should not render Reset button when allowReset is false', () => {
render(
<Component
options={ timezones }
label={ defaultLabelText }
allowReset={ false }
/>
);

const resetButton = screen.queryByRole( 'button', { name: 'Reset' } );

expect( resetButton ).toBeVisible();
expect( resetButton ).toBeDisabled();
expect( resetButton ).not.toBeInTheDocument();
} );

it( 'should reset input when clicking the Reset button', async () => {
Expand Down Expand Up @@ -400,8 +413,8 @@ describe.each( [

await user.click( resetButton );

expect( resetButton ).not.toBeInTheDocument();
expect( input ).toHaveValue( '' );
expect( resetButton ).toBeDisabled();
Copy link
Member

@mirka mirka Oct 24, 2025

Choose a reason for hiding this comment

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

Can we still test for not.toBeInTheDocument?

Copy link
Member Author

@juanfra juanfra Oct 25, 2025

Choose a reason for hiding this comment

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

Sure 🫡

expect( input ).toHaveFocus();
} );

Expand Down Expand Up @@ -439,8 +452,8 @@ describe.each( [
// Pressing Enter/Return resets the input.
await user.keyboard( '{Enter}' );

expect( resetButton ).not.toBeInTheDocument();
expect( input ).toHaveValue( '' );
expect( resetButton ).toBeDisabled();
expect( input ).toHaveFocus();
} );

Expand Down Expand Up @@ -478,8 +491,8 @@ describe.each( [
// Pressing Spacebar resets the input.
await user.keyboard( '[Space]' );

expect( resetButton ).not.toBeInTheDocument();
expect( input ).toHaveValue( '' );
expect( resetButton ).toBeDisabled();
expect( input ).toHaveFocus();
} );
} );
Loading