flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

React Native add missing maintainVisibleContentPosition type for ScrollView on iOS (#48114)

Browse Source 
* add missing type for ScrollView maintainVisibleContentPosition on iOS

* add test

* Apply suggestions from code review

Co-authored-by: Eloy Durán <eloy.de.enige@gmail.com>

Co-authored-by: Vir Desai <virdesai@virs-mbp.lan>
Co-authored-by: Eloy Durán <eloy.de.enige@gmail.com>
This commit is contained in:
Vir Desai 2020-09-24 09:42:03 -04:00 committed by GitHub
parent f8b43fbb7e
commit 09baa919ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
types/react-native/index.d.ts vendored
View File

@ -6504,6 +6504,32 @@ export interface ScrollViewPropsIOS {
*/
indicatorStyle?: 'default' | 'black' | 'white';
/**
* When set, the scroll view will adjust the scroll position so that the first child
* that is currently visible and at or beyond minIndexForVisible will not change position.
* This is useful for lists that are loading content in both directions, e.g. a chat thread,
* where new messages coming in might otherwise cause the scroll position to jump. A value
* of 0 is common, but other values such as 1 can be used to skip loading spinners or other
* content that should not maintain position.
*
* The optional autoscrollToTopThreshold can be used to make the content automatically scroll
* to the top after making the adjustment if the user was within the threshold of the top
* before the adjustment was made. This is also useful for chat-like applications where you
* want to see new messages scroll into place, but not if the user has scrolled up a ways and
* it would be disruptive to scroll a bunch.
*
* Caveat 1: Reordering elements in the scrollview with this enabled will probably cause
* jumpiness and jank. It can be fixed, but there are currently no plans to do so. For now,
* don't re-order the content of any ScrollViews or Lists that use this feature.
*
* Caveat 2: This uses contentOffset and frame.origin in native code to compute visibility.
* Occlusion, transforms, and other complexity won't be taken into account as to whether
* content is "visible" or not.
*/
maintainVisibleContentPosition?: null | {
autoscrollToTopThreshold?: number | null;
minIndexForVisible: number;
};
/**
* The maximum allowed zoom scale. The default value is 1.0.
*/

11
types/react-native/test/index.tsx
View File

@ -611,7 +611,7 @@ class ScrollerListComponentTest extends React.Component<{}, { dataSource: ListVi
if (this.scrollView) {
this.scrollView.setNativeProps({ scrollEnabled: false });
// Dummy values for scroll dimenions changes
// Dummy values for scroll dimensions changes
this.scrollView.getScrollResponder().scrollResponderZoomTo({
x: 0,
y: 0,
@ -1044,7 +1044,7 @@ class AccessibilityTest extends React.Component {
onAccessibilityTap={() => {}}
accessibilityRole="header"
accessibilityState={{ checked: true }}
accessibilityHint="Very importent header"
accessibilityHint="Very important header"
accessibilityValue={{ min: 60, max: 120, now: 80 }}
onMagicTap={() => {}}
onAccessibilityEscape={() => {}}
@ -1179,6 +1179,11 @@ const NativeIDTest = () => (
</ScrollView>
);
const ScrollViewMaintainVisibleContentPositionTest = () => (
<ScrollView maintainVisibleContentPosition={{ autoscrollToTopThreshold: 1, minIndexForVisible: 10 }}>
</ScrollView>
);
const MaxFontSizeMultiplierTest = () => <Text maxFontSizeMultiplier={0}>Text</Text>;
const ShareTest = () => {
@ -1301,7 +1306,7 @@ const OpaqueTest2 = () => (
/>
);
// Test you cannot ammend opaque type
// Test you cannot amend opaque type
PlatformColor('?attr/colorControlNormal').resource_paths.push('foo'); // $ExpectError
const someColorProp: ColorValue = PlatformColor('test');