Skip to content

Commit fdfe03a

Browse files
committed
Update stack navigator docs
1 parent 05eeb16 commit fdfe03a

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

docs/native-stack-navigator.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,14 @@ String that can be used as a fallback for `headerTitle`.
9494

9595
Whether to show or hide the header for the screen. The header is shown by default. Setting this to `false` hides the header.
9696

97+
#### `headerHideBackButton`
98+
99+
Boolean indicating whether to hide the elevation shadow on the header. Only supported on Android.
100+
101+
#### `headerHideShadow`
102+
103+
Boolean indicating whether to hide the elevation shadow on the header. Only supported on Android.
104+
97105
#### `headerTitle`
98106

99107
String to be used by the header as title string. Defaults to scene `title`.
@@ -149,13 +157,23 @@ Whether you can use gestures to dismiss this screen. Defaults to `true` on iOS,
149157

150158
#### `presentation`
151159

152-
How should the screen be presented. Available options:
160+
How should the screen be presented. Possible options:
153161

154162
- `modal`
155163
- `transparentModal`
156164
- `push`
157165

158-
Defaults to `push`. Only supported on iOS.
166+
Defaults to `push`.
167+
168+
#### `animation`
169+
170+
How should the screen be animated. Possible options:
171+
172+
- `default`
173+
- `fade`
174+
- `none`
175+
176+
Only supported on `Android`.
159177

160178
### Events
161179

docs/stack-navigator.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,15 @@ Whether to show or hide the header for the screen. The header is shown by defaul
175175

176176
String or a function that returns a React Element to be used by the header. Defaults to scene `title`. When a function is specified, it receives `allowFontScaling`, `onLayout`, `style` and `children` as the arguments. The title string is passed in `children`.
177177

178+
#### `headerTitleAlign`
179+
180+
How to align the the header title. Possible values:
181+
182+
- `left`
183+
- `center`
184+
185+
Defaults to `center` on iOS and `left` on Android.
186+
178187
#### `headerTitleAllowFontScaling`
179188

180189
Whether header title font should scale to respect Text Size accessibility settings. Defaults to false.

website/versioned_docs/version-4.x/stack-navigator-2.0.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,15 @@ Whether to show or hide the header for the screen. The header is shown by defaul
222222

223223
String or a function that returns a React Element to be used by the header. Defaults to scene `title`. When a function is specified, it receives `allowFontScaling`, `onLayout`, `style` and `children` as the arguments. The title string is passed in `children`.
224224

225+
#### `headerTitleAlign`
226+
227+
How to align the the header title. Possible values:
228+
229+
- `left`
230+
- `center`
231+
232+
Defaults to `center` on iOS and `left` on Android.
233+
225234
#### `headerTitleAllowFontScaling`
226235

227236
Whether header title font should scale to respect Text Size accessibility settings. Defaults to false.

0 commit comments

Comments
 (0)