Skip to content

feat: add hideClearButton Prop to SearchInput Component #2433

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

Closed
yadavshubham01 wants to merge 11 commits into from
Closed

feat: add hideClearButton Prop to SearchInput Component #2433

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
06de7a9
Update SearchInput.tsx
yadavshubham01 Nov 30, 2024
c313716
Update SearchInput.stories.tsx
yadavshubham01 Nov 30, 2024
93410a5
Merge branch 'master' into master
yadavshubham01 Dec 7, 2024
16f290f
Update SearchInput.tsx
yadavshubham01 Dec 7, 2024
a7d56cd
Update SearchInput.stories.tsx
yadavshubham01 Dec 8, 2024
91b7617
Update SearchInput.tsx
yadavshubham01 Dec 8, 2024
d0cb88a
Update SearchInput.stories.tsx
yadavshubham01 Dec 19, 2024
d29b0d6
Update SearchInput.tsx
yadavshubham01 Dec 19, 2024
3cf5439
fix linting
yadavshubham01 Dec 22, 2024
d7c69ff
chore: add change set
Jan 2, 2025
156fdf7
Merge branch 'master' into master
yadavshubham01 Jul 3, 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
5 changes: 5 additions & 0 deletions .changeset/witty-cheetahs-battle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@razorpay/blade': patch
---

feat: add hideClearButton Prop to SearchInput Component
14 changes: 14 additions & 0 deletions packages/blade/src/components/Input/SearchInput/SearchInput.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export default {
labelPosition: 'top',
helpText: undefined,
autoCapitalize: undefined,
hideClearButton: false,
},
tags: ['autodocs'],
argTypes: {
Expand Down Expand Up @@ -198,6 +199,14 @@ export default {
category: propsCategory.KEYBOARD_PROPS,
},
},
hideClearButton: {
control: {
type: 'boolean',
},
table: {
category: propsCategory.TRAILING_VISUAL_PROPS,
},
},
...getStyledPropsArgTypes(),
},
parameters: {
Expand Down Expand Up @@ -269,6 +278,11 @@ const SearchInputTemplate: StoryFn<typeof SearchInputComponent> = (args) => {
export const Default = SearchInputTemplate.bind({});
Default.storyName = 'Default';

export const SearchInputWithClearButtonHidden = SearchInputTemplate.bind({});
SearchInputWithClearButtonHidden.storyName = 'SearchInput with Clear Button Hidden';
SearchInputWithClearButtonHidden.args = {
hideClearButton: true,
};
export const SearchInputHelpText = SearchInputTemplate.bind({});
SearchInputHelpText.storyName = 'SearchInput with Help Text';
SearchInputHelpText.args = {
Expand Down
13 changes: 11 additions & 2 deletions packages/blade/src/components/Input/SearchInput/SearchInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ type SearchInputCommonProps = Pick<
* @default true
*/
showSearchIcon?: boolean;
/**
* Toggle the visibility of the clear button.
*
* @default false
*/
hideClearButton?: boolean;
/**
* Optional trailing to be shown at the end of the input.
*/
Expand Down Expand Up @@ -99,7 +105,9 @@ type SearchInputPropsWithLabel = {
};

type SearchInputProps = (SearchInputPropsWithA11yLabel | SearchInputPropsWithLabel) &
SearchInputCommonProps;
SearchInputCommonProps & {
hideClearButton?: boolean;
};

// need to do this to tell TS to infer type as SearchInput of React Native and make it believe that `ref.current.clear()` exists
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down Expand Up @@ -132,6 +140,7 @@ const _SearchInput: React.ForwardRefRenderFunction<BladeElementRef, SearchInputP
testID,
size = 'medium',
showSearchIcon = true,
hideClearButton = false,
trailing,
...rest
},
Expand Down Expand Up @@ -236,7 +245,7 @@ const _SearchInput: React.ForwardRefRenderFunction<BladeElementRef, SearchInputP
return <Spinner accessibilityLabel="Loading Content" color="primary" />;
}

if (shouldShowClearButton && trailingDropdown) {
if (!hideClearButton && shouldShowClearButton && trailingDropdown) {
return (
<BaseBox display="flex" gap="spacing.3">
{renderClearButton()} <Divider orientation="vertical" />
Expand Down