mirror of https://github.com/facebook/react-native.git synced 2025-11-01 09:14:26 +00:00

Files

T

Michael Lohmann 35f5c3a204 VirtualizedList/FlatList: Stricter typing for onViewableItemsChanged (#42773 )

Summary:
The previous typing of FlatList and VirtualizedList did not convey any information on the type of the items passed in to `onViewableItemsChanged`, but instead the type was set to `any`. This PR adds the type information.

I set a default type `any` for thy ViewToken, because the type is exported and not having it would be a breaking change if that type is used. Like this it gracefully falls back to the default behavior of the `any` type.

Notice: I don't know how typing in "flow" works, but the same "issue" seems to be in there as well. Maybe someone with more flow experience can fix that as well:
https://github.com/facebook/react-native/blob/ae42e0202de2c3db489caf63839fced7b52efc5d/packages/virtualized-lists/Lists/ViewabilityHelper.js#L19-L20

## Changelog:

[GENERAL] [FIXED] - Add type information for items of VirtualizedList in `onViewableItemsChanged` signature
[GENERAL] [FIXED] - Add type information for items of FlatList in `onViewableItemsChanged` signature

Pull Request resolved: https://github.com/facebook/react-native/pull/42773

Test Plan:
Without the changes, typecheck of the project was fine, but with the changes applied to the node_modules/react-native copy a type error was found:
```
$ npm run typecheck

> my-project@1.0.0 typecheck
> tsc --skipLibCheck

src/MyComponent.tsx:385:29 - error TS2345: Argument of type '(string | number)[]' is not assignable to parameter of type 'number[]'.
  Type 'string | number' is not assignable to type 'number'.
    Type 'string' is not assignable to type 'number'.

385                             viewableItems
                                ~~~~~~~~~~~~~
386                                 .filter(
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```

Reviewed By: rozele

Differential Revision: D53276749

Pulled By: NickGerleman

fbshipit-source-id: 3fa5c65b388a59942c106286ac502a85c583da50

2024-02-01 15:25:10 -08:00

Interaction

Reconnect VirtualizedList Source History 2/2 (Apply D41745930 + history, D42805202, D43063551)

2023-02-06 20:00:19 -08:00

Lists

VirtualizedList/FlatList: Stricter typing for onViewableItemsChanged (#42773 )

2024-02-01 15:25:10 -08:00

Utilities

Reconnect VirtualizedList Source History 2/2 (Apply D41745930 + history, D42805202, D43063551)

2023-02-06 20:00:19 -08:00

.npmignore

fix[virtualized-lists]: do not ship tests in npm package (#36143 )

2023-02-14 04:12:39 -08:00

index.d.ts

Reconnect VirtualizedList Source History 2/2 (Apply D41745930 + history, D42805202, D43063551)

2023-02-06 20:00:19 -08:00

index.js

Enable lint/sort-imports everywhere (#41334 )

2023-11-06 12:59:38 -08:00

package.json

Bump package versions for next major (#39764 )

2023-10-11 08:36:23 -07:00

README.md

Add missing READMEs & Update package.json in all RN packages (#37090 )

2023-04-28 04:26:20 -07:00

README.md

@react-native/virtualized-lists

Installation

yarn add @react-native/virtualized-lists

Note: We're using yarn to install deps. Feel free to change commands to use npm 3+ and npx if you like

Testing

To run the tests in this package, run the following commands from the React Native root folder:

yarn to install the dependencies. You just need to run this once
yarn jest packages/virtualized-lists.