Required props:
Optional props:
initialNumToRenderkeyExtractoronEndReachedextraDataItemSeparatorComponentinitialNumToRenderinvertedListFooterComponentItemSeparatorComponentkeyExtractorlegacyImplementationListEmptyComponentListFooterComponentListHeaderComponentonEndReachedonEndReachedThresholdonRefreshonViewableItemsChangedrefreshingremoveClippedSubviewsListHeaderComponentrenderSectionFooterrenderSectionHeaderSectionSeparatorComponentsectionsThe actual data to render, akin to the data prop in FlatList.
| Type | Required |
|---|---|
| array of Sections | Yes |
initialNumToRenderHow many items to render in the initial batch. This should be enough to fill the screen but not much more. Note these items will never be unmounted as part of the windowed rendering in order to improve perceived performance of scroll-to-top actions.
-| Type | Required |
|---|---|
| number | Yes |
keyExtractorUsed to extract a unique key for a given item at the specified index. Key is used for caching and as the React key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does. Note that this sets keys for each item, but each overall section still needs its own key.
| Type | Required |
|---|---|
| (item: Item, index: number) => string | Yes |
renderItemDefault renderer for every item in every section. Can be over-ridden on a per-section basis. Should return a React element.
| Type | Required |
|---|---|
| [(info: {distanceFromEnd: number}) => void] | No |
| array of Sections | Yes |
ItemSeparatorComponentRendered in between each item, but not at the top or bottom. By default, highlighted, section, and [leading/trailing][Item/Section] props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps.
initialNumToRenderHow many items to render in the initial batch. This should be enough to fill the screen but not much more. Note these items will never be unmounted as part of the windowed rendering in order to improve perceived performance of scroll-to-top actions.
| Type | Required |
|---|---|
| [component, function, element] | No |
| number | Yes |
ListFooterComponentRendered at the very end of the list. Can be a React Component Class, a render function, or a rendered element.
+ItemSeparatorComponentRendered in between each item, but not at the top or bottom. By default, highlighted, section, and [leading/trailing][Item/Section] props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps.
| Type | Required |
|---|
keyExtractorUsed to extract a unique key for a given item at the specified index. Key is used for caching and as the React key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does. Note that this sets keys for each item, but each overall section still needs its own key.
| Type | Required |
|---|---|
| (item: Item, index: number) => string | Yes |
legacyImplementationThe legacy implementation is no longer supported.
| Type | Required |
|---|
ListFooterComponentRendered at the very end of the list. Can be a React Component Class, a render function, or a rendered element.
+| Type | Required |
|---|---|
| [component, function, element] | No |
ListHeaderComponentRendered at the very beginning of the list. Can be a React Component Class, a render function, or a rendered element.
+| Type | Required |
|---|---|
| component, function, element | No |
onEndReachedCalled once when the scroll position gets within onEndReachedThreshold of the rendered content.
| Type | Required |
|---|---|
| [(info: {distanceFromEnd: number}) => void] | No |
onEndReachedThresholdHow far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.
ListHeaderComponentRendered at the very beginning of the list. Can be a React Component Class, a render function, or a rendered element.
-| Type | Required |
|---|---|
| component, function, element | No |
renderSectionFooterRendered at the bottom of each section.
| Platfrom |
|---|
| iOS |
An object that identifies the data to be rendered for a given section.
diff --git a/docs/next/sectionlist/index.html b/docs/next/sectionlist/index.html index 754690a73e1..09c0f64602e 100644 --- a/docs/next/sectionlist/index.html +++ b/docs/next/sectionlist/index.html @@ -124,26 +124,26 @@Required props:
Optional props:
initialNumToRenderkeyExtractoronEndReachedextraDataItemSeparatorComponentinitialNumToRenderinvertedListFooterComponentItemSeparatorComponentkeyExtractorlegacyImplementationListEmptyComponentListFooterComponentListHeaderComponentonEndReachedonEndReachedThresholdonRefreshonViewableItemsChangedrefreshingremoveClippedSubviewsListHeaderComponentrenderSectionFooterrenderSectionHeaderSectionSeparatorComponentsectionsThe actual data to render, akin to the data prop in FlatList.
| Type | Required |
|---|---|
| array of Sections | Yes |
initialNumToRenderHow many items to render in the initial batch. This should be enough to fill the screen but not much more. Note these items will never be unmounted as part of the windowed rendering in order to improve perceived performance of scroll-to-top actions.
-| Type | Required |
|---|---|
| number | Yes |
keyExtractorUsed to extract a unique key for a given item at the specified index. Key is used for caching and as the React key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does. Note that this sets keys for each item, but each overall section still needs its own key.
| Type | Required |
|---|---|
| (item: Item, index: number) => string | Yes |
renderItemDefault renderer for every item in every section. Can be over-ridden on a per-section basis. Should return a React element.
| Type | Required |
|---|---|
| [(info: {distanceFromEnd: number}) => void] | No |
| array of Sections | Yes |
ItemSeparatorComponentRendered in between each item, but not at the top or bottom. By default, highlighted, section, and [leading/trailing][Item/Section] props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps.
initialNumToRenderHow many items to render in the initial batch. This should be enough to fill the screen but not much more. Note these items will never be unmounted as part of the windowed rendering in order to improve perceived performance of scroll-to-top actions.
| Type | Required |
|---|---|
| [component, function, element] | No |
| number | Yes |
ListFooterComponentRendered at the very end of the list. Can be a React Component Class, a render function, or a rendered element.
+ItemSeparatorComponentRendered in between each item, but not at the top or bottom. By default, highlighted, section, and [leading/trailing][Item/Section] props are provided. renderItem provides separators.highlight/unhighlight which will update the highlighted prop, but you can also add custom props with separators.updateProps.
| Type | Required |
|---|
keyExtractorUsed to extract a unique key for a given item at the specified index. Key is used for caching and as the React key to track item re-ordering. The default extractor checks item.key, then falls back to using the index, like React does. Note that this sets keys for each item, but each overall section still needs its own key.
| Type | Required |
|---|---|
| (item: Item, index: number) => string | Yes |
legacyImplementationThe legacy implementation is no longer supported.
| Type | Required |
|---|
ListFooterComponentRendered at the very end of the list. Can be a React Component Class, a render function, or a rendered element.
+| Type | Required |
|---|---|
| [component, function, element] | No |
ListHeaderComponentRendered at the very beginning of the list. Can be a React Component Class, a render function, or a rendered element.
+| Type | Required |
|---|---|
| component, function, element | No |
onEndReachedCalled once when the scroll position gets within onEndReachedThreshold of the rendered content.
| Type | Required |
|---|---|
| [(info: {distanceFromEnd: number}) => void] | No |
onEndReachedThresholdHow far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.
ListHeaderComponentRendered at the very beginning of the list. Can be a React Component Class, a render function, or a rendered element.
-| Type | Required |
|---|---|
| component, function, element | No |
renderSectionFooterRendered at the bottom of each section.
| Platfrom |
|---|
| iOS |
An object that identifies the data to be rendered for a given section.
diff --git a/docs/next/switch.html b/docs/next/switch.html index 9f3384c66b5..19f35136806 100644 --- a/docs/next/switch.html +++ b/docs/next/switch.html @@ -78,11 +78,11 @@disabledtrackColorios_backgroundColoronValueChangeonChangeonValueChangethumbColortrackColorvaluetrackColorCustom colors for the switch track.
-iOS: When the switch value is false, the track shrinks into the border. If you want to change the color of the background exposed by the shrunken track, use ios_backgroundColor.
| Type | Required |
|---|---|
| object: {false: color, true: color} | No |
ios_backgroundColorOn iOS, custom color for the background. This background color can be seen either when the switch value is false or when the switch is disabled (and the switch is translucent).
onValueChangeInvoked when the user tries to change the value of the switch. Receives the new value as an argument. If you want to instead receive an event, use onChange.
onChangeInvoked when the user tries to change the value of the switch. Receives the change event as an argument. If you want to only receive the new value, use onValueChange instead.
| Type | Required |
|---|
onChangeInvoked when the user tries to change the value of the switch. Receives the change event as an argument. If you want to only receive the new value, use onValueChange instead.
onValueChangeInvoked when the user tries to change the value of the switch. Receives the new value as an argument. If you want to instead receive an event, use onChange.
| Type | Required |
|---|
trackColorCustom colors for the switch track.
+iOS: When the switch value is false, the track shrinks into the border. If you want to change the color of the background exposed by the shrunken track, use ios_backgroundColor.
| Type | Required |
|---|---|
| object: {false: color, true: color} | No |
valueThe value of the switch. If true the switch will be turned on. Default value is false.
trackColorCustom colors for the switch track.
-iOS: When the switch value is false, the track shrinks into the border. If you want to change the color of the background exposed by the shrunken track, use ios_backgroundColor.
| Type | Required |
|---|---|
| object: {false: color, true: color} | No |
ios_backgroundColorOn iOS, custom color for the background. This background color can be seen either when the switch value is false or when the switch is disabled (and the switch is translucent).
onValueChangeInvoked when the user tries to change the value of the switch. Receives the new value as an argument. If you want to instead receive an event, use onChange.
onChangeInvoked when the user tries to change the value of the switch. Receives the change event as an argument. If you want to only receive the new value, use onValueChange instead.
| Type | Required |
|---|
onChangeInvoked when the user tries to change the value of the switch. Receives the change event as an argument. If you want to only receive the new value, use onValueChange instead.
onValueChangeInvoked when the user tries to change the value of the switch. Receives the new value as an argument. If you want to instead receive an event, use onChange.
| Type | Required |
|---|
trackColorCustom colors for the switch track.
+iOS: When the switch value is false, the track shrinks into the border. If you want to change the color of the background exposed by the shrunken track, use ios_backgroundColor.
| Type | Required |
|---|---|
| object: {false: color, true: color} | No |
valueThe value of the switch. If true the switch will be turned on. Default value is false.