GeoLeaf

Appearance

GeoLeaf Core — Documentation Index ​

Package: @geoleaf/coreVersion: 2.1.5 Mise à jour : Mars 2026 License: MIT

Documentation for the GeoLeaf Core library (MIT only). This index covers the public core package only. Commercial plugin documentation is delivered separately with each plugin licence. For available plugins, visit geoleaf.dev.

Note: This documentation index has been fully reviewed and updated for v2.1.5 (MapLibre GL JS engine, refactored module structure, new adapters layer). All files listed below reflect the current codebase state.

DocumentDescription
Getting StartedInstallation and first map — v2.1.5
Quickstart TutorialProjet de A à Z (localisateur de commerces) — v2.1.5
User GuideComplete feature documentation — v2.1.5
Configuration GuideJSON configuration reference — v2.1.5
API ReferencePublic API — facades & ESM exports — v2.1.5
Architecture GuideDesign, boot sequence, modules — v2.1.5
Plugin Development GuideCréer un plugin custom — v2.1.5
Core Extension GuideAjouter un module interne au core (fork MIT) — v2.1.5
Connector GuideAuthentification HTTP (@geoleaf/connector) — v2.1.5
ContributingContribution guidelines — v2.1.5

User & configuration ​

Developer ​

API reference ​

  • API Reference — 24 named ESM exports + public facades + global namespace — v2.1.5
  • Events API — Event bus, event types — v2.1.5
  • Notifications API — Notification system API — v2.1.5
  • TypeDoc (generated) — Run npm run docs:api in packages/core to generate locally at packages/core/docs/api/

Module documentation ​

Core modules ​

ModuleREADMEVersion
Corecore/GeoLeaf_core_README.mdv2.1.5
POIpoi/GeoLeaf_POI_README.mdv2.1.5
GeoJSON Layersgeojson/GEOJSON_LAYERS_GUIDE.mdv2.1.5
MVT / Vector Tilesgeojson/MVT_GUIDE.mdv2.1.5
UIui/GeoLeaf_UI_README.mdv2.1.5
UI Controlsui/GeoLeaf_UI_Controls_README.mdv2.1.5
UI Componentsui/GeoLeaf_UI_Components_README.mdv2.1.5
UI Themeui/GeoLeaf_UI_Theme_README.mdv2.1.5
Panel Builderui/GeoLeaf_UI_PanelBuilder_README.mdv2.1.5
Content Builderui/content-builder/README.mdv2.1.5
Cache Buttonui/cache-button.mdv2.1.5
Breakpointsui/BREAKPOINTS.mdv2.1.5
Permalinkui/PERMALINK.mdv2.1.5
Filtersfilters/GeoLeaf_Filters_README.mdv2.1.5
Routeroute/GeoLeaf_Route_README.mdv2.1.5
Tabletable/GeoLeaf_Table_README.mdv2.1.5
Legendlegend/GeoLeaf_Legend_README.mdv2.1.5
LayerManagerlayer-manager/GeoLeaf_LayerManager_README.mdv2.1.5
Baselayersbaselayers/GeoLeaf_Baselayers_README.mdv2.1.5
Labelslabels/GeoLeaf_Labels_README.mdv2.1.5
Label Button Managerlabels/LABEL_BUTTON_MANAGER.mdv2.1.5
Themesthemes/GeoLeaf_Themes_README.mdv2.1.5
Configconfig/GeoLeaf_Config_README.mdv2.1.5
Config Layersconfig/LAYER_CONFIG.mdv2.1.5
Config POIconfig/POI_CONFIG.mdv2.1.5
Config Scaleconfig/SCALE_CONFIG.mdv2.1.5
Data Normalizerconfig/data-normalizer.mdv2.1.5
POI Fields Tourismconfig/poi-fields-tourism.mdv2.1.5
Helpershelpers/GeoLeaf_Helpers_README.mdv2.1.5
Validatorsvalidators/GeoLeaf_Validators_README.mdv2.1.5
Errorserrors/GeoLeaf_Errors_README.mdv2.1.5
Securitysecurity/GeoLeaf_Security_README.mdv2.1.5
Security Contractsecurity/SECURITY_CONTRACT.mdv2.1.5
Security Guide (CSP)SECURITY.mdv2.1.5
Loglog/GeoLeaf_Logging_README.mdv2.1.5
Utilsutils/GeoLeaf_Utils_README.mdv2.1.5
Constantsconstants/GeoLeaf_Constants_README.mdv2.1.5
Renderersrenderers/ABSTRACT_RENDERER_API.mdv2.1.5
Searchsearch/SEARCH_ENGINE_GUIDE.mdv2.1.5
Performanceperformance/PERFORMANCE_ARCHITECTURE.mdv2.1.5
CSS Animationsperformance/CSS_ANIMATION_OPTIMIZATION.mdv2.1.5

Schema ​

TopicDocumentVersion
Schemasschema/README.mdv2.1.5
DocumentDescription
NOTICE.mdThird-party notices and attributions

Plugins ​

Plugin MIT public ​

  • @geoleaf/connector — Authentification HTTP transparente (fetch intercept, JWT, login modal). Voir aussi : packages/plugin-connector/README.md

Plugins commerciaux ​

Commercial plugin documentation is not included in this public repository. It is delivered with each plugin licence.

  • @geoleaf-plugins/storage — Offline cache, IndexedDB, tile persistence
  • @geoleaf-plugins/addpoi — POI CRUD, form builder, image upload

Pour la configuration des plugins dans un profil : PLUGIN_CONFIGURATION_GUIDE.md

Visit geoleaf.dev for licensing information.

Released under the MIT License.

© 2026 Mattieu Pottier — geoleaf.dev