Skip to content

feat(SeachBar): add onKeyboardHide for android #3657

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
arpitBhalla merged 3 commits into from
Oct 22, 2022
Merged

feat(SeachBar): add onKeyboardHide for android #3657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9baa0ba
WIP
arpitBhalla Oct 22, 2022
4bae1b5
update tests
arpitBhalla Oct 22, 2022
d3f4322
Merge branch 'next' into 3221
arpitBhalla Oct 22, 2022
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
13 changes: 8 additions & 5 deletions packages/base/src/SearchBar/SearchBar-android.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,16 @@ export class SearchBarAndroid extends Component<
hasFocus: false,
isEmpty: value ? value === '' : true,
};
this.keyboardListener = Keyboard.addListener(
'keyboardDidHide',
this._keyboardDidHide
);
if (this.props.onKeyboardHide) {
this.keyboardListener = Keyboard.addListener(
'keyboardDidHide',
this._keyboardDidHide
);
}
}
_keyboardDidHide = () => {
this.cancel();
this.blur();
this.props.onKeyboardHide?.();
};

componentWillUnmount() {
Expand Down
8 changes: 6 additions & 2 deletions packages/base/src/SearchBar/__tests__/SearchBar.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,16 @@ describe('SearchBar wrapper component', () => {
Keyboard.addListener = originalAddListener;
});
it('should subscribe to KeyboardDidClose event', () => {
renderWithWrapper(<SearchBar platform="android" />);
renderWithWrapper(
<SearchBar platform="android" onKeyboardHide={() => {}} />
);
expect(Keyboard.addListener).toHaveBeenCalled();
});

it('should call listener.remove on unmount', () => {
const component = renderWithWrapper(<SearchBar platform="android" />);
const component = renderWithWrapper(
<SearchBar platform="android" onKeyboardHide={() => {}} />
);
component.unmount();
expect(mockListener.remove).toHaveBeenCalled();
});
Expand Down
8 changes: 6 additions & 2 deletions packages/base/src/SearchBar/types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ export type SearchBarAndroidProps = SearchBarBaseProps & {
platform?: 'android';
cancelIcon?: IconNode;
/**
* @type Callback Function on cancel icon press
* Callback Function on cancel icon press
*/
onCancel?: () => any;
/**
* Callback Function on keyboard hides
*/
onKeyboardHide?: () => any;
};

export type SearchBarIosProps = SearchBarBaseProps & {
Expand All @@ -38,7 +42,7 @@ export type SearchBarIosProps = SearchBarBaseProps & {
searchIcon?: IconNode;
clearIcon?: IconNode;
/**
* @type Callback Function on cancel icon press
* Callback Function on cancel icon press
*/
onCancel?: () => any;
};
Expand Down
41 changes: 21 additions & 20 deletions website/docs/components/SearchBar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,26 +45,27 @@ Includes all [Input](input#props) props.

<div class='table-responsive'>

| Name | Type | Default | Description |
| ------------------------- | ------------------------------- | --------- | -------------------------- |
| `cancelButtonProps` | Text Style | | |
| `cancelButtonTitle` | string | | |
| `cancelIcon` | IconNode | | |
| `clearIcon` | IconNode | | Clear Icon |
| `containerStyle` | View Style | | Style for container |
| `inputContainerStyle` | View Style | | Style for input container |
| `inputStyle` | Text Style | | Input Style |
| `leftIconContainerStyle` | View Style | | Left Icon Container Style |
| `lightTheme` | boolean | | |
| `loadingProps` | ActivityIndicatorProps | | ActivityIndicatorProps |
| `onCancel` | `(() => any)` \| `(() => any)` | | |
| `onClear` | Function | | |
| `platform` | `default` \| `android` \| `ios` | `default` | |
| `rightIconContainerStyle` | View Style | | Right Icon Container Style |
| `round` | boolean | | |
| `searchIcon` | IconNode | | Icon for search |
| `showCancel` | boolean | | Show cancel |
| `showLoading` | boolean | | Show loading |
| Name | Type | Default | Description |
| ------------------------- | ------------------------------- | --------- | -------------------------------------- |
| `cancelButtonProps` | Text Style | | |
| `cancelButtonTitle` | string | | |
| `cancelIcon` | IconNode | | |
| `clearIcon` | IconNode | | Clear Icon |
| `containerStyle` | View Style | | Style for container |
| `inputContainerStyle` | View Style | | Style for input container |
| `inputStyle` | Text Style | | Input Style |
| `leftIconContainerStyle` | View Style | | Left Icon Container Style |
| `lightTheme` | boolean | | |
| `loadingProps` | ActivityIndicatorProps | | ActivityIndicatorProps |
| `onCancel` | `(() => any)` \| `(() => any)` | | Callback Function on cancel icon press |
| `onClear` | Function | | |
| `onKeyboardHide` | Function | | Callback Function on keyboard hides |
| `platform` | `default` \| `android` \| `ios` | `default` | |
| `rightIconContainerStyle` | View Style | | Right Icon Container Style |
| `round` | boolean | | |
| `searchIcon` | IconNode | | Icon for search |
| `showCancel` | boolean | | Show cancel |
| `showLoading` | boolean | | Show loading |

</div>

Expand Down