Dash Leaflet is a light wrapper around React-Leaflet. The syntax is similar to other Dash components, with naming conventions following the React-Leaflet API.
The easiest way to get started is to install the latest version of Dash and Dash Leaflet via pip.
pip install dash
pip install dash-leaflet
Once the installation is completed, paste the following lines of code into a .py file and run it.
from dash import Dash
import dash_leaflet as dl
app = Dash()
app.layout = dl.Map(dl.TileLayer(), style={'height': '50vh'}, center=[56, 10], zoom=6)
if __name__ == '__main__':
app.run_server()
That's it! If you visit http://127.0.0.1:8050/ in your browser, you should see a Leaflet map.
The documentation has been moved to a separate page to enable an interactive example gallery.
NB: The 1.0.0 release contains a wide range of breaking changes, please refer to the migration guidelines
Please ask questions on StackOverflow using the dash-leaflet tag, use GitHub issues only for bug reports.
Start by cloning this repository,
git clone git@github.com:thedirtyfew/dash-leaflet.git
cd dash-leaflet
Next, create a virtual environment and install the python dependencies (make sure to have Python 3.12 and uv installed),
uv venv && source .venv/bin/activate && uv sync
pip install dash
pip install PyYAML
Finally, install packages via npm (ignore errors) and run the build script,
npm i --ignore-scripts
npm run build
Useful commands for development:
npm install: Install JavaScript dependencies.npm run build: Build the JavaScript components.pip install -e .to install the package in editable mode.