SearchControl: refactor to use InputControl internally #56524
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,100 +9,117 @@ import classnames from 'classnames'; | |
| import { useInstanceId, useMergeRefs } from '@wordpress/compose'; | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { Icon, search, closeSmall } from '@wordpress/icons'; | ||
| import { forwardRef, useMemo, useRef } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import Button from '../button'; | ||
| import type { WordPressComponentProps } from '../context/wordpress-component'; | ||
| import type { SearchControlProps, SuffixItemProps } from './types'; | ||
| import type { ForwardedRef } from 'react'; | ||
| import { ContextSystemProvider } from '../context'; | ||
| import { StyledInputControl, SuffixItemWrapper } from './styles'; | ||
|
|
||
| function SuffixItem( { | ||
| searchRef, | ||
| value, | ||
| onChange, | ||
| onClose, | ||
| }: SuffixItemProps ) { | ||
| if ( ! onClose && ! value ) { | ||
| return <Icon icon={ search } />; | ||
| } | ||
|
|
||
| const onReset = () => { | ||
| onChange( '' ); | ||
| searchRef.current?.focus(); | ||
| }; | ||
|
|
||
| return ( | ||
| <Button | ||
| size="small" | ||
| icon={ closeSmall } | ||
| label={ onClose ? __( 'Close search' ) : __( 'Reset search' ) } | ||
| onClick={ onClose ?? onReset } | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| function UnforwardedSearchControl( | ||
| { | ||
| __nextHasNoMarginBottom = false, | ||
| className, | ||
| onChange, | ||
| value, | ||
| label = __( 'Search' ), | ||
| placeholder = __( 'Search' ), | ||
| hideLabelFromVision = true, | ||
| onClose, | ||
| size = 'default', | ||
| ...restProps | ||
| }: Omit< | ||
| WordPressComponentProps< SearchControlProps, 'input', false >, | ||
| // TODO: Background styling currently doesn't support a disabled state. Needs design work. | ||
| 'disabled' | ||
| >, | ||
| forwardedRef: ForwardedRef< HTMLInputElement > | ||
| ) { | ||
| // @ts-expect-error The `disabled` prop is not yet supported in the SearchControl component. | ||
| // Work with the design team if you need this feature. | ||
|
There was a problem hiding this comment. Maybe we should mention the team handle? |
||
| delete restProps.disabled; | ||
|
There was a problem hiding this comment. I added this little safe guard so consumers don't improvise a |
||
|
|
||
| const searchRef = useRef< HTMLInputElement >( null ); | ||
| const instanceId = useInstanceId( | ||
| SearchControl, | ||
| 'components-search-control' | ||
| ); | ||
|
|
||
| const contextValue = useMemo( | ||
| () => ( { | ||
| // Overrides the underlying BaseControl `__nextHasNoMarginBottom` via the context system | ||
| // to provide backwards compatibile margin for SearchControl. | ||
| // (In a standard InputControl, the BaseControl `__nextHasNoMarginBottom` is always set to true.) | ||
| BaseControl: { _overrides: { __nextHasNoMarginBottom } }, | ||
| // `isBorderless` is still experimental and not a public prop for InputControl yet. | ||
| InputBase: { isBorderless: true }, | ||
| } ), | ||
| [ __nextHasNoMarginBottom ] | ||
| ); | ||
|
|
||
| return ( | ||
| <ContextSystemProvider value={ contextValue }> | ||
| <StyledInputControl | ||
| __next40pxDefaultSize | ||
| id={ instanceId } | ||
| hideLabelFromVision={ hideLabelFromVision } | ||
| label={ label } | ||
| ref={ useMergeRefs( [ searchRef, forwardedRef ] ) } | ||
| type="search" | ||
| size={ size } | ||
| className={ classnames( | ||
| 'components-search-control', | ||
| className | ||
| ) } | ||
| onChange={ ( nextValue?: string ) => | ||
| onChange( nextValue ?? '' ) | ||
|
There was a problem hiding this comment. Nit: sometimes we can see There was a problem hiding this comment. Good idea, I'll unify to |
||
| } | ||
| autoComplete="off" | ||
| placeholder={ placeholder } | ||
| value={ value || '' } | ||
| suffix={ | ||
| <SuffixItemWrapper size={ size }> | ||
| <SuffixItem | ||
| searchRef={ searchRef } | ||
| value={ value } | ||
| onChange={ onChange } | ||
| onClose={ onClose } | ||
| /> | ||
| </SuffixItemWrapper> | ||
| } | ||
| { ...restProps } | ||
| /> | ||
| </ContextSystemProvider> | ||
| ); | ||
| } | ||
|
|
||
|
|
@@ -118,6 +135,7 @@ function UnforwardedSearchControl( | |
| * | ||
| * return ( | ||
| * <SearchControl | ||
| * __nextHasNoMarginBottom | ||
| * value={ searchInput } | ||
| * onChange={ setSearchInput } | ||
| * /> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import styled from '@emotion/styled'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { space } from '../utils/space'; | ||
| import InputControl from '../input-control'; | ||
| import { COLORS } from '../utils'; | ||
| import type { SearchControlProps } from './types'; | ||
|
|
||
| const inlinePadding = ( { | ||
| size, | ||
| }: Required< Pick< SearchControlProps, 'size' > > ) => { | ||
| return space( size === 'compact' ? 1 : 2 ); | ||
| }; | ||
|
|
||
| export const SuffixItemWrapper = styled.div` | ||
| display: flex; | ||
| padding-inline-end: ${ inlinePadding }; | ||
|
|
||
| svg { | ||
| fill: currentColor; | ||
| } | ||
| `; | ||
|
|
||
| export const StyledInputControl = styled( InputControl )` | ||
| input[type='search'] { | ||
| &::-webkit-search-decoration, | ||
| &::-webkit-search-cancel-button, | ||
| &::-webkit-search-results-button, | ||
| &::-webkit-search-results-decoration { | ||
| -webkit-appearance: none; | ||
| } | ||
| } | ||
|
|
||
| &:not( :focus-within ) { | ||
| --wp-components-color-background: ${ COLORS.theme.gray[ 100 ] }; | ||
| } | ||
| `; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that this component didn't have a default label, and since it was not marked as required in TS and visually hidden by default, there were likely a lot of unlabeled usages 😔 I gave it a default and updated the docs.