-
Notifications
You must be signed in to change notification settings - Fork 0
/
rn-modules.json
2242 lines (2242 loc) · 82.1 KB
/
rn-modules.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"ActivityIndicator": {
"description": "",
"props": {
"animating": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether to show the indicator (true, the default) or hide it (false).",
"defaultValue": {
"value": "true",
"computed": false
}
},
"color": {
"type": {
"name": "string"
},
"required": false,
"description": "The foreground color of the spinner (default is gray).",
"defaultValue": {
"value": "'#999999'",
"computed": false
}
},
"hidesWhenStopped": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether the indicator should hide when not animating (true by default).",
"defaultValue": {
"value": "true",
"computed": false
}
},
"size": {
"type": {
"name": "enum",
"value": [
{
"value": "'small'",
"computed": false
},
{
"value": "'large'",
"computed": false
}
]
},
"required": false,
"description": "Size of the indicator. Small has a height of 20, large has a height of 36.",
"defaultValue": {
"value": "'small'",
"computed": false
}
},
"onLayout": {
"type": {
"name": "func"
},
"required": false,
"description": "Invoked on mount and layout changes with\n\n {nativeEvent: { layout: {x, y, width, height}}}."
}
},
"composes": [
"View"
]
},
"MapView": {
"description": "",
"props": {
"style": {
"type": {
"name": "custom",
"raw": "View.propTypes.style"
},
"required": false,
"description": "Used to style and layout the `MapView`. See `StyleSheet.js` and\n`ViewStylePropTypes.js` for more info."
},
"showsUserLocation": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `true` the app will ask for the user's location and display it on\nthe map. Default value is `false`.\n\n**NOTE**: on iOS, you need to add the `NSLocationWhenInUseUsageDescription`\nkey in Info.plist to enable geolocation, otherwise it will fail silently."
},
"followUserLocation": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `true` the map will follow the user's location whenever it changes.\nNote that this has no effect unless `showsUserLocation` is enabled.\nDefault value is `true`.\n@platform ios"
},
"showsPointsOfInterest": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `false` points of interest won't be displayed on the map.\nDefault value is `true`.\n@platform ios"
},
"showsCompass": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `false` compass won't be displayed on the map.\nDefault value is `true`.\n@platform ios"
},
"zoomEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `false` the user won't be able to pinch/zoom the map.\nDefault value is `true`."
},
"rotateEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "When this property is set to `true` and a valid camera is associated with\nthe map, the camera’s heading angle is used to rotate the plane of the\nmap around its center point. When this property is set to `false`, the\ncamera’s heading angle is ignored and the map is always oriented so\nthat true north is situated at the top of the map view"
},
"pitchEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "When this property is set to `true` and a valid camera is associated\nwith the map, the camera’s pitch angle is used to tilt the plane\nof the map. When this property is set to `false`, the camera’s pitch\nangle is ignored and the map is always displayed as if the user\nis looking straight down onto it."
},
"scrollEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If `false` the user won't be able to change the map region being displayed.\nDefault value is `true`."
},
"mapType": {
"type": {
"name": "enum",
"value": [
{
"value": "'standard'",
"computed": false
},
{
"value": "'satellite'",
"computed": false
},
{
"value": "'hybrid'",
"computed": false
}
]
},
"required": false,
"description": "The map type to be displayed.\n\n- standard: standard road map (default)\n- satellite: satellite view\n- hybrid: satellite view with roads and points of interest overlaid\n\n@platform ios"
},
"region": {
"type": {
"name": "shape",
"value": {
"latitude": {
"name": "number",
"description": "Coordinates for the center of the map.",
"required": true
},
"longitude": {
"name": "number",
"required": true
},
"latitudeDelta": {
"name": "number",
"description": "Distance between the minimum and the maximum latitude/longitude\nto be displayed.",
"required": false
},
"longitudeDelta": {
"name": "number",
"required": false
}
}
},
"required": false,
"description": "The region to be displayed by the map.\n\nThe region is defined by the center coordinates and the span of\ncoordinates to display."
},
"annotations": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"latitude": {
"name": "number",
"description": "The location of the annotation.",
"required": true
},
"longitude": {
"name": "number",
"required": true
},
"animateDrop": {
"name": "bool",
"description": "Whether the pin drop should be animated or not",
"required": false
},
"draggable": {
"name": "bool",
"description": "Whether the pin should be draggable or not",
"required": false
},
"onDragStateChange": {
"name": "func",
"description": "Event that fires when the annotation drag state changes.",
"required": false
},
"onFocus": {
"name": "func",
"description": "Event that fires when the annotation gets was tapped by the user\nand the callout view was displayed.",
"required": false
},
"onBlur": {
"name": "func",
"description": "Event that fires when another annotation or the mapview itself\nwas tapped and a previously shown annotation will be closed.",
"required": false
},
"title": {
"name": "string",
"description": "Annotation title/subtile.",
"required": false
},
"subtitle": {
"name": "string",
"required": false
},
"leftCalloutView": {
"name": "element",
"description": "Callout views.",
"required": false
},
"rightCalloutView": {
"name": "element",
"required": false
},
"detailCalloutView": {
"name": "element",
"required": false
},
"tintColor": {
"name": "custom",
"raw": "ColorPropType",
"description": "The pin color. This can be any valid color string, or you can use one\nof the predefined PinColors constants. Applies to both standard pins\nand custom pin images.\n\nNote that on iOS 8 and earlier, only the standard PinColor constants\nare supported for regular pins. For custom pin images, any tintColor\nvalue is supported on all iOS versions.",
"required": false
},
"image": {
"name": "custom",
"raw": "Image.propTypes.source",
"description": "Custom pin image. This must be a static image resource inside the app.",
"required": false
},
"view": {
"name": "element",
"description": "Custom pin view. If set, this replaces the pin or custom pin image.",
"required": false
},
"id": {
"name": "string",
"description": "annotation id",
"required": false
},
"hasLeftCallout": {
"name": "custom",
"raw": "deprecatedPropType(\n React.PropTypes.bool,\n 'Use `leftCalloutView` instead.'\n)",
"description": "Deprecated. Use the left/right/detailsCalloutView props instead.",
"required": false
},
"hasRightCallout": {
"name": "custom",
"raw": "deprecatedPropType(\n React.PropTypes.bool,\n 'Use `rightCalloutView` instead.'\n)",
"required": false
},
"onLeftCalloutPress": {
"name": "custom",
"raw": "deprecatedPropType(\n React.PropTypes.func,\n 'Use `leftCalloutView` instead.'\n)",
"required": false
},
"onRightCalloutPress": {
"name": "custom",
"raw": "deprecatedPropType(\n React.PropTypes.func,\n 'Use `rightCalloutView` instead.'\n)",
"required": false
}
}
}
},
"required": false,
"description": "Map annotations with title/subtitle.\n@platform ios"
},
"overlays": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"coordinates": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"latitude": {
"name": "number",
"required": true
},
"longitude": {
"name": "number",
"required": true
}
}
},
"description": "Polyline coordinates",
"required": false
},
"lineWidth": {
"name": "number",
"description": "Line attributes",
"required": false
},
"strokeColor": {
"name": "custom",
"raw": "ColorPropType",
"required": false
},
"fillColor": {
"name": "custom",
"raw": "ColorPropType",
"required": false
},
"id": {
"name": "string",
"description": "Overlay id",
"required": false
}
}
}
},
"required": false,
"description": "Map overlays\n@platform ios"
},
"maxDelta": {
"type": {
"name": "number"
},
"required": false,
"description": "Maximum size of area that can be displayed.\n@platform ios"
},
"minDelta": {
"type": {
"name": "number"
},
"required": false,
"description": "Minimum size of area that can be displayed.\n@platform ios"
},
"legalLabelInsets": {
"type": {
"name": "custom",
"raw": "EdgeInsetsPropType"
},
"required": false,
"description": "Insets for the map's legal label, originally at bottom left of the map.\nSee `EdgeInsetsPropType.js` for more information.\n@platform ios"
},
"onRegionChange": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback that is called continuously when the user is dragging the map."
},
"onRegionChangeComplete": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback that is called once, when the user is done moving the map."
},
"onAnnotationPress": {
"type": {
"name": "func"
},
"required": false,
"description": "Deprecated. Use annotation onFocus and onBlur instead."
},
"active": {
"type": {
"name": "bool"
},
"required": false,
"description": "@platform android"
}
},
"composes": [
"View"
]
},
"Picker": {
"description": "Renders the native picker component on iOS and Android. Example:\n\n <Picker\n selectedValue={this.state.language}\n onValueChange={(lang) => this.setState({language: lang})}>\n <Picker.Item label=\"Java\" value=\"java\" />\n <Picker.Item label=\"JavaScript\" value=\"js\" />\n </Picker>",
"props": {
"style": {
"type": {
"name": "custom",
"raw": "pickerStyleType"
},
"required": false,
"description": ""
},
"selectedValue": {
"type": {
"name": "any"
},
"required": false,
"description": "Value matching value of one of the items. Can be a string or an integer."
},
"onValueChange": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback for when an item is selected. This is called with the following parameters:\n - `itemValue`: the `value` prop of the item that was selected\n - `itemPosition`: the index of the selected item in this picker"
},
"enabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If set to false, the picker will be disabled, i.e. the user will not be able to make a\nselection.\n@platform android"
},
"mode": {
"type": {
"name": "enum",
"value": [
{
"value": "'dialog'",
"computed": false
},
{
"value": "'dropdown'",
"computed": false
}
]
},
"required": false,
"description": "On Android, specifies how to display the selection items when the user taps on the picker:\n\n - 'dialog': Show a modal dialog. This is the default.\n - 'dropdown': Shows a dropdown anchored to the picker view\n\n@platform android",
"defaultValue": {
"value": "'dialog'",
"computed": false
}
},
"itemStyle": {
"type": {
"name": "custom",
"raw": "itemStylePropType"
},
"required": false,
"description": "Style to apply to each of the item labels.\n@platform ios"
},
"prompt": {
"type": {
"name": "string"
},
"required": false,
"description": "Prompt string for this picker, used on Android in dialog mode as the title of the dialog.\n@platform android"
},
"testID": {
"type": {
"name": "string"
},
"required": false,
"description": "Used to locate this view in end-to-end tests."
}
},
"composes": [
"View"
]
},
"ProgressBar": {
"description": "React component that wraps the Android-only `ProgressBar`. This component is used to indicate\nthat the app is loading or there is some activity in the app.\n\nExample:\n\n```\nrender: function() {\n var progressBar =\n <View style={styles.container}>\n <ProgressBar styleAttr=\"Inverse\" />\n </View>;\n\n return (\n <MyLoadingComponent\n componentView={componentView}\n loadingView={progressBar}\n style={styles.loadingComponent}\n />\n );\n},\n```",
"props": {
"styleAttr": {
"type": {
"name": "enum",
"computed": true,
"value": "STYLE_ATTRIBUTES"
},
"required": false,
"description": "Style of the ProgressBar. One of:\n\n- Horizontal\n- Normal (default)\n- Small\n- Large\n- Inverse\n- SmallInverse\n- LargeInverse",
"defaultValue": {
"value": "'Normal'",
"computed": false
}
},
"indeterminate": {
"type": {
"name": "custom",
"raw": "indeterminateType"
},
"required": false,
"description": "If the progress bar will show indeterminate progress. Note that this\ncan only be false if styleAttr is Horizontal.",
"defaultValue": {
"value": "true",
"computed": false
}
},
"progress": {
"type": {
"name": "number"
},
"required": false,
"description": "The progress value (between 0 and 1)."
},
"color": {
"type": {
"name": "custom",
"raw": "ColorPropType"
},
"required": false,
"description": "Color of the progress bar."
},
"testID": {
"type": {
"name": "string"
},
"required": false,
"description": "Used to locate this view in end-to-end tests."
}
},
"composes": [
"View"
]
},
"ProgressView": {
"description": "Use `ProgressViewIOS` to render a UIProgressView on iOS.",
"props": {
"progressViewStyle": {
"type": {
"name": "enum",
"value": [
{
"value": "'default'",
"computed": false
},
{
"value": "'bar'",
"computed": false
}
]
},
"required": false,
"description": "The progress bar style."
},
"progress": {
"type": {
"name": "number"
},
"required": false,
"description": "The progress value (between 0 and 1)."
},
"progressTintColor": {
"type": {
"name": "string"
},
"required": false,
"description": "The tint color of the progress bar itself."
},
"trackTintColor": {
"type": {
"name": "string"
},
"required": false,
"description": "The tint color of the progress bar track."
},
"progressImage": {
"type": {
"name": "custom",
"raw": "Image.propTypes.source"
},
"required": false,
"description": "A stretchable image to display as the progress bar."
},
"trackImage": {
"type": {
"name": "custom",
"raw": "Image.propTypes.source"
},
"required": false,
"description": "A stretchable image to display behind the progress bar."
}
},
"composes": [
"View"
]
},
"RefreshControl": {
"description": "This component is used inside a ScrollView to add pull to refresh\nfunctionality. When the ScrollView is at `scrollY: 0`, swiping down\ntriggers an `onRefresh` event.",
"props": {
"onRefresh": {
"type": {
"name": "func"
},
"required": false,
"description": "Called when the view starts refreshing."
},
"refreshing": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether the view should be indicating an active refresh."
},
"tintColor": {
"type": {
"name": "custom",
"raw": "ColorPropType"
},
"required": false,
"description": "The color of the refresh indicator.\n@platform ios"
},
"title": {
"type": {
"name": "string"
},
"required": false,
"description": "The title displayed under the refresh indicator.\n@platform ios"
},
"enabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether the pull to refresh functionality is enabled.\n@platform android"
},
"colors": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
"raw": "ColorPropType"
}
},
"required": false,
"description": "The colors (at least one) that will be used to draw the refresh indicator.\n@platform android"
},
"progressBackgroundColor": {
"type": {
"name": "custom",
"raw": "ColorPropType"
},
"required": false,
"description": "The background color of the refresh indicator.\n@platform android"
},
"size": {
"type": {
"name": "enum",
"computed": true,
"value": "RefreshLayoutConsts.SIZE.DEFAULT"
},
"required": false,
"description": "Size of the refresh indicator, see RefreshControl.SIZE.\n@platform android"
}
},
"composes": [
"View"
]
},
"ScrollView": {
"description": "Component that wraps platform ScrollView while providing\nintegration with touch locking \"responder\" system.\n\nKeep in mind that ScrollViews must have a bounded height in order to work,\nsince they contain unbounded-height children into a bounded container (via\na scroll interaction). In order to bound the height of a ScrollView, either\nset the height of the view directly (discouraged) or make sure all parent\nviews have bounded height. Forgetting to transfer `{flex: 1}` down the\nview stack can lead to errors here, which the element inspector makes\neasy to debug.\n\nDoesn't yet support other contained responders from blocking this scroll\nview from becoming the responder.",
"props": {
"automaticallyAdjustContentInsets": {
"type": {
"name": "bool"
},
"required": false,
"description": "Controls whether iOS should automatically adjust the content inset\nfor scroll views that are placed behind a navigation bar or\ntab bar/ toolbar. The default value is true.\n@platform ios"
},
"contentInset": {
"type": {
"name": "custom",
"raw": "EdgeInsetsPropType"
},
"required": false,
"description": "The amount by which the scroll view content is inset from the edges\nof the scroll view. Defaults to `{0, 0, 0, 0}`.\n@platform ios"
},
"contentOffset": {
"type": {
"name": "custom",
"raw": "PointPropType"
},
"required": false,
"description": "Used to manually set the starting scroll offset.\nThe default value is `{x: 0, y: 0}`.\n@platform ios"
},
"bounces": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view bounces when it reaches the end of the\ncontent if the content is larger then the scroll view along the axis of\nthe scroll direction. When false, it disables all bouncing even if\nthe `alwaysBounce*` props are true. The default value is true.\n@platform ios"
},
"bouncesZoom": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, gestures can drive zoom past min/max and the zoom will animate\nto the min/max value at gesture end, otherwise the zoom will not exceed\nthe limits.\n@platform ios"
},
"alwaysBounceHorizontal": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view bounces horizontally when it reaches the end\neven if the content is smaller than the scroll view itself. The default\nvalue is true when `horizontal={true}` and false otherwise.\n@platform ios"
},
"alwaysBounceVertical": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view bounces vertically when it reaches the end\neven if the content is smaller than the scroll view itself. The default\nvalue is false when `horizontal={true}` and true otherwise.\n@platform ios"
},
"centerContent": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view automatically centers the content when the\ncontent is smaller than the scroll view bounds; when the content is\nlarger than the scroll view, this property has no effect. The default\nvalue is false.\n@platform ios"
},
"contentContainerStyle": {
"type": {
"name": "custom",
"raw": "StyleSheetPropType(ViewStylePropTypes)"
},
"required": false,
"description": "These styles will be applied to the scroll view content container which\nwraps all of the child views. Example:\n\n return (\n <ScrollView contentContainerStyle={styles.contentContainer}>\n </ScrollView>\n );\n ...\n var styles = StyleSheet.create({\n contentContainer: {\n paddingVertical: 20\n }\n });"
},
"decelerationRate": {
"type": {
"name": "union",
"value": [
{
"name": "enum",
"value": [
{
"value": "'fast'",
"computed": false
},
{
"value": "'normal'",
"computed": false
}
]
},
{
"name": "number"
}
]
},
"required": false,
"description": "A floating-point number that determines how quickly the scroll view\ndecelerates after the user lifts their finger. You may also use string\nshortcuts `\"normal\"` and `\"fast\"` which match the underlying iOS settings\nfor `UIScrollViewDecelerationRateNormal` and\n`UIScrollViewDecelerationRateFast` respectively.\n - Normal: 0.998 (the default)\n - Fast: 0.9\n@platform ios"
},
"horizontal": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view's children are arranged horizontally in a row\ninstead of vertically in a column. The default value is false."
},
"indicatorStyle": {
"type": {
"name": "enum",
"value": [
{
"value": "'default'",
"computed": false
},
{
"value": "\"black\"",
"computed": false
},
{
"value": "'white'",
"computed": false
}
]
},
"required": false,
"description": "The style of the scroll indicators.\n - `default` (the default), same as `black`.\n - `black`, scroll indicator is black. This style is good against a white content background.\n - `white`, scroll indicator is white. This style is good against a black content background.\n@platform ios"
},
"directionalLockEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the ScrollView will try to lock to only vertical or horizontal\nscrolling while dragging. The default value is false.\n@platform ios"
},
"canCancelContentTouches": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, once tracking starts, won't try to drag if the touch moves.\nThe default value is true.\n@platform ios"
},
"keyboardDismissMode": {
"type": {
"name": "enum",
"value": [
{
"value": "'none'",
"computed": false
},
{
"value": "\"interactive\"",
"computed": false
},
{
"value": "'on-drag'",
"computed": false
}
]
},
"required": false,
"description": "Determines whether the keyboard gets dismissed in response to a drag.\n - 'none' (the default), drags do not dismiss the keyboard.\n - 'on-drag', the keyboard is dismissed when a drag begins.\n - 'interactive', the keyboard is dismissed interactively with the drag and moves in\n synchrony with the touch; dragging upwards cancels the dismissal.\n On android this is not supported and it will have the same behavior as 'none'."
},
"keyboardShouldPersistTaps": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, tapping outside of the focused text input when the keyboard\nis up dismisses the keyboard. When true, the scroll view will not catch\ntaps, and the keyboard will not dismiss automatically. The default value\nis false."
},
"maximumZoomScale": {
"type": {
"name": "number"
},
"required": false,
"description": "The maximum allowed zoom scale. The default value is 1.0.\n@platform ios"
},
"minimumZoomScale": {
"type": {
"name": "number"
},
"required": false,
"description": "The minimum allowed zoom scale. The default value is 1.0.\n@platform ios"
},
"onScroll": {
"type": {
"name": "func"
},
"required": false,
"description": "Fires at most once per frame during scrolling. The frequency of the\nevents can be controlled using the `scrollEventThrottle` prop."
},
"onScrollAnimationEnd": {
"type": {
"name": "func"
},
"required": false,
"description": "Called when a scrolling animation ends.\n@platform ios"
},
"onContentSizeChange": {
"type": {
"name": "func"
},
"required": false,
"description": "Called when scrollable content view of the ScrollView changes. It's\nimplemented using onLayout handler attached to the content container\nwhich this ScrollView renders."
},
"pagingEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view stops on multiples of the scroll view's size\nwhen scrolling. This can be used for horizontal pagination. The default\nvalue is false.\n@platform ios"
},
"scrollEnabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, the content does not scroll.\nThe default value is true."
},
"scrollEventThrottle": {
"type": {
"name": "number"
},
"required": false,
"description": "This controls how often the scroll event will be fired while scrolling\n(in events per seconds). A higher number yields better accuracy for code\nthat is tracking the scroll position, but can lead to scroll performance\nproblems due to the volume of information being send over the bridge.\nThe default value is zero, which means the scroll event will be sent\nonly once each time the view is scrolled.\n@platform ios"
},
"scrollIndicatorInsets": {
"type": {
"name": "custom",
"raw": "EdgeInsetsPropType"
},
"required": false,
"description": "The amount by which the scroll view indicators are inset from the edges\nof the scroll view. This should normally be set to the same value as\nthe `contentInset`. Defaults to `{0, 0, 0, 0}`.\n@platform ios"
},
"scrollsToTop": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, the scroll view scrolls to top when the status bar is tapped.\nThe default value is true.\n@platform ios"
},
"sendMomentumEvents": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, momentum events will be sent from Android\nThis is internal and set automatically by the framework if you have\nonMomentumScrollBegin or onMomentumScrollEnd set on your ScrollView\n@platform android"
},
"showsHorizontalScrollIndicator": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, shows a horizontal scroll indicator."
},
"showsVerticalScrollIndicator": {
"type": {
"name": "bool"
},
"required": false,
"description": "When true, shows a vertical scroll indicator."
},
"stickyHeaderIndices": {
"type": {
"name": "arrayOf",
"value": {
"name": "number"
}
},
"required": false,
"description": "An array of child indices determining which children get docked to the\ntop of the screen when scrolling. For example, passing\n`stickyHeaderIndices={[0]}` will cause the first child to be fixed to the\ntop of the scroll view. This property is not supported in conjunction\nwith `horizontal={true}`.\n@platform ios"
},
"style": {
"type": {
"name": "custom",
"raw": "StyleSheetPropType(ViewStylePropTypes)"
},
"required": false,
"description": ""
},
"snapToInterval": {
"type": {
"name": "number"
},
"required": false,
"description": "When set, causes the scroll view to stop at multiples of the value of\n`snapToInterval`. This can be used for paginating through children\nthat have lengths smaller than the scroll view. Used in combination\nwith `snapToAlignment`.\n@platform ios"
},
"snapToAlignment": {
"type": {
"name": "enum",
"value": [
{
"value": "'start'",
"computed": false
},
{
"value": "\"center\"",
"computed": false
},
{
"value": "'end'",
"computed": false
}
]
},
"required": false,
"description": "When `snapToInterval` is set, `snapToAlignment` will define the relationship\nof the snapping to the scroll view.\n - `start` (the default) will align the snap at the left (horizontal) or top (vertical)\n - `center` will align the snap in the center\n - `end` will align the snap at the right (horizontal) or bottom (vertical)\n@platform ios"
},
"removeClippedSubviews": {
"type": {
"name": "bool"
},
"required": false,
"description": "Experimental: When true, offscreen child views (whose `overflow` value is\n`hidden`) are removed from their native backing superview when offscreen.\nThis can improve scrolling performance on long lists. The default value is\ntrue."
},
"zoomScale": {
"type": {
"name": "number"
},
"required": false,
"description": "The current scale of the scroll view content. The default value is 1.0.\n@platform ios"
},
"refreshControl": {
"type": {
"name": "element"
},
"required": false,
"description": "A RefreshControl component, used to provide pull-to-refresh\nfunctionality for the ScrollView.\n\nSee [RefreshControl](docs/refreshcontrol.html)."
},
"onRefreshStart": {
"type": {
"name": "custom",
"raw": "deprecatedPropType(\n PropTypes.func,\n 'Use the `refreshControl` prop instead.'\n)"
},
"required": false,
"description": "@platform ios"