Skip to content

docs: Native Stack - headerBackButtonMenuEnabled #1352

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
merged 8 commits into from
Aug 5, 2024
Merged

docs: Native Stack - headerBackButtonMenuEnabled #1352

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
26448eb
chore: Created new assets folder, added video for 'headerBackButtonMe…
stanleyoos Aug 1, 2024
72930ef
chore(docs v7): Added screenshots for headerBackTitle
stanleyoos Aug 1, 2024
9122a31
chore: moved all files to native-stack folder
stanleyoos Aug 2, 2024
19163d8
chore(docs): Updated images for header title
stanleyoos Aug 2, 2024
20dd21e
chore(docs): Added code example for headerBackTitleStyle
stanleyoos Aug 2, 2024
2b781a7
[autofix.ci] apply automated fixes
autofix-ci[bot] Aug 2, 2024
5f055d3
chore(docs): Deleted unused line
stanleyoos Aug 2, 2024
1398417
chore(docs): Updated code example
stanleyoos Aug 2, 2024
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
0 ...-stack/native-stack-animation-default.mp4 → ...mation/native-stack-animation-default.mp4
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to split these files into separate folder, even worse having a separate folder for a singular image eg. headerBackTitle/headerBackTitle.jpeg. A better approach is to have it all in a single native-stack folder and using names for files that group them well.

File renamed without changes.
0 ...tive-stack-animation-fade-from-bottom.mp4 → ...tive-stack-animation-fade-from-bottom.mp4
View file
Open in desktop
File renamed without changes.
0 ...ive-stack/native-stack-animation-fade.mp4 → ...animation/native-stack-animation-fade.mp4
View file
Open in desktop
File renamed without changes.
0 ...ive-stack/native-stack-animation-flip.mp4 → ...animation/native-stack-animation-flip.mp4
View file
Open in desktop
File renamed without changes.
0 ...ive-stack/native-stack-animation-none.mp4 → ...animation/native-stack-animation-none.mp4
View file
Open in desktop
File renamed without changes.
0 ...ck/native-stack-animation-simple-push.mp4 → ...on/native-stack-animation-simple-push.mp4
View file
Open in desktop
File renamed without changes.
0 ...ive-stack-animation-slide-from-bottom.mp4 → ...ive-stack-animation-slide-from-bottom.mp4
View file
Open in desktop
File renamed without changes.
0 ...ative-stack-animation-slide-from-left.mp4 → ...ative-stack-animation-slide-from-left.mp4
View file
Open in desktop
File renamed without changes.
0 ...tive-stack-animation-slide-from-right.mp4 → ...tive-stack-animation-slide-from-right.mp4
View file
Open in desktop
File renamed without changes.
Binary file added static/assets/7.x/native-stack/headerBackButtonMenuEnabled/headerBackButtonMenuEnabled.mp4
View file
Open in desktop
Binary file not shown.
Binary file added static/assets/7.x/native-stack/headerBackTitle/headerBackTitle.jpeg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/7.x/native-stack/headerBackTitleStyle/headerBackTitleStyle.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 17 additions & 9 deletions versioned_docs/version-7.x/native-stack-navigator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ Requires `react-native-screens` version >=3.3.0.

Only supported on iOS.

<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/headerBackButtonMenuEnabled/headerBackButtonMenuEnabled.mp4" />
</video>

#### `headerBackVisible`

Whether the back button is visible in the header. You can use it to show a back button alongside `headerLeft` if you have specified it.
Expand All @@ -178,6 +182,8 @@ Title string used by the back button on iOS. Defaults to the previous scene's ti

Only supported on iOS.

<img src="/assets/7.x/native-stack/headerBackTitle/headerBackTitle.jpeg" height="700" alt="Header back title" />

#### `headerBackTitleVisible`

Whether the back button title should be visible or not.
Expand All @@ -193,6 +199,8 @@ Style object for header back title. Supported properties:

Only supported on iOS.

<img src="/assets/7.x/native-stack/headerBackTitleStyle/headerBackTitleStyle.png" width="500" alt="Header back title style" />

#### `headerBackImageSource`

Image to display in the header as the icon in the back button. Defaults to back icon image for the platform
Expand Down Expand Up @@ -606,47 +614,47 @@ Supported values:

- `default`: use the platform default animation
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-default.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-default.mp4" />
</video>

- `fade`: fade screen in or out
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-fade.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-fade.mp4" />
</video>

- `fade_from_bottom`: fade the new screen from bottom
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-fade-from-bottom.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-fade-from-bottom.mp4" />
</video>

- `flip`: flip the screen, requires `presentation: "modal"` (iOS only)
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-flip.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-flip.mp4" />
</video>

- `simple_push`: default animation, but without shadow and native header transition (iOS only, uses default animation on Android)
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-simple-push.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-simple-push.mp4" />
</video>

- `slide_from_bottom`: slide in the new screen from bottom
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-slide-from-bottom.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-slide-from-bottom.mp4" />
</video>

- `slide_from_right`: slide in the new screen from right (Android only, uses default animation on iOS)
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-slide-from-right.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-slide-from-right.mp4" />
</video>

- `slide_from_left`: slide in the new screen from left (Android only, uses default animation on iOS)
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-slide-from-left.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-slide-from-left.mp4" />
</video>

- `none`: don't animate the screen
<video playsInline autoPlay muted loop>
<source src="/assets/7.x/native-stack/native-stack-animation-none.mp4" />
<source src="/assets/7.x/native-stack/animation/native-stack-animation-none.mp4" />
</video>

#### `presentation`
Expand Down
Loading