react-leaflet-resetview

react-leaflet control for resetting the map view

Installation

You can install react-leaflet-resetview with NPM:

npm i @20tab/react-leaflet-resetview

Or with YARN:

yarn add @20tab/react-leaflet-resetview

Usage

import MapContainer from "react-leaflet";
import ResetViewControl from '@20tab/react-leaflet-resetview';

const Map = () => {
    return (
        <MapContainer zoom={5} center={[-96.8716348, 32.8205866]}>
            <ResetViewControl 
                title="Reset view"
                icon="url(/some/relative/path.png)"
            />
        </MapContainer>
    );
};

Props

| Name | Type | Default | Description | |------------|----------------------------------------------------------------------|--------------|------------------------------------| | position? | ControlOptions | "topleft" | The position of the control | | title? | string | "Reset map view" | The control title. | | icon? | string | "\u2610" | The control icon. Can be either a path for url() or a unicode character. |