feat: expose none & largest values for sheetLargestUndimmedDetent prop
#2359
Conversation
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
kkafar
changed the title
SHEET_DIMMED_ALWAYS constantnone & largest values for sheetLargestUndimmedDetent prop
ja1ns
pushed a commit
to WiseOwlTech/react-native-screens
that referenced
this pull request
Oct 9, 2024
…t` prop (software-mansion#2359) ## Description I'm exposing two new options for `sheetLargestUndimmedDetent` prop: * `none` - denoting that dimming view will be always present, * `largest` - denoting that dimming view will never be present. Previously to achieve the effect of `none` you had to either rely on default or pass `-1` raw value. Similarly achieving the effect of `largest` required user to set a numeric value and update it everytime new detent was added / removed. > [!note] ~~As I wrote this description, new idea popped out - instead of exposing numeric constant just add some string options, as with `sheetAllowedDetents` (it is an array or some predefined string constants). > What would be the API though? `sheetLargestUndimmedDetent: 'none'`? What's the wording here?~~ > > *Done! ^^^* `react-navigation` PR: * react-navigation/react-navigation#12032 ## Changes Replaced raw `-1` with constants `none` and `largest`. ## Test code and steps to reproduce `Test1649` ## Checklist - [x] Included code example that can be used to test this change - [x] Updated TS types - [x] Updated documentation: <!-- For adding new props to native-stack --> - [x] https://github.com/software-mansion/react-native-screens/blob/main/guides/GUIDE_FOR_LIBRARY_AUTHORS.md - [x] https://github.com/software-mansion/react-native-screens/blob/main/native-stack/README.md - [x] https://github.com/software-mansion/react-native-screens/blob/main/src/types.tsx - [x] https://github.com/software-mansion/react-native-screens/blob/main/src/native-stack/types.tsx - [x] Ensured that CI passes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
I'm exposing two new options for
sheetLargestUndimmedDetentprop:none- denoting that dimming view will be always present,largest- denoting that dimming view will never be present.Previously to achieve the effect of
noneyou had to either rely on default or pass-1raw value.Similarly achieving the effect of
largestrequired user to set a numeric value and update it everytime new detent was added / removed.Note
As I wrote this description, new idea popped out - instead of exposing numeric constant just add some string options, as withsheetAllowedDetents(it is an array or some predefined string constants).What would be the API though?
sheetLargestUndimmedDetent: 'none'? What's the wording here?Done! ^^^
react-navigationPR:Changes
Replaced raw
-1with constantsnoneandlargest.Test code and steps to reproduce
Test1649Checklist