Integrating with react-leaflet?

[charlieforward9]

Docs: https://react-leaflet.js.org/docs/api-map/

Considering the presence of the useMapEvents hook, I am curious about the value of integrating the Leaflet.Editable functionality within the react-leaflet API and rely on code-splitting/tree-shaking, etc to ensure that the editable methods/handlers do not end up in the build files of projects that do not depend on it.

In other words, if someone wants to use this editable code, the MapContainer would have the toggle to enable it and that would attach all the other MapEvents to the useMapEvent hook.

The return value of the hook would have to be discussed. It may be better to return a new hook with the edit controls, such as useMapEdit and pass the config into this.

[charlieforward9]

The integration happens automatically. When leaflet-editable and @types/leaflet-editable is installed, it augments the Leaflet types by default, so there is no need to pass edit event handlers into both useMapEvents and useLeafletEditable.

import { LeafletEventHandlerFnMap } from "leaflet";
import { useMapEvents } from "react-leaflet/hooks";
import { useLeafletEditable } from "leaflet-editable-hook";

const onCreated: LayerEventHandlerFn = (e) => {
    console.log(e);
  };
  //These two hooks do the same thing. 
  useMapEvents({
    "editable:created": onCreated,
  });
  useLeafletEditable({
    events: {
      onCreated,
    },
  });

I propose removing the redundant event handlers from the hook props, and expose this hook functionality exclusively for its edit control functions: start<Layer>, en/disableEdit.

At minimum, we should be able to call the hook without passing in events:

 useLeafletEditable(); //Expected 1 arguments, but got 0. index.d.ts(53, 3): An argument for 'options' was not provided.

@AlejandroRM-DEV

[AlejandroRM-DEV]

Using useMapEvents will force users to manually unregister the event if they want to start with a different figure, right?

[charlieforward9]

I am unsure about this, just tossing an idea out there.

I understand if keeping it separate is preferred, given Editable is a plugin that is not included in core Leaflet. Just thought it'd be an interesting project to build the module augmentation rather than a whole new hook.