Skip to content

Commit b78414e

Browse files
aharwood9e-younan
authored andcommitted
docs: add new prop to the containers
1 parent d29e42c commit b78414e

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

docs/docs/03-api-reference/01-scroll-view-with-headers.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,20 @@ An optional component to render as the first child of the ScrollView. This accep
3636
returns a React Element to display as the large header. The function will be called with the
3737
following arguments:
3838

39+
- `scrollY`: An animated value that keeps track of the current scroll position of the ScrollView.
40+
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
41+
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header
42+
when the user pulls down on the ScrollView (to mimic native iOS behaviour).
43+
- `showNavBar`: An animated value that keeps track of whether or not the small header is hidden.
44+
This prop is useful if you want to create your own custom animations based on whether or not the
45+
small header is hidden.
46+
47+
### LargeHeaderSubtitleComponent
48+
49+
An optional component to render typically as the second child of the ScrollView. This accepts a function that
50+
returns a React Element to display as the large header subtitle. The function will be called with the
51+
following arguments:
52+
3953
- `scrollY`: An animated value that keeps track of the current scroll position of the ScrollView.
4054
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
4155
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header

docs/docs/03-api-reference/02-flat-list-with-headers.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,20 @@ An optional component to render as the large header for this component. This acc
3636
that returns a React Element to display as the large header. The function will be called with the
3737
following arguments:
3838

39+
- `scrollY`: An animated value that keeps track of the current scroll position of the FlatList.
40+
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
41+
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header
42+
when the user pulls down on the FlatList (to mimic native iOS behaviour).
43+
- `showNavBar`: An animated value that keeps track of whether or not the small header is hidden.
44+
This prop is useful if you want to create your own custom animations based on whether or not the
45+
small header is hidden.
46+
47+
### LargeHeaderSubtitleComponent
48+
49+
An optional component to render as a subtitle for the large header for this component. This accepts a function
50+
that returns a React Element to display as the large header subtitle. The function will be called with the
51+
following arguments:
52+
3953
- `scrollY`: An animated value that keeps track of the current scroll position of the FlatList.
4054
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
4155
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header

docs/docs/03-api-reference/03-section-list-with-headers.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ following arguments:
4444
This prop is useful if you want to create your own custom animations based on whether or not the
4545
small header is hidden.
4646

47+
### LargeHeaderSubtitleComponent
48+
49+
An optional component to render as a subtitle for the large header for this component. This accepts a function
50+
that returns a React Element to display as the large header subtitle. The function will be called with the
51+
following arguments:
52+
53+
- `scrollY`: An animated value that keeps track of the current scroll position of the FlatList.
54+
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
55+
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header
56+
when the user pulls down on the FlatList (to mimic native iOS behaviour).
57+
- `showNavBar`: An animated value that keeps track of whether or not the small header is hidden.
58+
This prop is useful if you want to create your own custom animations based on whether or not the
59+
small header is hidden.
60+
4761
### ignoreLeftSafeArea
4862

4963
An optional boolean that determines whether or not to ignore the left safe area. Defaults to

docs/docs/03-api-reference/04-flash-list-with-headers.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,20 @@ following arguments:
4949
This prop is useful if you want to create your own custom animations based on whether or not the
5050
small header is hidden.
5151

52+
### LargeHeaderSubtitleComponent
53+
54+
An optional component to render as a subtitle for the large header for this component. This accepts a function
55+
that returns a React Element to display as the large header subtitle. The function will be called with the
56+
following arguments:
57+
58+
- `scrollY`: An animated value that keeps track of the current scroll position of the FlatList.
59+
This prop is useful for creating custom animations on the large header. In our [example](/docs/example),
60+
we use the [ScalingView](/docs/components/scaling-view) component to scale the large header
61+
when the user pulls down on the FlatList (to mimic native iOS behaviour).
62+
- `showNavBar`: An animated value that keeps track of whether or not the small header is hidden.
63+
This prop is useful if you want to create your own custom animations based on whether or not the
64+
small header is hidden.
65+
5266
### ignoreLeftSafeArea
5367

5468
An optional boolean that determines whether or not to ignore the left safe area. Defaults to

0 commit comments

Comments
 (0)