@kahwee/sf-map-svg 4.3.2 → 4.5.0

package/dist/src/static.js

@@ -2,12 +2,13 @@ import { prepareAppearance } from './appearance.js';
 import { validateSwitchPatch } from './features.js';
 import { createSFMapWithData, getLayerPathsWithData } from './map-core.js';
 import { normalizeStaticAnimation } from './static-animation.js';
+import { staticLabels } from './static-labels.js';
 import { assertOptions, validateMarkers, validateOverlays } from './validation.js';
 /** Server-safe SVG rendering with explicit data; returns SVG plus projection helpers. */
 export function renderMap(data, options = {}) {
     const prepared = expandStaticOptions(options);
     const { map, source } = staticInput(data, prepared);
-    return createSFMapWithData({ ...prepared, source }, map);
+    return createSFMapWithData({ ...prepared, source }, map, prepared.labelLayout ? (project) => staticLabels(map, prepared, project) : undefined);
 }
 /** Project canonical layer geometry without constructing an SVG string. */
 export function getLayerPaths(data, options = {}) {
@@ -34,8 +35,9 @@ function staticInput(data, options) {
         source,
         map: {
             ...data.map,
-            neighborhoods: collection.features.map(({ geometry, properties }) => ({
-                name: properties.sourceName,
+            neighborhoods: collection.features.map(({ id, geometry, properties }) => ({
+                id,
+                name: options.labelLayout ? properties.canonicalName : properties.sourceName,
                 geometry,
             })),
         },
@@ -46,6 +48,7 @@ const staticLayerKeys = [
     'districtLines',
     'districtLabels',
     'neighborhoodLines',
+    'neighborhoodLabels',
     'landmarks',
     'bartStations',
     'highways',
@@ -67,6 +70,7 @@ function expandStaticOptions(options) {
         'year',
         'source',
         'labels',
+        'labelLayout',
         'markers',
         'overlays',
         'title',
@@ -79,6 +83,30 @@ function expandStaticOptions(options) {
     for (const key of ['title', 'idPrefix'])
         if (options[key] !== undefined && typeof options[key] !== 'string')
             throw new TypeError(`${key} must be a string.`);
+    if (options.labelLayout !== undefined) {
+        assertOptions(options.labelLayout, 'label layout', [
+            'width',
+            'maxLabels',
+            'haloColor',
+            'compact',
+        ]);
+        if (!Number.isFinite(options.labelLayout.width) || options.labelLayout.width <= 0)
+            throw new RangeError('Invalid label layout width.');
+        const { maxLabels, haloColor, compact } = options.labelLayout;
+        if (maxLabels !== undefined && (!Number.isSafeInteger(maxLabels) || maxLabels < 0))
+            throw new RangeError('Invalid maxLabels.');
+        if (haloColor !== undefined && typeof haloColor !== 'string')
+            throw new TypeError('haloColor must be a string.');
+        if (compact !== undefined) {
+            assertOptions(compact, 'compact label layout', ['width', 'maxLabels']);
+            if (!Number.isFinite(compact.width) ||
+                compact.width <= 0 ||
+                compact.width >= options.labelLayout.width)
+                throw new RangeError('Invalid compact width.');
+            if (!Number.isSafeInteger(compact.maxLabels) || compact.maxLabels < 0)
+                throw new RangeError('Invalid maxLabels.');
+        }
+    }
     if (options.markers !== undefined)
         validateMarkers(options.markers);
     if (options.overlays !== undefined)

package/dist/src/types.d.ts

@@ -45,12 +45,27 @@ export interface SFMapOptions {
     source?: NeighborhoodSource;
     districtLines?: boolean;
     neighborhoodLines?: boolean;
+    /** Neighborhood names in the opt-in collision layout. */
+    neighborhoodLabels?: boolean;
     districtFills?: boolean;
     /** Evaluated once per district at construction/style/year updates; call setDistrictStyle again when external data changes. */
     districtStyle?: (district: import('./map-core.js').DistrictRowData) => DistrictStyle;
     districtLabels?: boolean;
     /** Hide all visible text labels while retaining geographic symbols and accessible titles. */
     labels?: boolean;
+    /** Opt into interactive overview label priorities/collisions at this CSS display width. Uses estimated system-font metrics without a DOM. */
+    labelLayout?: {
+        width: number;
+        /** Maximum placed labels, spread across the map with nearby-pin context; zero hides text only. */
+        maxLabels?: number;
+        /** Label outline color, for example the land color on a dark map. */
+        haloColor?: string;
+        /** Alternate layout below this SVG viewport width, without browser JavaScript. */
+        compact?: {
+            width: number;
+            maxLabels: number;
+        };
+    };
     highways?: boolean;
     keyRoads?: boolean;
     roadLabels?: boolean;
@@ -73,7 +88,7 @@ export interface SFMapOptions {
     colors?: Partial<Record<'water' | 'land' | 'district' | 'neighborhood' | 'highway' | 'road' | 'park' | 'landmark' | 'bart' | 'label' | 'marker' | 'selected', string>>;
 }
 /** Presentation supported by both the static and interactive renderers. */
-export type StaticMapLayers = Omit<InteractiveLayers, 'neighborhoodLabels'>;
+export type StaticMapLayers = InteractiveLayers;
 export type StaticMapAppearance = Pick<SFMapOptions, 'theme' | 'colors' | 'districtStyle'>;
 /** Serializable viewport in the interactive map's fixed 800 × 800 projected space. */
 export type MapViewport = readonly [x: number, y: number, size: number];

package/docs/API.md

@@ -19,9 +19,9 @@ const { svg } = renderMap(staticMapData, presentation);
 const map = createMap(fullMapData, presentation);
 ```
 
-Static `layers` supports every interactive layer switch except `neighborhoodLabels`. Static `appearance` supports `theme`, `colors`, and `districtStyle`; browser typography, area interaction styles, and screen-space marker sizing remain interactive settings. Unknown keys and invalid values are rejected for both flat and grouped options. Supplied grouped keys override flat compatibility keys; omitted or `undefined` grouped keys preserve the flat value or renderer default. Undefined color tokens use the theme default instead of entering SVG attributes. The two renderers retain their existing defaults. Marker arrays accept readonly inputs.
+Static `layers` supports every interactive layer switch. `neighborhoodLabels` applies to the opt-in `labelLayout` described below. Static `appearance` supports `theme`, `colors`, and `districtStyle`; browser typography, area interaction styles, and screen-space marker sizing remain interactive settings. Unknown keys and invalid values are rejected for both flat and grouped options. Supplied grouped keys override flat compatibility keys; omitted or `undefined` grouped keys preserve the flat value or renderer default. Undefined color tokens use the theme default instead of entering SVG attributes. The two renderers retain their existing defaults. Marker arrays accept readonly inputs.
 
-Flat compatibility options include `theme`, `width`, `height`, `padding`, `year` (2002, 2012, 2022), `districtLines`, `districtFills`, `districtStyle`, `districtLabels`, `neighborhoodLines`, `labels`, `highways`, `keyRoads`, `roadLabels`, `landmarks`, `bartStations`, `markers`, `overlays`, `title`, `idPrefix`, `colors`, and `animation`. Each optional layer is independent. User-supplied text and attributes are escaped in SVG output.
+Flat compatibility options include `theme`, `width`, `height`, `padding`, `year` (2002, 2012, 2022), `districtLines`, `districtFills`, `districtStyle`, `districtLabels`, `neighborhoodLines`, `neighborhoodLabels`, `labels`, `labelLayout`, `highways`, `keyRoads`, `roadLabels`, `landmarks`, `bartStations`, `markers`, `overlays`, `title`, `idPrefix`, `colors`, and `animation`. Each optional layer is independent. User-supplied text and attributes are escaped in SVG output.
 
 Custom district IDs must be finite numbers. An empty `labelPoints` array uses the district's primary `label` position.
 
@@ -29,6 +29,34 @@ The SVG description names the selected neighborhood source for source-aware data
 
 `animation: true` (or `{ duration, delay }`) makes a static map draw itself with self-contained, scoped CSS: land fades in, the coast and lines draw, districts grow, then labels and points appear. It plays when the SVG is inserted into a page or loaded as an image, needs no JavaScript, and stays still under `prefers-reduced-motion`. Re-insert the markup to replay it. Default output is unchanged.
 
+Static `labelLayout: { width: 390 }` opts into shared interactive **overview** label priorities, sizes, anchors and collision rules. `width` must be a positive finite CSS canvas width; it does not alter the SVG viewBox. Set `neighborhoodLabels: true` (flat or under `layers`) to add area names in this layout. Guide SVGs and shells enable neighborhood names by default only when opting into `labelLayout`. `labels: false` remains the master switch. Default static output is unchanged.
+
+For editorial previews, `labelLayout` also accepts `maxLabels` (a nonnegative safe integer), `haloColor` (an SVG color string), and `compact: { width, maxLabels }`. The compact width must be positive, finite, and smaller than the main layout width. Each layout places labels around pins independently, then chooses up to its budget for spatial coverage and nearby-pin context (selected marker first when it fits). Without a budget the existing overview order is unchanged. Equal spatial scores retain the original priority order. A zero budget hides text, never pins. The default halo remains white; use the land color for a quieter dark map.
+
+Compact mode embeds two label groups and a media query in the same SVG. At or below the compact width it shows the compact group; above it shows the main group. In an `<img>` or standalone SVG, the breakpoint follows the SVG viewport. In inline SVG it follows the document viewport, so use `<img>` for cards whose width differs from the page. No JavaScript, duplicated geometry, external fonts, or extra image requests are needed. The compact width is also its font-layout hint; very narrow images still scale the text. The interactive renderer continues to use its live collision layout after enhancement.
+
+```js
+createGuideSVG({
+  labelLayout: {
+    width: 800,
+    haloColor: '#1b2c28',
+    compact: { width: 480, maxLabels: 4 },
+  },
+  colors: { water: '#0a1412', land: '#1b2c28', label: '#d5e3e8' },
+  markers: places,
+});
+```
+
+See the [field-guide preview recipe](consumer-integration.md#editorial-map-previews) for a complete build-time example.
+
+Static placement uses estimated system-font metrics without browser globals. Interactive placement measures actual fonts and includes live selection and HTML furniture, so exact glyph positions and the visible label set can differ. See the [integration recipe](consumer-integration.md#keep-overview-labels-consistent) for width and progressive-enhancement guidance.
+
+## Editorial palettes
+
+Import `mapPalettes` from `@kahwee/sf-map-svg/presets`. `nightForest` and `warmPaper` are deeply frozen, opt-in token sets. Each supplies `colors`, `haloColor`, `markerColor`, `selectedMarkerColor`, and `selectedMarkerRingColor`. They work with any supplied geography and do not change the existing themes. Text clears 4.5:1 and pins/rings clear 3:1 against the palette's land, park, and water surfaces; consumers must check their own overrides and surrounding UI.
+
+For static maps pass `colors: palette.colors`, `labelLayout: { width: 800, haloColor: palette.haloColor }`, and the marker color on each marker. For interactive maps pass `appearance: { colors: palette.colors, labelStyle: { haloColor: palette.haloColor }, markerColor: palette.markerColor, selectedMarkerColor: palette.selectedMarkerColor }` and `features: { selectedMarkerRing: { color: palette.selectedMarkerRingColor } }`. Choose the palette in the consuming application; these tokens do not read system preferences or install global CSS.
+
 ## Interactive maps
 
 `createMap` defaults to `mode: 'basemap'` and `appearance.theme: 'transit'`. Set the mode explicitly for neighborhood or district exploration. District and neighborhood layer defaults follow the mode; other supplied layers default on. The [developer guide](developer-guide.md) compares static and interactive defaults and explains configuration resets, coordinates, and cleanup.
@@ -105,3 +133,11 @@ Neighborhood IDs are exact source-scoped feature IDs, rather than display names
 GeoJSON and static projection inputs use `[longitude, latitude]` in WGS84; markers use `{ lng, lat }`. Static `project` returns SVG units. `projectToScreen(lng, lat)` returns pixels relative to the mounted canvas. Camera viewports use the fixed 800 × 800 projected map space, independent of canvas size. Pan deltas use screen pixels, converted using the mounted canvas width. Marker radius uses screen pixels in browser maps and SVG units in static output.
 
 Explore presentation options in the [live map design playground](https://kahwee.github.io/sf-map-svg/playground.html). The page identifies its package version; released builds use compatible options for that installed version.
+
+## Linked place cards
+
+`bindMapCards(map, root, options)` from `@kahwee/sf-map-svg/cards` connects consumer-owned cards to a `MapController`. Each card uses `data-map-marker="stable-marker-id"`; native `<button type="button" data-map-select>` controls select that place without panning. Article links keep their ordinary navigation. `options.markers` is the same catalog supplied to the map; `highlightColor` optionally changes the preview ring and `scrollOnSelect: false` disables automatic card reveal.
+
+Pointer hover and keyboard focus draw a temporary ring through `projectToScreen()`. They do not call `selectMarker`, change the camera, or emit selection events. Focused cards take precedence over hovered cards. Offscreen points do not draw a ring. Touch users use the selection button. Selected cards receive `data-map-selected` and their buttons receive `aria-pressed`; style the card attribute in your own CSS. Selecting a pin reveals its card with immediate native scrolling, without moving focus. Filtering/reordering/removing cards is safe; IDs are compared directly, not inserted into CSS selectors.
+
+Call `binding.setMarkers(next)` after `map.setMarkers(next)` when the catalog changes. Call `binding.destroy()` before `map.destroy()` on unmount; cleanup is idempotent and restores attributes that the binding owned. The module does not create cards, fetch data, change URLs, install global CSS, or import geography. See the [linked-card recipe](consumer-integration.md#link-place-cards-to-pins).

package/docs/EXAMPLES.md

@@ -7,6 +7,7 @@ Choose by task. All snippets use the public package API; browser examples need a
 | I want to… | Start here |
 | --- | --- |
 | Render an SVG on a server | [Static map](#static-svg) |
+| Show labels before JavaScript loads | [Static-to-interactive guide](consumer-integration.md#keep-overview-labels-consistent) |
 | Add a small map to a browser | [Lightweight guide](#lightweight-interactive-guide) |
 | Bundle only selected geography | [Selected data](#selected-geography) |
 | Draw a route over the city | [Route overlay](#route-overlay) |

package/docs/consumer-integration.md

@@ -15,6 +15,46 @@ const markup = createGuideShell({ title: 'Explore San Francisco' });
 
 The shell uses an 800 × 800 projection with 28 units of padding, matching the interactive map. Use `createGuideSVG()` for custom dimensions. Rendering is offline, with zero runtime dependencies.
 
+## Keep overview labels consistent
+
+Opt into the browser's overview label priorities and collision rules with a target **canvas width in CSS pixels**:
+
+```ts
+const labeledMarkup = createGuideShell({
+  title: 'Explore San Francisco',
+  labelLayout: { width: 390 },
+});
+```
+
+This keeps the 800 × 800 projection. It sizes and places text for a 390 px canvas, prioritizes major parks and primary roads, includes neighborhood names, and avoids label, marker, and BART-symbol collisions. BART names and smaller parks remain deferred until interactive zoom. Use the same geography, colors, markers and layer switches when mounting. Set `layers.neighborhoodLabels: false` on both renderers to omit neighborhood names.
+
+The width is a rendering hint, not a responsive script. Generate an appropriate variant for your known embed width; an SVG displayed at another width scales its labels with the artwork. Static layout uses conservative estimated system-font widths, while the browser measures actual fonts and recalculates on resize. Font metrics, custom browser label styles, selection, clustering and HTML overlays can therefore change the final label set or position. This reduces the transition without promising pixel-identical hydration. Existing calls without `labelLayout` keep their original fixed labels.
+
+For a fixed-width embed, use shared inputs on the server and in the browser:
+
+```ts
+// Shared inputs: coordinates, IDs, radii, colors and layer choices must match.
+const guideMarkers = [
+  { id: 'ferry', label: 'Ferry Building', lng: -122.3937, lat: 37.7955, radius: 7 },
+];
+const guideLayers = { neighborhoodLabels: true, roadLabels: true };
+const guideColors = { label: '#183e58', landmark: '#426641' };
+
+// Server: place this HTML in a canvas that is 390 CSS pixels wide.
+const labeledPlacesMarkup = createGuideShell({
+  labelLayout: { width: 390 },
+  markers: guideMarkers,
+  layers: guideLayers,
+  appearance: { colors: guideColors },
+});
+```
+
+After inserting that markup, pass `markers: guideMarkers`, `layers: guideLayers`, and `appearance: { colors: guideColors }` to `mountGuideController()` as shown below. The static-only `labelLayout` option is not a browser option: the controller measures the actual canvas and font. The shell border is outside the canvas, so a default shell with a 390 px outer width has a 388 px canvas.
+
+For responsive layouts whose canvas width is unknown at build time, use `labelLayout.compact` for an embedded image with two static label layouts (see [editorial previews](#editorial-map-previews)), choose a representative width and accept text scaling until enhancement, or serve independently rendered SVG variants through your application's responsive markup. The package does not detect a device on the server. Keep `labels: false` if your design requires no visible text change at enhancement.
+
+For `renderMap()`, also enable `neighborhoodLabels` explicitly; it defaults off outside the guide preset. `labels: false` hides all text in either layout while preserving symbols and accessible titles.
+
 ## Enhance the existing frame
 
 In your browser entry, mount the controller into that shell:
@@ -27,7 +67,9 @@ if (!shell) throw new Error('Missing guide shell');
 const guide = mountGuideController(shell, {
   attribution: 'compact',
   features: { motion: { duration: 400 }, markerEntrance: true },
-  appearance: { theme: 'transit' },
+  markers: guideMarkers,
+  layers: guideLayers,
+  appearance: { theme: 'transit', colors: guideColors },
 });
 
 // Call before your application removes the containing view.
@@ -45,3 +87,41 @@ For a new browser-only guide, use `createGuideController()` and mount its `.elem
 `createMap(guideMapData, guideOptions)` remains available through `/guide/data` and `/presets`. For server rendering, pass `guideMapData.map` or `/data/static` to `renderMap()`. Use `/data/full` when interactive lookup collections are needed. The guide's detailed geography loads only on an explicit `loadGuideDetailedData()` call; enabling a layer does not download it.
 
 See the [exact API contract](API.md), [worked examples](EXAMPLES.md), and [bundle measurements](guide-bundle-report.md).
+
+
+## Editorial map previews
+
+YorkSF uses one city overview to connect its field notes and compact locator maps to orient individual articles. These patterns work for any local guide: keep the place catalog in the consuming application, generate SVG images at build time, and link each preview to the application's map or article route.
+
+Run `pnpm demo` and open `examples/generated/field-guide.html` for a self-contained light/dark example. Its overview uses `labelLayout.compact` to limit mobile text without removing pins, and `haloColor` to match the night palette. The locator cards share those colors but omit labels at small sizes. Images reserve their aspect ratio and load lazily; the links work without JavaScript. The example derives its sample park coordinates from the package's existing landmark data rather than maintaining another geographic dataset.
+
+Use stable marker IDs for deep links. Keep addresses, visit dates, historical-status caveats, and editorial descriptions in your own content model. The package supplies map graphics; it does not imply that a place is currently open or that an author visited it. Keep a visible list beside the overview so the image is not the only way to find a place. SVG alt text should describe its purpose; link text should name the destination.
+
+For an image card, `compact.width` follows the image's rendered viewport. For inline SVG it follows the outer document viewport; do not assume it behaves like a container query. Avoid embedding scripts in exported images. Interactive maps remain a separate progressive enhancement.
+
+## Link place cards to pins
+
+Keep ordinary article links and add a separate map-selection button. Native buttons give keyboard and touch users the same action as pointer users:
+
+```html
+<article data-map-marker="park">
+  <h2><a href="/places/park/">A place in the park</a></h2>
+  <button type="button" data-map-select>Show on map</button>
+</article>
+```
+
+```js
+import { bindMapCards } from '@kahwee/sf-map-svg/cards';
+import { mapPalettes } from '@kahwee/sf-map-svg/presets';
+
+const binding = bindMapCards(map, document.querySelector('#place-cards'), {
+  markers: places,
+  highlightColor: mapPalettes.nightForest.selectedMarkerRingColor,
+});
+// On catalog change: map.setMarkers(next); binding.setMarkers(next);
+// On unmount: binding.destroy(); map.destroy();
+```
+
+Style `[data-map-selected]` with an outline or background change that remains legible in both themes. Use a visible focus outline on card buttons and links. Hover/focus only previews the location: it preserves selection and camera. Map selection reveals the card without shifting keyboard focus; set `scrollOnSelect: false` if your application owns scrolling. Match cards and markers by stable IDs, and keep hidden/filtered places out of both catalogs when that is your intended filter behavior.
+
+Run `pnpm demo` and open `examples/generated/linked-cards.html` for the complete pattern. Storybook **Maps / Linked place cards** checks hover, keyboard selection, card reveal, both palettes, and disposal.

package/docs/guide-bundle-report.md

@@ -1,12 +1,12 @@
 # Guide bundle size report
 
-Generated 2026-10-11 by `pnpm report:guide` with Vite production minification and gzip compression. Each emitted JS chunk is compressed independently. The report measures the explicit-data root and the optional `@kahwee/sf-map-svg/guide` preset.
+Generated 2026-10-14 by `pnpm report:guide` with Vite production minification and gzip compression. Each emitted JS chunk is compressed independently. The report measures the explicit-data root and the optional `@kahwee/sf-map-svg/guide` preset.
 
 | Entry | Initial JS, raw | Initial JS, gzip | Explicit detail JS, gzip |
 | --- | ---: | ---: | ---: |
-| Renderer root (explicit data) | 118.8 KB | 34.6 KB | — |
-| Static renderer | 25.8 KB | 7.9 KB | — |
-| Guide preset | 507.8 KB | 122.0 KB | 467.0 KB |
+| Renderer root (explicit data) | 122.8 KB | 36.3 KB | — |
+| Static renderer | 33.2 KB | 10.2 KB | — |
+| Guide preset | 507.0 KB | 122.1 KB | 467.0 KB |
 
 **500 KB target:** met.