# NextGIS Frontend

> TypeScript libraries for building NextGIS Web maps with Leaflet, OpenLayers, MapLibre GL JS, React, and NextGIS QMS.

Most applications should start with an engine-specific `ngw-*` or `react-ngw-*` package. These packages share the `NgwMap` and `WebMap` APIs. Use `ngw-connector` without a map and generate server-specific route declarations with `ngw-types-loader`.

Detailed API pages are generated from the TypeScript source. The full overview contains the architecture guide and export indexes for the packages listed below.

## Architecture and overview

- [Package architecture](https://code-api.nextgis.com/markdown/documents/PACKAGES.md): Package selection, inheritance, composition, and API boundaries.
- [Full LLM overview](https://code-api.nextgis.com/llms-full.txt): Architecture, usage guides, and export indexes for the main packages.

## NextGIS Web maps and API

- [@nextgis/ngw-leaflet](https://code-api.nextgis.com/markdown/@nextgis/ngw-leaflet/README.md): Ready-to-use NextGIS Web map based on Leaflet.
- [@nextgis/ngw-ol](https://code-api.nextgis.com/markdown/@nextgis/ngw-ol/README.md): Ready-to-use NextGIS Web map based on OpenLayers.
- [@nextgis/ngw-maplibre-gl](https://code-api.nextgis.com/markdown/@nextgis/ngw-maplibre-gl/README.md): Ready-to-use NextGIS Web map based on MapLibre GL JS.
- [@nextgis/ngw-kit](https://code-api.nextgis.com/markdown/@nextgis/ngw-kit/README.md): NextGIS Web layer adapters, feature requests, identification, legends, and resource utilities.
- [@nextgis/ngw-connector](https://code-api.nextgis.com/markdown/@nextgis/ngw-connector/README.md): Map-independent NextGIS Web HTTP client and typed route API.
- [@nextgis/ngw-types-loader](https://code-api.nextgis.com/markdown/@nextgis/ngw-types-loader/README.md): Installs deployment-specific @nextgisweb TypeScript declarations.

## React integration

- [@nextgis/react-ngw-leaflet](https://code-api.nextgis.com/markdown/@nextgis/react-ngw-leaflet/README.md): Ready-to-use Leaflet-based React map component.
- [@nextgis/react-ngw-ol](https://code-api.nextgis.com/markdown/@nextgis/react-ngw-ol/README.md): Ready-to-use OpenLayers-based React map component.
- [@nextgis/react-ngw-maplibre-gl](https://code-api.nextgis.com/markdown/@nextgis/react-ngw-maplibre-gl/README.md): Ready-to-use MapLibre GL JS-based React map component.
- [@nextgis/react-ngw-map](https://code-api.nextgis.com/markdown/@nextgis/react-ngw-map/README.md): Common React component, context, hooks, layers, and controls for custom adapters.

## QuickMapServices

- [@nextgis/qms-leaflet](https://code-api.nextgis.com/markdown/@nextgis/qms-leaflet/README.md): QMS layers and search control for a native Leaflet map.
- [@nextgis/qms-ol](https://code-api.nextgis.com/markdown/@nextgis/qms-ol/README.md): QMS layers and search control for a native OpenLayers map.
- [@nextgis/qms-maplibre-gl](https://code-api.nextgis.com/markdown/@nextgis/qms-maplibre-gl/README.md): QMS layers and search control for a native MapLibre GL JS map.
- [@nextgis/qms-core](https://code-api.nextgis.com/markdown/@nextgis/qms-core/README.md): Map-independent QMS client, catalog, and shared control UI.
- [@nextgis/qms-kit](https://code-api.nextgis.com/markdown/@nextgis/qms-kit/README.md): QMS layer adapter for libraries built on WebMap.

## Library foundations

- [@nextgis/ngw-map](https://code-api.nextgis.com/markdown/@nextgis/ngw-map/README.md): Framework-independent NextGIS Web map class underlying the ready-to-use maps.
- [@nextgis/webmap](https://code-api.nextgis.com/markdown/@nextgis/webmap/README.md): Framework-independent map engine, common API, and adapter contracts.

## Optional

- [HTML API documentation](https://code-api.nextgis.com/): Human-readable TypeDoc site.
- [Live examples](https://code.nextgis.com): Runnable examples for the supported map engines.
- [GitHub repository](https://github.com/nextgis/nextgis_frontend): Source code, package README files, and development history.
- [NextGIS Web HTTP API](https://demo.nextgis.com/doc/api): Server route reference for the public demo deployment.