[Bug] Type `MapLayerMouseEvent` for `onClick` on `<Map>` does not match data - Githubissues

visgl / react-map-gl

React friendly API wrapper around MapboxGL JS

http://visgl.github.io/react-map-gl/

Other

7.88k stars 1.35k forks source link

[Bug] Type `MapLayerMouseEvent` for `onClick` on `<Map>` does not match data #2299

Closed tordans closed 5 months ago

tordans commented 1 year ago

Description

The type I get in VS Code is (property) features?: Feature<Geometry, GeoJsonProperties>[] | undefined

(I include Map from react-map-gl/maplibre.)

However, the generic GeoJsonProperties is not quite right, it does not type the special properties like source.

I don't understand where this information is lost …

The docs are right https://github.com/visgl/react-map-gl/blob/master/docs/api-reference/types.md?plain=1#L153-L160
They match what Maplibre documents https://maplibre.org/maplibre-gl-js/docs/API/types/maplibregl.MapGeoJSONFeature/
The code exports the types from Maplibre https://github.com/visgl/react-map-gl/blob/e11b41eefe73ff773bbec1db73277e4aca1f1bef/src/types/events-maplibre.ts#L35
And Maplibre is explicit that features are MapGeoJSONFeature https://github.com/maplibre/maplibre-gl-js/blob/572d6071fd5fce9f71bdb267f05532616e8d7be0/src/ui/events.ts#L17C66-L17C66 and MapGeoJSONFeature has all the data/types we expect https://github.com/maplibre/maplibre-gl-js/blob/main/src/util/vectortile_to_geojson.ts#L18C1-L23

Expected Behavior

The react map gl types should match the Maplibre types.

Steps to Reproduce

-

Environment

Framework version: "react-map-gl": "7.1.6",
Map library: "maplibre-gl": "^2.4.0",

Logs

No response

tordans commented 5 months ago

I am using "react-map-gl": "7.1.7" ATM and this issue is not present anymore. => Closing