@ndwnu/map 3.0.1 → 3.0.3

package/types/ndwnu-map.d.ts

@@ -322,7 +322,66 @@ type NdwLayerSpecification = LayerSpecification & {
 };
 type NdwLayerFilterFunction = (layer: NdwLayerSpecification) => boolean;
 
+/**
+ * The default NDW map style, using NWB road layers as the road network.
+ * This is the recommended style for all NDW applications.
+ *
+ * ## ⚠️ Sprites must be loaded
+ *
+ * This style depends on sprite sheets for all of its icons and patterns
+ * (traffic signs, road symbols, SDF icons, ...). MapLibre only loads them when
+ * the `sprite` definition is present on the style object you give to the map.
+ *
+ * Passing the whole `NDWMapStyle` object already includes the sprites, so the
+ * simplest setup just works:
+ *
+ * ```ts
+ * import { NDWMapStyle } from '@ndwnu/map';
+ *
+ * // sprite is part of NDWMapStyle, so icons load automatically
+ * map.setStyle(NDWMapStyle);
+ * ```
+ *
+ * If you build your own style object (merging your own sources/layers), you
+ * MUST copy the sprite definition over — otherwise icons silently fail to load:
+ *
+ * ```ts
+ * map.setStyle({
+ *   ...myCustomStyle,
+ *   sprite: NDWMapStyle.sprite, // <-- required, do not omit
+ * });
+ * ```
+ */
 declare const NDWMapStyle: StyleSpecification;
+/**
+ * An alternative NDW map style that replaces the NWB road layers with
+ * OpenStreetMap roads. Behaves like {@link NDWMapStyle} in every other respect.
+ *
+ * ## ⚠️ Sprites must be loaded
+ *
+ * Like {@link NDWMapStyle}, this style depends on sprite sheets for its icons
+ * and patterns. MapLibre only loads them when the `sprite` definition is present
+ * on the style object you give to the map.
+ *
+ * Passing the whole `NDWOSMMapStyle` object already includes the sprites:
+ *
+ * ```ts
+ * import { NDWOSMMapStyle } from '@ndwnu/map';
+ *
+ * // sprite is part of NDWOSMMapStyle, so icons load automatically
+ * map.setStyle(NDWOSMMapStyle);
+ * ```
+ *
+ * If you build your own style object, you MUST copy the sprite definition over —
+ * otherwise icons silently fail to load:
+ *
+ * ```ts
+ * map.setStyle({
+ *   ...myCustomStyle,
+ *   sprite: NDWOSMMapStyle.sprite, // <-- required, do not omit
+ * });
+ * ```
+ */
 declare const NDWOSMMapStyle: StyleSpecification;
 
 export { ApiBackgroundLayer, ApiElement, ApiLayer, ApiSource, BOUNDS_AMERSFOORT, BOUNDS_NL, COMMON_BOUNDS, DEFAULT_MAP_CONFIG, MapComponent, MapElement, MapElementRepository, MapLayer, MapSource, MaplibreCursorService, NDWMapStyle, NDWOSMMapStyle, lineWidthFrcSpecification };