geoman-io/leaflet-geoman

Types fix (for crucial for react-leaflet users)

Open

#1515 opened on Sep 19, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (1,933 stars) (404 forks)batch import
help wantedtypescript

Description

Hey! I'm using the free version with react-leaflet, and all seems to work quite well but there is one main problem which is types of event handlers. The type definitions for pm event is on interface Evented, while for react-leaflet users, the event handler's prop type (which are passed to each layer's component) are inferred LeafletEventHandlerFnMap. So far, I have built my own leaflet.d.ts file to extend the type infer to match what geoman is adding. I'd for it to come by default or listen to other possible solutions from the community

Contributor guide

Tech stack
javascripttypescriptreact
Domain
developer experiencefrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptReact Leaflet
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Check the existing type definitions in the repository, particularly the Evented interface and the type maps for event handlers. Look at how react leaflet's type inference works for leaflet event handlers. The goal is to extend the existing PM event types to be included in the default EventHandlerFnMap for react leaflet compatibility. See comments in issue #1515 for user provided workaround. Files to examine: likely src/types.ts or similar typings files.