io.github.EOX-A/EOxElements

EOxElements

A Web Component collection of geospatial UI elements, crafted by EOX.

Documentation, Examples

Please find descriptions, API docs and interactive examples here.

Elements

• ⭕️ Alpha elements are in-development and may have many frequent breaking changes.
• 🟡 Beta elements are mostly polished and ready for use, but may still have breaking changes.

• ✅ Stable elements are reviewed, documented, and API complete.

  Element Description Docs & Examples Version State

  eox-chart Dynamic chart with built-in data fetching Docs & Examples

  ✅

  eox-drawtools Draw and manage features on a map Docs & Examples

  ✅

  eox-feedback Quick and easy feedback widget Docs & Examples

  ✅

  eox-geosearch An autocompleted search input for geographic locations Docs & Examples

  ✅

  eox-itemfilter Filter/search large sets of items client-side or server-side Docs & Examples

  ✅

  eox-jsonform Render a form from a JSON schema Docs & Examples

  ✅

  eox-layercontrol Manage and modify map layers Docs & Examples

  ✅

  eox-layout Easily create a UI layout Docs & Examples

  ✅

  eox-map Map with powerful tools & helpers Docs & Examples

  ✅

  eox-stacinfo Display properties of STAC files Docs & Examples

  ✅

  eox-storytelling StoryTelling tools based on markdown Docs & Examples

  ✅

  eox-timecontrol Time control and playback for map layers Docs & Examples

  ✅

  eox-tour Guided tour for UIs Docs & Examples

  ✅

Usage

For detailed descriptions and documentation on the individual elements, please check out the READMEs in the element subfolders.

Bundlers (Vite, Webpack, etc.)

npm install @eox/<element>

import "@eox/<element>"
<eox-element></eox-element>

Script tag

<eox-element></eox-element>

<script type="module">
import "@eox/<element>" from "https://cdn.skypack.dev/@eox/<element>"
</script>

Development

For detailed development instructions, including monorepo structure, coding standards, and testing procedures, please refer to the Contributing Guide.

AI Agents working in this repository should also consult AGENTS.md for specific guidelines on maintaining documentation and ensuring compatibility with the MCP server.

License

By contributing to EOxElements, you agree that your contributions will be licensed under the repository's LICENSE.

Previous versions

The main branch of this project contains the v2 version of EOxElements. For the (legacy) v1 EOxElements, please see the v1 branch.