feat(SearchBarIos): new prop option omitCancel
#3833
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.
Motivation
I'm always frustrated when the showCancel Prop (for platform="ios" only) on the SearchBar component from @rneui/base only defines whether or not to persist the cancel button beside the searchbar when unfocused. I wanted to see an option that let the developer omit the cancel button from the SearchBar, resulting in a cleaner UI when the button is not necessary. I created a new prop called
omitCancel
:boolean
that defaults asfalse
. WhenomitCancel={true}
, it will completely omit the cancel button on SearchBars withplatform="ios"
, so it will never appear regardless of it being focused or not.Fixes: Creates new prop called
omitCancel
:boolean
that defaults asfalse
Type of change
How Has This Been Tested?
Checklist
yarn docs-build-api
Additional context
In the below image, the cancel button is omitted while maintaining the rest of the native iOS styles.