doxa-maps/library
Doxa Maps 6ed22cdba7
Some checks are pending
Deploy to GitHub Pages / build (push) Waiting to run
Deploy to GitHub Pages / deploy (push) Blocked by required conditions
Update from source f849683d
2026-09-26 07:53:22 +00:00
..
api Update from source c2af6b16 2026-09-26 07:01:59 +00:00
colors Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
components Update from source c2af6b16 2026-09-26 07:01:59 +00:00
composables Update from source c2af6b16 2026-09-26 07:01:59 +00:00
constants Update from source c2af6b16 2026-09-26 07:01:59 +00:00
data Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
i18n Update from source f849683d 2026-09-26 07:53:22 +00:00
layouts Update from source f1f93d78 2026-09-26 04:20:35 +00:00
lists Update from source c2af6b16 2026-09-26 07:01:59 +00:00
maps Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
packet Update from source c2af6b16 2026-09-26 07:01:59 +00:00
scripts Update from source c2af6b16 2026-09-26 07:01:59 +00:00
stores Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
styles Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
utils Update from source f849683d 2026-09-26 07:53:22 +00:00
index.js Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
ProfileLoader.vue Update from source f1f93d78 2026-09-26 04:20:35 +00:00
README.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00

library/ (@map) — the shared map template

The other half of the architecture (see ../plugin-designs/README.md): every map in plugin-designs/<your-map>/ composes the reusable, parameterized pieces that live here. Fix something here and every map benefits on the next build; break something here and every map breaks — read components/WARNING.md before touching shared pieces.

Folder What lives there
ProfileLoader.vue The root of every bundle: parses profile-config, loads the profile, provides the stores + config
components/ Shared UI — map, legends, controls, popup (PeopleGroupDetail), tables, charts, hints (README)
composables/ Shared logic — map engine (useMapInstance), provider switch, shadow-DOM styles, theming
stores/ Per-instance Pinia stores (ui / map / data) — provided by ProfileLoader, injected by children
api/ Data-source registry (sources.json) + fetch layer — the JAMstack runtime wiring
colors/ Color sets maps opt into via profile-config.colorSet
i18n/ The shared string catalogs (all maps speak the same languages)
data/ Small shared datasets baked at build time (big served data lives in ../data/)
constants/ Shared constants
scripts/ Maintainer pipelines (posters, research) — not part of any bundle

The rule of thumb (same as WARNING.md): custom code in your app-profile, reusable code here — and things only move from the first to the second once they've earned it.