@types/leaflet

What is @types/leaflet?

@types/leaflet provides TypeScript type definitions for the Leaflet library, which is a popular open-source JavaScript library for interactive maps. These type definitions help developers use Leaflet in TypeScript projects by providing type safety and autocompletion features.

What are @types/leaflet's main functionalities?

Creating a Map

This feature allows you to create a map and set its initial view to a specific geographical point and zoom level.

const map = L.map('mapId').setView([51.505, -0.09], 13);

Adding Tile Layers

This feature allows you to add tile layers to the map, which are the visual representation of the map itself. In this example, OpenStreetMap tiles are used.

L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', { maxZoom: 19 }).addTo(map);

Adding Markers

This feature allows you to add markers to the map at specific geographical points.

const marker = L.marker([51.5, -0.09]).addTo(map);

Adding Popups

This feature allows you to bind popups to markers or other map elements, which can display additional information when clicked.

marker.bindPopup('A pretty CSS3 popup.<br> Easily customizable.').openPopup();

Drawing Shapes

This feature allows you to draw shapes like circles, polygons, and rectangles on the map.

const circle = L.circle([51.508, -0.11], { color: 'red', radius: 500 }).addTo(map);

Other packages similar to @types/leaflet

@types/google-maps

@types/google-maps provides TypeScript type definitions for the Google Maps JavaScript API. It offers similar functionalities for creating and manipulating maps, markers, and other map elements, but it is specific to Google Maps.

@types/mapbox-gl

@types/mapbox-gl provides TypeScript type definitions for the Mapbox GL JS library. It offers functionalities for creating interactive maps with vector tiles and Mapbox styles, and it is known for its high performance and customizability.

@types/ol

@types/ol provides TypeScript type definitions for the OpenLayers library. OpenLayers is another powerful library for creating interactive maps and offers a wide range of features for working with different map layers and projections.

README

Installation

npm install --save @types/leaflet

Summary

This package contains type definitions for leaflet (https://github.com/Leaflet/Leaflet).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/leaflet.

Additional Details

• Last updated: Tue, 07 Jan 2025 13:07:11 GMT
• Dependencies: @types/geojson

Credits

These definitions were written by Alejandro Sánchez, Arne Schubert, Michael Auer, Roni Karilkar, Vladimir Dashukevich, Henry Thasler, Colin Doig, and Hugo Sales.