@tamagui/react-native-types 3.0.18 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/src/generated-legacy.d.ts +670 -2
- package/src/generated.d.ts +1146 -577
- package/src/legacy.d.ts +17 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* GENERATED by `bun run generate` from react-native 0.
|
|
2
|
+
* GENERATED by `bun run generate` from react-native 0.88.0. Do not edit.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
4
|
+
* 191 declarations reached from 25 roots, plus
|
|
5
5
|
* the AnimatedNode handle from its declaring module.
|
|
6
6
|
* Everything Tamagui uses from react-native's types on web lives here, so no
|
|
7
7
|
* non-`.native` file needs react-native installed. To refresh, bump the repo
|
|
@@ -877,6 +877,8 @@ export type FontVariant =
|
|
|
877
877
|
| 'stylistic-nineteen'
|
|
878
878
|
| 'stylistic-twenty'
|
|
879
879
|
|
|
880
|
+
export type FontVariationSettings = string | Readonly<Record<string, number>>
|
|
881
|
+
|
|
880
882
|
export interface GestureResponderEvent extends NativeSyntheticEvent<NativeTouchEvent> {}
|
|
881
883
|
|
|
882
884
|
export interface GestureResponderHandlers {
|
|
@@ -1678,6 +1680,41 @@ export interface NativePointerEvent extends NativeMouseEvent {
|
|
|
1678
1680
|
readonly isPrimary: boolean
|
|
1679
1681
|
}
|
|
1680
1682
|
|
|
1683
|
+
export interface NativeScrollEvent {
|
|
1684
|
+
contentInset: NativeScrollRectangle
|
|
1685
|
+
contentOffset: NativeScrollPoint
|
|
1686
|
+
contentSize: NativeScrollSize
|
|
1687
|
+
layoutMeasurement: NativeScrollSize
|
|
1688
|
+
velocity?: NativeScrollVelocity | undefined
|
|
1689
|
+
zoomScale: number
|
|
1690
|
+
/**
|
|
1691
|
+
* @platform ios
|
|
1692
|
+
*/
|
|
1693
|
+
targetContentOffset?: NativeScrollPoint | undefined
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
export interface NativeScrollPoint {
|
|
1697
|
+
x: number
|
|
1698
|
+
y: number
|
|
1699
|
+
}
|
|
1700
|
+
|
|
1701
|
+
export interface NativeScrollRectangle {
|
|
1702
|
+
left: number
|
|
1703
|
+
top: number
|
|
1704
|
+
bottom: number
|
|
1705
|
+
right: number
|
|
1706
|
+
}
|
|
1707
|
+
|
|
1708
|
+
export interface NativeScrollSize {
|
|
1709
|
+
height: number
|
|
1710
|
+
width: number
|
|
1711
|
+
}
|
|
1712
|
+
|
|
1713
|
+
export interface NativeScrollVelocity {
|
|
1714
|
+
x: number
|
|
1715
|
+
y: number
|
|
1716
|
+
}
|
|
1717
|
+
|
|
1681
1718
|
export interface NativeSyntheticEvent<T> extends React.BaseSyntheticEvent<
|
|
1682
1719
|
T,
|
|
1683
1720
|
HostInstance,
|
|
@@ -1844,6 +1881,11 @@ export interface PointerEvents {
|
|
|
1844
1881
|
onLostPointerCaptureCapture?: ((event: PointerEvent) => void) | undefined
|
|
1845
1882
|
}
|
|
1846
1883
|
|
|
1884
|
+
export interface PointProp {
|
|
1885
|
+
x: number
|
|
1886
|
+
y: number
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1847
1889
|
export interface PressableAndroidRippleConfig {
|
|
1848
1890
|
color?: null | ColorValue | undefined
|
|
1849
1891
|
borderless?: null | boolean | undefined
|
|
@@ -2102,6 +2144,63 @@ export interface RecursiveArray<T> extends Array<
|
|
|
2102
2144
|
T | ReadonlyArray<T> | RecursiveArray<T>
|
|
2103
2145
|
> {}
|
|
2104
2146
|
|
|
2147
|
+
export interface RefreshControlProps
|
|
2148
|
+
extends RefreshControlPropsIOS, RefreshControlPropsAndroid {
|
|
2149
|
+
/**
|
|
2150
|
+
* Called when the view starts refreshing.
|
|
2151
|
+
*/
|
|
2152
|
+
onRefresh?: (() => void) | undefined
|
|
2153
|
+
|
|
2154
|
+
/**
|
|
2155
|
+
* Whether the view should be indicating an active refresh.
|
|
2156
|
+
*/
|
|
2157
|
+
refreshing: boolean
|
|
2158
|
+
|
|
2159
|
+
/**
|
|
2160
|
+
* Progress view top offset
|
|
2161
|
+
*/
|
|
2162
|
+
progressViewOffset?: number | undefined
|
|
2163
|
+
}
|
|
2164
|
+
|
|
2165
|
+
export interface RefreshControlPropsAndroid extends ViewProps {
|
|
2166
|
+
/**
|
|
2167
|
+
* The colors (at least one) that will be used to draw the refresh indicator.
|
|
2168
|
+
*/
|
|
2169
|
+
colors?: ColorValue[] | undefined
|
|
2170
|
+
|
|
2171
|
+
/**
|
|
2172
|
+
* Whether the pull to refresh functionality is enabled.
|
|
2173
|
+
*/
|
|
2174
|
+
enabled?: boolean | undefined
|
|
2175
|
+
|
|
2176
|
+
/**
|
|
2177
|
+
* The background color of the refresh indicator.
|
|
2178
|
+
*/
|
|
2179
|
+
progressBackgroundColor?: ColorValue | undefined
|
|
2180
|
+
|
|
2181
|
+
/**
|
|
2182
|
+
* Size of the refresh indicator, see RefreshControl.SIZE.
|
|
2183
|
+
*/
|
|
2184
|
+
size?: 'default' | 'large' | undefined
|
|
2185
|
+
}
|
|
2186
|
+
|
|
2187
|
+
export interface RefreshControlPropsIOS extends ViewProps {
|
|
2188
|
+
/**
|
|
2189
|
+
* The color of the refresh indicator.
|
|
2190
|
+
*/
|
|
2191
|
+
tintColor?: ColorValue | undefined
|
|
2192
|
+
|
|
2193
|
+
/**
|
|
2194
|
+
* The title displayed under the refresh indicator.
|
|
2195
|
+
*/
|
|
2196
|
+
title?: string | undefined
|
|
2197
|
+
|
|
2198
|
+
/**
|
|
2199
|
+
* Title color.
|
|
2200
|
+
*/
|
|
2201
|
+
titleColor?: ColorValue | undefined
|
|
2202
|
+
}
|
|
2203
|
+
|
|
2105
2204
|
export type ReturnKeyType = 'done' | 'go' | 'next' | 'search' | 'send'
|
|
2106
2205
|
|
|
2107
2206
|
export type ReturnKeyTypeAndroid = 'none' | 'previous'
|
|
@@ -2218,6 +2317,564 @@ export interface ScaleYTransform {
|
|
|
2218
2317
|
scaleY: AnimatableNumericValue
|
|
2219
2318
|
}
|
|
2220
2319
|
|
|
2320
|
+
export type ScrollResponderType = ScrollViewImperativeMethods
|
|
2321
|
+
|
|
2322
|
+
export interface ScrollView extends ScrollViewImperativeMethods {}
|
|
2323
|
+
|
|
2324
|
+
export interface ScrollViewImperativeMethods {
|
|
2325
|
+
/**
|
|
2326
|
+
* Returns a reference to the underlying scroll responder, which supports
|
|
2327
|
+
* operations like `scrollTo`. All ScrollView-like components should
|
|
2328
|
+
* implement this method so that they can be composed while providing access
|
|
2329
|
+
* to the underlying scroll responder's methods.
|
|
2330
|
+
*/
|
|
2331
|
+
readonly getScrollResponder: () => ScrollResponderType
|
|
2332
|
+
readonly getScrollableNode: () => number | undefined
|
|
2333
|
+
readonly getInnerViewNode: () => number | undefined
|
|
2334
|
+
readonly getInnerViewRef: () => React.ComponentRef<typeof View> | null
|
|
2335
|
+
/**
|
|
2336
|
+
* Returns a reference to the underlying native scroll view, or null if the
|
|
2337
|
+
* native instance is not mounted.
|
|
2338
|
+
*/
|
|
2339
|
+
readonly getNativeScrollRef: () => HostInstance | null
|
|
2340
|
+
/**
|
|
2341
|
+
* Scrolls to a given x, y offset, either immediately or with a smooth animation.
|
|
2342
|
+
* Syntax:
|
|
2343
|
+
*
|
|
2344
|
+
* scrollTo(options: {x: number = 0; y: number = 0; animated: boolean = true})
|
|
2345
|
+
*
|
|
2346
|
+
* Note: The weird argument signature is due to the fact that, for historical reasons,
|
|
2347
|
+
* the function also accepts separate arguments as an alternative to the options object.
|
|
2348
|
+
* This is deprecated due to ambiguity (y before x), and SHOULD NOT BE USED.
|
|
2349
|
+
*/
|
|
2350
|
+
readonly scrollTo: (
|
|
2351
|
+
options?: ScrollViewScrollToOptions | number,
|
|
2352
|
+
deprecatedX?: number,
|
|
2353
|
+
deprecatedAnimated?: boolean
|
|
2354
|
+
) => void
|
|
2355
|
+
/**
|
|
2356
|
+
* A helper function that scrolls to the end of the scrollview;
|
|
2357
|
+
* If this is a vertical ScrollView, it scrolls to the bottom.
|
|
2358
|
+
* If this is a horizontal ScrollView scrolls to the right.
|
|
2359
|
+
*
|
|
2360
|
+
* The options object has an animated prop, that enables the scrolling animation or not.
|
|
2361
|
+
* The animated prop defaults to true
|
|
2362
|
+
*/
|
|
2363
|
+
readonly scrollToEnd: (options?: ScrollViewScrollToOptions | null) => void
|
|
2364
|
+
/**
|
|
2365
|
+
* Displays the scroll indicators momentarily.
|
|
2366
|
+
*/
|
|
2367
|
+
readonly flashScrollIndicators: () => void
|
|
2368
|
+
scrollResponderZoomTo(
|
|
2369
|
+
rect: {
|
|
2370
|
+
x: number
|
|
2371
|
+
y: number
|
|
2372
|
+
width: number
|
|
2373
|
+
height: number
|
|
2374
|
+
animated?: boolean | undefined
|
|
2375
|
+
},
|
|
2376
|
+
animated?: boolean // deprecated, put this inside the rect argument instead
|
|
2377
|
+
): void
|
|
2378
|
+
scrollResponderScrollNativeHandleToKeyboard(
|
|
2379
|
+
nodeHandle: number | HostInstance,
|
|
2380
|
+
additionalOffset?: number,
|
|
2381
|
+
preventNegativeScrollOffset?: boolean
|
|
2382
|
+
): void
|
|
2383
|
+
}
|
|
2384
|
+
|
|
2385
|
+
export interface ScrollViewProps
|
|
2386
|
+
extends ViewProps, ScrollViewPropsIOS, ScrollViewPropsAndroid, Touchable {
|
|
2387
|
+
/**
|
|
2388
|
+
* These styles will be applied to the scroll view content container which
|
|
2389
|
+
* wraps all of the child views. Example:
|
|
2390
|
+
*
|
|
2391
|
+
* return (
|
|
2392
|
+
* <ScrollView contentContainerStyle={styles.contentContainer}>
|
|
2393
|
+
* </ScrollView>
|
|
2394
|
+
* );
|
|
2395
|
+
* ...
|
|
2396
|
+
* const styles = StyleSheet.create({
|
|
2397
|
+
* contentContainer: {
|
|
2398
|
+
* paddingVertical: 20
|
|
2399
|
+
* }
|
|
2400
|
+
* });
|
|
2401
|
+
*/
|
|
2402
|
+
contentContainerStyle?: StyleProp<ViewStyle> | undefined
|
|
2403
|
+
|
|
2404
|
+
/**
|
|
2405
|
+
* A ref to the inner View element of the ScrollView. This should be used
|
|
2406
|
+
* instead of calling `getInnerViewRef`.
|
|
2407
|
+
*/
|
|
2408
|
+
innerViewRef?: React.RefObject<View> | undefined
|
|
2409
|
+
|
|
2410
|
+
/**
|
|
2411
|
+
* A ref to the Native ScrollView component. This ref can be used to call
|
|
2412
|
+
* all of ScrollView's public methods, in addition to native methods like
|
|
2413
|
+
* measure, measureLayout, etc.
|
|
2414
|
+
*/
|
|
2415
|
+
scrollViewRef?: React.RefObject<ScrollView> | undefined
|
|
2416
|
+
|
|
2417
|
+
/**
|
|
2418
|
+
* A floating-point number that determines how quickly the scroll view
|
|
2419
|
+
* decelerates after the user lifts their finger. You may also use string
|
|
2420
|
+
* shortcuts `"normal"` and `"fast"` which match the underlying iOS settings
|
|
2421
|
+
* for `UIScrollViewDecelerationRateNormal` and
|
|
2422
|
+
* `UIScrollViewDecelerationRateFast` respectively.
|
|
2423
|
+
*
|
|
2424
|
+
* - `'normal'`: 0.998 on iOS, 0.985 on Android (the default)
|
|
2425
|
+
* - `'fast'`: 0.99 on iOS, 0.9 on Android
|
|
2426
|
+
*/
|
|
2427
|
+
decelerationRate?: 'fast' | 'normal' | number | undefined
|
|
2428
|
+
|
|
2429
|
+
/**
|
|
2430
|
+
* When true the scroll view's children are arranged horizontally in a row
|
|
2431
|
+
* instead of vertically in a column. The default value is false.
|
|
2432
|
+
*/
|
|
2433
|
+
horizontal?: boolean | null | undefined
|
|
2434
|
+
|
|
2435
|
+
/**
|
|
2436
|
+
* If sticky headers should stick at the bottom instead of the top of the
|
|
2437
|
+
* ScrollView. This is usually used with inverted ScrollViews.
|
|
2438
|
+
*/
|
|
2439
|
+
invertStickyHeaders?: boolean | undefined
|
|
2440
|
+
|
|
2441
|
+
/**
|
|
2442
|
+
* Determines whether the keyboard gets dismissed in response to a drag.
|
|
2443
|
+
* - 'none' (the default) drags do not dismiss the keyboard.
|
|
2444
|
+
* - 'onDrag' the keyboard is dismissed when a drag begins.
|
|
2445
|
+
* - 'interactive' the keyboard is dismissed interactively with the drag
|
|
2446
|
+
* and moves in synchrony with the touch; dragging upwards cancels the
|
|
2447
|
+
* dismissal.
|
|
2448
|
+
*/
|
|
2449
|
+
keyboardDismissMode?: 'none' | 'interactive' | 'on-drag' | undefined
|
|
2450
|
+
|
|
2451
|
+
/**
|
|
2452
|
+
* Determines when the keyboard should stay visible after a tap.
|
|
2453
|
+
* - 'never' (the default), tapping outside of the focused text input when the keyboard is up dismisses the keyboard. When this happens, children won't receive the tap.
|
|
2454
|
+
* - 'always', the keyboard will not dismiss automatically, and the scroll view will not catch taps, but children of the scroll view can catch taps.
|
|
2455
|
+
* - 'handled', the keyboard will not dismiss automatically when the tap was handled by a children, (or captured by an ancestor).
|
|
2456
|
+
*/
|
|
2457
|
+
keyboardShouldPersistTaps?: 'always' | 'never' | 'handled' | undefined
|
|
2458
|
+
|
|
2459
|
+
/**
|
|
2460
|
+
* Called when scrollable content view of the ScrollView changes.
|
|
2461
|
+
* Handler function is passed the content width and content height as parameters: (contentWidth, contentHeight)
|
|
2462
|
+
* It's implemented using onLayout handler attached to the content container which this ScrollView renders.
|
|
2463
|
+
*
|
|
2464
|
+
*/
|
|
2465
|
+
onContentSizeChange?:
|
|
2466
|
+
| ((contentWidth: number, contentHeight: number) => void)
|
|
2467
|
+
| undefined
|
|
2468
|
+
|
|
2469
|
+
/**
|
|
2470
|
+
* Fires at most once per frame during scrolling.
|
|
2471
|
+
*/
|
|
2472
|
+
onScroll?: ((event: NativeSyntheticEvent<NativeScrollEvent>) => void) | undefined
|
|
2473
|
+
|
|
2474
|
+
/**
|
|
2475
|
+
* Fires if a user initiates a scroll gesture.
|
|
2476
|
+
*/
|
|
2477
|
+
onScrollBeginDrag?:
|
|
2478
|
+
| ((event: NativeSyntheticEvent<NativeScrollEvent>) => void)
|
|
2479
|
+
| undefined
|
|
2480
|
+
|
|
2481
|
+
/**
|
|
2482
|
+
* Fires when a user has finished scrolling.
|
|
2483
|
+
*/
|
|
2484
|
+
onScrollEndDrag?: ((event: NativeSyntheticEvent<NativeScrollEvent>) => void) | undefined
|
|
2485
|
+
|
|
2486
|
+
/**
|
|
2487
|
+
* Fires when scroll view has finished moving
|
|
2488
|
+
*/
|
|
2489
|
+
onMomentumScrollEnd?:
|
|
2490
|
+
| ((event: NativeSyntheticEvent<NativeScrollEvent>) => void)
|
|
2491
|
+
| undefined
|
|
2492
|
+
|
|
2493
|
+
/**
|
|
2494
|
+
* Fires when scroll view has begun moving
|
|
2495
|
+
*/
|
|
2496
|
+
onMomentumScrollBegin?:
|
|
2497
|
+
| ((event: NativeSyntheticEvent<NativeScrollEvent>) => void)
|
|
2498
|
+
| undefined
|
|
2499
|
+
|
|
2500
|
+
/**
|
|
2501
|
+
* When true the scroll view stops on multiples of the scroll view's size
|
|
2502
|
+
* when scrolling. This can be used for horizontal pagination. The default
|
|
2503
|
+
* value is false.
|
|
2504
|
+
*/
|
|
2505
|
+
pagingEnabled?: boolean | undefined
|
|
2506
|
+
|
|
2507
|
+
/**
|
|
2508
|
+
* When false, the content does not scroll. The default value is true
|
|
2509
|
+
*/
|
|
2510
|
+
scrollEnabled?: boolean | undefined // true
|
|
2511
|
+
|
|
2512
|
+
/**
|
|
2513
|
+
* Experimental: When true offscreen child views (whose `overflow` value is
|
|
2514
|
+
* `hidden`) are removed from their native backing superview when offscreen.
|
|
2515
|
+
* This can improve scrolling performance on long lists. The default value is
|
|
2516
|
+
* false.
|
|
2517
|
+
*/
|
|
2518
|
+
removeClippedSubviews?: boolean | undefined
|
|
2519
|
+
|
|
2520
|
+
/**
|
|
2521
|
+
* When true, shows a horizontal scroll indicator.
|
|
2522
|
+
*/
|
|
2523
|
+
showsHorizontalScrollIndicator?: boolean | undefined
|
|
2524
|
+
|
|
2525
|
+
/**
|
|
2526
|
+
* When true, shows a vertical scroll indicator.
|
|
2527
|
+
*/
|
|
2528
|
+
showsVerticalScrollIndicator?: boolean | undefined
|
|
2529
|
+
|
|
2530
|
+
/**
|
|
2531
|
+
* When true, Sticky header is hidden when scrolling down, and dock at the top when scrolling up.
|
|
2532
|
+
*/
|
|
2533
|
+
stickyHeaderHiddenOnScroll?: boolean | undefined
|
|
2534
|
+
|
|
2535
|
+
/**
|
|
2536
|
+
* Style
|
|
2537
|
+
*/
|
|
2538
|
+
style?: StyleProp<ViewStyle> | undefined
|
|
2539
|
+
|
|
2540
|
+
/**
|
|
2541
|
+
* A RefreshControl component, used to provide pull-to-refresh
|
|
2542
|
+
* functionality for the ScrollView.
|
|
2543
|
+
*/
|
|
2544
|
+
refreshControl?: React.ReactElement<RefreshControlProps> | undefined
|
|
2545
|
+
|
|
2546
|
+
/**
|
|
2547
|
+
* When set, causes the scroll view to stop at multiples of the value of `snapToInterval`.
|
|
2548
|
+
* This can be used for paginating through children that have lengths smaller than the scroll view.
|
|
2549
|
+
* Used in combination with `snapToAlignment` and `decelerationRate="fast"`. Overrides less
|
|
2550
|
+
* configurable `pagingEnabled` prop.
|
|
2551
|
+
*/
|
|
2552
|
+
snapToInterval?: number | undefined
|
|
2553
|
+
|
|
2554
|
+
/**
|
|
2555
|
+
* When set, causes the scroll view to stop at the defined offsets. This can be used for
|
|
2556
|
+
* paginating through variously sized children that have lengths smaller than the scroll view.
|
|
2557
|
+
* Typically used in combination with `decelerationRate="fast"`. Overrides less configurable
|
|
2558
|
+
* `pagingEnabled` and `snapToInterval` props.
|
|
2559
|
+
*/
|
|
2560
|
+
snapToOffsets?: number[] | undefined
|
|
2561
|
+
|
|
2562
|
+
/**
|
|
2563
|
+
* Use in conjunction with `snapToOffsets`. By default, the beginning of the list counts as a
|
|
2564
|
+
* snap offset. Set `snapToStart` to false to disable this behavior and allow the list to scroll
|
|
2565
|
+
* freely between its start and the first `snapToOffsets` offset. The default value is true.
|
|
2566
|
+
*/
|
|
2567
|
+
snapToStart?: boolean | undefined
|
|
2568
|
+
|
|
2569
|
+
/**
|
|
2570
|
+
* Use in conjunction with `snapToOffsets`. By default, the end of the list counts as a snap
|
|
2571
|
+
* offset. Set `snapToEnd` to false to disable this behavior and allow the list to scroll freely
|
|
2572
|
+
* between its end and the last `snapToOffsets` offset. The default value is true.
|
|
2573
|
+
*/
|
|
2574
|
+
snapToEnd?: boolean | undefined
|
|
2575
|
+
|
|
2576
|
+
/**
|
|
2577
|
+
* An array of child indices determining which children get docked to the
|
|
2578
|
+
* top of the screen when scrolling. For example passing
|
|
2579
|
+
* `stickyHeaderIndices={[0]}` will cause the first child to be fixed to the
|
|
2580
|
+
* top of the scroll view. This property is not supported in conjunction
|
|
2581
|
+
* with `horizontal={true}`.
|
|
2582
|
+
*/
|
|
2583
|
+
stickyHeaderIndices?: number[] | undefined
|
|
2584
|
+
|
|
2585
|
+
/**
|
|
2586
|
+
* When true, the scroll view stops on the next index (in relation to scroll position at release)
|
|
2587
|
+
* regardless of how fast the gesture is. This can be used for horizontal pagination when the page
|
|
2588
|
+
* is less than the width of the ScrollView. The default value is false.
|
|
2589
|
+
*/
|
|
2590
|
+
disableIntervalMomentum?: boolean | undefined
|
|
2591
|
+
|
|
2592
|
+
/**
|
|
2593
|
+
* When true, the default JS pan responder on the ScrollView is disabled, and full control over
|
|
2594
|
+
* touches inside the ScrollView is left to its child components. This is particularly useful
|
|
2595
|
+
* if `snapToInterval` is enabled, since it does not follow typical touch patterns. Do not use
|
|
2596
|
+
* this on regular ScrollView use cases without `snapToInterval` as it may cause unexpected
|
|
2597
|
+
* touches to occur while scrolling. The default value is false.
|
|
2598
|
+
*/
|
|
2599
|
+
disableScrollViewPanResponder?: boolean | undefined
|
|
2600
|
+
|
|
2601
|
+
/**
|
|
2602
|
+
* A React Component that will be used to render sticky headers, should be used together with
|
|
2603
|
+
* stickyHeaderIndices. You may need to set this component if your sticky header uses custom
|
|
2604
|
+
* transforms, for example, when you want your list to have an animated and hidable header.
|
|
2605
|
+
* If component have not been provided, the default ScrollViewStickyHeader component will be used.
|
|
2606
|
+
*/
|
|
2607
|
+
StickyHeaderComponent?: React.ComponentType<any> | undefined
|
|
2608
|
+
}
|
|
2609
|
+
|
|
2610
|
+
export interface ScrollViewPropsAndroid {
|
|
2611
|
+
/**
|
|
2612
|
+
* Sometimes a scrollview takes up more space than its content fills.
|
|
2613
|
+
* When this is the case, this prop will fill the rest of the
|
|
2614
|
+
* scrollview with a color to avoid setting a background and creating
|
|
2615
|
+
* unnecessary overdraw. This is an advanced optimization that is not
|
|
2616
|
+
* needed in the general case.
|
|
2617
|
+
*/
|
|
2618
|
+
endFillColor?: ColorValue | undefined
|
|
2619
|
+
|
|
2620
|
+
/**
|
|
2621
|
+
* Tag used to log scroll performance on this scroll view. Will force
|
|
2622
|
+
* momentum events to be turned on (see sendMomentumEvents). This doesn't do
|
|
2623
|
+
* anything out of the box and you need to implement a custom native
|
|
2624
|
+
* FpsListener for it to be useful.
|
|
2625
|
+
* @platform android
|
|
2626
|
+
*/
|
|
2627
|
+
scrollPerfTag?: string | undefined
|
|
2628
|
+
|
|
2629
|
+
/**
|
|
2630
|
+
* Used to override default value of overScroll mode.
|
|
2631
|
+
|
|
2632
|
+
* Possible values:
|
|
2633
|
+
* - 'auto' - Default value, allow a user to over-scroll this view only if the content is large enough to meaningfully scroll.
|
|
2634
|
+
* - 'always' - Always allow a user to over-scroll this view.
|
|
2635
|
+
* - 'never' - Never allow a user to over-scroll this view.
|
|
2636
|
+
*/
|
|
2637
|
+
overScrollMode?: 'auto' | 'always' | 'never' | undefined
|
|
2638
|
+
|
|
2639
|
+
/**
|
|
2640
|
+
* Enables nested scrolling for Android API level 21+. Nested scrolling is supported by default on iOS.
|
|
2641
|
+
*/
|
|
2642
|
+
nestedScrollEnabled?: boolean | undefined
|
|
2643
|
+
|
|
2644
|
+
/**
|
|
2645
|
+
* Controls the fading effect at the edges of the scroll content.
|
|
2646
|
+
*
|
|
2647
|
+
* A value greater than 0 will apply the fading effect, indicating more content is available
|
|
2648
|
+
* to scroll.
|
|
2649
|
+
*
|
|
2650
|
+
* You can specify a single number to apply the same fading length to both edges.
|
|
2651
|
+
* Alternatively, use an object with `start` and `end` properties to set different
|
|
2652
|
+
* fading lengths for the start and end of the scroll content.
|
|
2653
|
+
*
|
|
2654
|
+
* The default value is 0.
|
|
2655
|
+
*
|
|
2656
|
+
* @platform android
|
|
2657
|
+
*/
|
|
2658
|
+
fadingEdgeLength?: number | { start: number; end: number } | undefined
|
|
2659
|
+
|
|
2660
|
+
/**
|
|
2661
|
+
* Causes the scrollbars not to turn transparent when they are not in use. The default value is false.
|
|
2662
|
+
*/
|
|
2663
|
+
persistentScrollbar?: boolean | undefined
|
|
2664
|
+
|
|
2665
|
+
/**
|
|
2666
|
+
* When false, the ScrollView will not automatically scroll to a focused child when
|
|
2667
|
+
* the child requests focus. This can be useful when you want to control the scroll
|
|
2668
|
+
* position programmatically. The default value is true.
|
|
2669
|
+
*
|
|
2670
|
+
* @platform android
|
|
2671
|
+
*/
|
|
2672
|
+
scrollsChildToFocus?: boolean | undefined
|
|
2673
|
+
}
|
|
2674
|
+
|
|
2675
|
+
export interface ScrollViewPropsIOS {
|
|
2676
|
+
/**
|
|
2677
|
+
* When true the scroll view bounces horizontally when it reaches the end
|
|
2678
|
+
* even if the content is smaller than the scroll view itself. The default
|
|
2679
|
+
* value is true when `horizontal={true}` and false otherwise.
|
|
2680
|
+
*/
|
|
2681
|
+
alwaysBounceHorizontal?: boolean | undefined
|
|
2682
|
+
/**
|
|
2683
|
+
* When true the scroll view bounces vertically when it reaches the end
|
|
2684
|
+
* even if the content is smaller than the scroll view itself. The default
|
|
2685
|
+
* value is false when `horizontal={true}` and true otherwise.
|
|
2686
|
+
*/
|
|
2687
|
+
alwaysBounceVertical?: boolean | undefined
|
|
2688
|
+
|
|
2689
|
+
/**
|
|
2690
|
+
* Controls whether iOS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/ toolbar.
|
|
2691
|
+
* The default value is true.
|
|
2692
|
+
*/
|
|
2693
|
+
automaticallyAdjustContentInsets?: boolean | undefined // true
|
|
2694
|
+
|
|
2695
|
+
/**
|
|
2696
|
+
* Controls whether the ScrollView should automatically adjust its contentInset and
|
|
2697
|
+
* scrollViewInsets when the Keyboard changes its size. The default value is false.
|
|
2698
|
+
*/
|
|
2699
|
+
automaticallyAdjustKeyboardInsets?: boolean | undefined
|
|
2700
|
+
|
|
2701
|
+
/**
|
|
2702
|
+
* Controls whether iOS should automatically adjust the scroll indicator
|
|
2703
|
+
* insets. The default value is true. Available on iOS 13 and later.
|
|
2704
|
+
*/
|
|
2705
|
+
automaticallyAdjustsScrollIndicatorInsets?: boolean | undefined
|
|
2706
|
+
|
|
2707
|
+
/**
|
|
2708
|
+
* When true the scroll view bounces when it reaches the end of the
|
|
2709
|
+
* content if the content is larger than the scroll view along the axis of
|
|
2710
|
+
* the scroll direction. When false it disables all bouncing even if
|
|
2711
|
+
* the `alwaysBounce*` props are true. The default value is true.
|
|
2712
|
+
*/
|
|
2713
|
+
bounces?: boolean | undefined
|
|
2714
|
+
/**
|
|
2715
|
+
* When true gestures can drive zoom past min/max and the zoom will animate
|
|
2716
|
+
* to the min/max value at gesture end otherwise the zoom will not exceed
|
|
2717
|
+
* the limits.
|
|
2718
|
+
*/
|
|
2719
|
+
bouncesZoom?: boolean | undefined
|
|
2720
|
+
|
|
2721
|
+
/**
|
|
2722
|
+
* When false once tracking starts won't try to drag if the touch moves.
|
|
2723
|
+
* The default value is true.
|
|
2724
|
+
*/
|
|
2725
|
+
canCancelContentTouches?: boolean | undefined
|
|
2726
|
+
|
|
2727
|
+
/**
|
|
2728
|
+
* When true the scroll view automatically centers the content when the
|
|
2729
|
+
* content is smaller than the scroll view bounds; when the content is
|
|
2730
|
+
* larger than the scroll view this property has no effect. The default
|
|
2731
|
+
* value is false.
|
|
2732
|
+
*/
|
|
2733
|
+
centerContent?: boolean | undefined
|
|
2734
|
+
|
|
2735
|
+
/**
|
|
2736
|
+
* The amount by which the scroll view content is inset from the edges of the scroll view.
|
|
2737
|
+
* Defaults to {0, 0, 0, 0}.
|
|
2738
|
+
*/
|
|
2739
|
+
contentInset?: Insets | undefined // zeros
|
|
2740
|
+
|
|
2741
|
+
/**
|
|
2742
|
+
* Used to manually set the starting scroll offset.
|
|
2743
|
+
* The default value is {x: 0, y: 0}
|
|
2744
|
+
*/
|
|
2745
|
+
contentOffset?: PointProp | undefined // zeros
|
|
2746
|
+
|
|
2747
|
+
/**
|
|
2748
|
+
* This property specifies how the safe area insets are used to modify the content area of the scroll view.
|
|
2749
|
+
* The default value of this property is "never".
|
|
2750
|
+
*/
|
|
2751
|
+
contentInsetAdjustmentBehavior?:
|
|
2752
|
+
| 'automatic'
|
|
2753
|
+
| 'scrollableAxes'
|
|
2754
|
+
| 'never'
|
|
2755
|
+
| 'always'
|
|
2756
|
+
| undefined
|
|
2757
|
+
|
|
2758
|
+
/**
|
|
2759
|
+
* When true the ScrollView will try to lock to only vertical or horizontal
|
|
2760
|
+
* scrolling while dragging. The default value is false.
|
|
2761
|
+
*/
|
|
2762
|
+
directionalLockEnabled?: boolean | undefined
|
|
2763
|
+
|
|
2764
|
+
/**
|
|
2765
|
+
* The style of the scroll indicators.
|
|
2766
|
+
* - default (the default), same as black.
|
|
2767
|
+
* - black, scroll indicator is black. This style is good against
|
|
2768
|
+
* a white content background.
|
|
2769
|
+
* - white, scroll indicator is white. This style is good against
|
|
2770
|
+
* a black content background.
|
|
2771
|
+
*/
|
|
2772
|
+
indicatorStyle?: 'default' | 'black' | 'white' | undefined
|
|
2773
|
+
|
|
2774
|
+
/**
|
|
2775
|
+
* When set, the scroll view will adjust the scroll position so that the first child
|
|
2776
|
+
* that is currently visible and at or beyond minIndexForVisible will not change position.
|
|
2777
|
+
* This is useful for lists that are loading content in both directions, e.g. a chat thread,
|
|
2778
|
+
* where new messages coming in might otherwise cause the scroll position to jump. A value
|
|
2779
|
+
* of 0 is common, but other values such as 1 can be used to skip loading spinners or other
|
|
2780
|
+
* content that should not maintain position.
|
|
2781
|
+
*
|
|
2782
|
+
* The optional autoscrollToTopThreshold can be used to make the content automatically scroll
|
|
2783
|
+
* to the top after making the adjustment if the user was within the threshold of the top
|
|
2784
|
+
* before the adjustment was made. This is also useful for chat-like applications where you
|
|
2785
|
+
* want to see new messages scroll into place, but not if the user has scrolled up a ways and
|
|
2786
|
+
* it would be disruptive to scroll a bunch.
|
|
2787
|
+
*
|
|
2788
|
+
* Caveat 1: Reordering elements in the scrollview with this enabled will probably cause
|
|
2789
|
+
* jumpiness and jank. It can be fixed, but there are currently no plans to do so. For now,
|
|
2790
|
+
* don't re-order the content of any ScrollViews or Lists that use this feature.
|
|
2791
|
+
*
|
|
2792
|
+
* Caveat 2: This uses contentOffset and frame.origin in native code to compute visibility.
|
|
2793
|
+
* Occlusion, transforms, and other complexity won't be taken into account as to whether
|
|
2794
|
+
* content is "visible" or not.
|
|
2795
|
+
*/
|
|
2796
|
+
maintainVisibleContentPosition?:
|
|
2797
|
+
| null
|
|
2798
|
+
| {
|
|
2799
|
+
autoscrollToTopThreshold?: number | null | undefined
|
|
2800
|
+
minIndexForVisible: number
|
|
2801
|
+
}
|
|
2802
|
+
| undefined
|
|
2803
|
+
/**
|
|
2804
|
+
* The maximum allowed zoom scale. The default value is 1.0.
|
|
2805
|
+
*/
|
|
2806
|
+
maximumZoomScale?: number | undefined
|
|
2807
|
+
|
|
2808
|
+
/**
|
|
2809
|
+
* The minimum allowed zoom scale. The default value is 1.0.
|
|
2810
|
+
*/
|
|
2811
|
+
minimumZoomScale?: number | undefined
|
|
2812
|
+
|
|
2813
|
+
/**
|
|
2814
|
+
* Called when a scrolling animation ends.
|
|
2815
|
+
*/
|
|
2816
|
+
onScrollAnimationEnd?: (() => void) | undefined
|
|
2817
|
+
|
|
2818
|
+
/**
|
|
2819
|
+
* When true, ScrollView allows use of pinch gestures to zoom in and out.
|
|
2820
|
+
* The default value is true.
|
|
2821
|
+
*/
|
|
2822
|
+
pinchGestureEnabled?: boolean | undefined
|
|
2823
|
+
|
|
2824
|
+
/**
|
|
2825
|
+
* Limits how often scroll events will be fired while scrolling, specified as
|
|
2826
|
+
* a time interval in ms. This may be useful when expensive work is performed
|
|
2827
|
+
* in response to scrolling. Values <= `16` will disable throttling,
|
|
2828
|
+
* regardless of the refresh rate of the device.
|
|
2829
|
+
*/
|
|
2830
|
+
scrollEventThrottle?: number | undefined
|
|
2831
|
+
|
|
2832
|
+
/**
|
|
2833
|
+
* The amount by which the scroll view indicators are inset from the edges of the scroll view.
|
|
2834
|
+
* This should normally be set to the same value as the contentInset.
|
|
2835
|
+
* Defaults to {0, 0, 0, 0}.
|
|
2836
|
+
*/
|
|
2837
|
+
scrollIndicatorInsets?: Insets | undefined //zeroes
|
|
2838
|
+
|
|
2839
|
+
/**
|
|
2840
|
+
* When true, the scroll view can be programmatically scrolled beyond its
|
|
2841
|
+
* content size. The default value is false.
|
|
2842
|
+
* @platform ios
|
|
2843
|
+
*/
|
|
2844
|
+
scrollToOverflowEnabled?: boolean | undefined
|
|
2845
|
+
|
|
2846
|
+
/**
|
|
2847
|
+
* When true the scroll view scrolls to top when the status bar is tapped.
|
|
2848
|
+
* The default value is true.
|
|
2849
|
+
*/
|
|
2850
|
+
scrollsToTop?: boolean | undefined
|
|
2851
|
+
|
|
2852
|
+
/**
|
|
2853
|
+
* When `snapToInterval` is set, `snapToAlignment` will define the relationship of the snapping to the scroll view.
|
|
2854
|
+
* - `start` (the default) will align the snap at the left (horizontal) or top (vertical)
|
|
2855
|
+
* - `center` will align the snap in the center
|
|
2856
|
+
* - `end` will align the snap at the right (horizontal) or bottom (vertical)
|
|
2857
|
+
*/
|
|
2858
|
+
snapToAlignment?: 'start' | 'center' | 'end' | undefined
|
|
2859
|
+
|
|
2860
|
+
/**
|
|
2861
|
+
* Fires when the scroll view scrolls to top after the status bar has been tapped
|
|
2862
|
+
* @platform ios
|
|
2863
|
+
*/
|
|
2864
|
+
onScrollToTop?: ((event: NativeSyntheticEvent<NativeScrollEvent>) => void) | undefined
|
|
2865
|
+
|
|
2866
|
+
/**
|
|
2867
|
+
* The current scale of the scroll view content. The default value is 1.0.
|
|
2868
|
+
*/
|
|
2869
|
+
zoomScale?: number | undefined
|
|
2870
|
+
}
|
|
2871
|
+
|
|
2872
|
+
export interface ScrollViewScrollToOptions {
|
|
2873
|
+
x?: number | undefined
|
|
2874
|
+
y?: number | undefined
|
|
2875
|
+
animated?: boolean | undefined
|
|
2876
|
+
}
|
|
2877
|
+
|
|
2221
2878
|
export interface ShadowStyleIOS {
|
|
2222
2879
|
shadowColor?: ColorValue | undefined
|
|
2223
2880
|
shadowOffset?: Readonly<{ width: number; height: number }> | undefined
|
|
@@ -3140,6 +3797,7 @@ export type TextInputScrollEvent = NativeSyntheticEvent<TextInputScrollEventData
|
|
|
3140
3797
|
|
|
3141
3798
|
export interface TextInputScrollEventData {
|
|
3142
3799
|
contentOffset: { x: number; y: number }
|
|
3800
|
+
responderIgnoreScroll?: boolean | undefined
|
|
3143
3801
|
}
|
|
3144
3802
|
|
|
3145
3803
|
export type TextInputSelectionChangeEvent =
|
|
@@ -3433,6 +4091,13 @@ export interface TextStyle extends TextStyleIOS, TextStyleAndroid, ViewStyle {
|
|
|
3433
4091
|
| 'heavy'
|
|
3434
4092
|
| 'black'
|
|
3435
4093
|
| undefined
|
|
4094
|
+
/**
|
|
4095
|
+
* Specifies OpenType font variation axis values using CSS syntax or an
|
|
4096
|
+
* object keyed by four-character axis tags. An empty string or object resets
|
|
4097
|
+
* inherited variation settings. On Android, this requires API level 26 or
|
|
4098
|
+
* later.
|
|
4099
|
+
*/
|
|
4100
|
+
fontVariationSettings?: FontVariationSettings | undefined
|
|
3436
4101
|
letterSpacing?: number | undefined
|
|
3437
4102
|
lineHeight?: number | undefined
|
|
3438
4103
|
textAlign?:
|
|
@@ -3828,11 +4493,14 @@ export interface ViewStyle extends FlexStyle, ShadowStyleIOS, TransformsStyle {
|
|
|
3828
4493
|
mixBlendMode?: BlendMode | undefined
|
|
3829
4494
|
backgroundImage?: ReadonlyArray<BackgroundImageValue> | string | undefined
|
|
3830
4495
|
experimental_backgroundImage?: ReadonlyArray<BackgroundImageValue> | string | undefined
|
|
4496
|
+
backgroundSize?: ReadonlyArray<BackgroundSizeValue> | string | undefined
|
|
3831
4497
|
experimental_backgroundSize?: ReadonlyArray<BackgroundSizeValue> | string | undefined
|
|
4498
|
+
backgroundPosition?: ReadonlyArray<BackgroundPositionValue> | string | undefined
|
|
3832
4499
|
experimental_backgroundPosition?:
|
|
3833
4500
|
| ReadonlyArray<BackgroundPositionValue>
|
|
3834
4501
|
| string
|
|
3835
4502
|
| undefined
|
|
4503
|
+
backgroundRepeat?: ReadonlyArray<BackgroundRepeatValue> | string | undefined
|
|
3836
4504
|
experimental_backgroundRepeat?:
|
|
3837
4505
|
| ReadonlyArray<BackgroundRepeatValue>
|
|
3838
4506
|
| string
|