feat(android): Add shouldClearOnSubmit-prop to search view #1639
Conversation
There was a problem hiding this comment.
Hi @patricronge, great job! Thanks for the contribution and sorry for the huge delay of our response ❤️🙏 I just left some comments what is worth paying attention to, but the most important thing I believe is to change shouldClearOnSubmit to just clearOnSubmit.
| @@ -46,6 +46,7 @@ const MainScreen = ({ navigation }: MainScreenProps): JSX.Element => { | |||
| const [autoCapitalize, setAutoCapitalize] = | |||
| useState<AutoCapitalize>('sentences'); | |||
| const [inputType, setInputType] = useState<InputType>('text'); | |||
| const [shouldClearOnSubmit, setShouldClearOnSubmit] = useState(false); | |||
There was a problem hiding this comment.
I think clearOnSubmit would be a better name for the state and property overall.
| if (shouldClearOnSubmit != null) { | ||
| view.shouldClearOnSubmit = shouldClearOnSubmit | ||
| } |
There was a problem hiding this comment.
Let's change this into
| if (shouldClearOnSubmit != null) { | |
| view.shouldClearOnSubmit = shouldClearOnSubmit | |
| } | |
| view.shouldClearOnSubmit = shouldClearOnSubmit ?: false |
| @@ -10,6 +10,7 @@ import androidx.appcompat.widget.SearchView | |||
| class SearchViewFormatter(var searchView: SearchView) { | |||
| private var mDefaultTextColor: Int? = null | |||
| private var mDefaultTintBackground: Drawable? = null | |||
| private var mDefaultText: String = "" | |||
There was a problem hiding this comment.
Is default text needed here? I believe placeholder is being used as a default text to show when the prompt is empty - if this prop is not being served as a Search Bar prop, let's remove it.
| @@ -64,4 +65,8 @@ class SearchViewFormatter(var searchView: SearchView) { | |||
| searchEditText?.hint = placeholder | |||
| } | |||
| } | |||
|
|
|||
| fun clearText() { | |||
| searchEditText?.setText(mDefaultText) | |||
There was a problem hiding this comment.
According to the upper comment, let's change this to
| searchEditText?.setText(mDefaultText) | |
| searchEditText?.setText(null) |
There was a problem hiding this comment.
As we don't hold the implementation of the Native Stack v5 anymore, I believe this change of the file is unnecessary.
| /** | ||
| * Clear the search input when search button is pressed. | ||
| * | ||
| * @plaform android | ||
| * @default false | ||
| */ | ||
| shouldClearOnSubmit?: boolean; |
There was a problem hiding this comment.
As I said, I'd suggest changing the name of this prop to clearOnSubmit.
|
Hi @patricronge, a small update from me - it looks like there's existing implementation of such behavior 😅 For clearing the search bar query, you can listen to the const searchBarRef = useRef<SearchBarCommands>(null);
// screenOptions or navigation#setOptions
ref: searchBarRef,
onSearchButtonPress: () => {
searchBarRef.current.clearText();
}I'll close this PR for now, but if you'd like to change current search bar API don't hesitate to create new PR. |
Description
Adds an optional shouldClearOnSubmit-prop as boolean for android search view.
Clears the Search-input after after search button is pressed.
Screenshots / GIFs
Test code and steps to reproduce
Run the example project and go to Search bar. A settings switch for this prop has been added to the Android only-section.
Checklist