@florasync/leaflet-geokit 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,6 +26,7 @@ Documentation quick-links
26
26
 
27
27
  - What you get
28
28
  - Install
29
+ - Tile Providers
29
30
  - Build and compilation
30
31
  - Runtime and architecture overview
31
32
  - Public API (attributes, properties, methods, events)
@@ -118,6 +119,52 @@ Why choose external?
118
119
 
119
120
  ---
120
121
 
122
+ ## Tile Providers
123
+
124
+ The `<leaflet-geokit>` web component supports multiple tile provider modes.
125
+
126
+ ### OpenStreetMap (Default)
127
+
128
+ ```html
129
+ <leaflet-geokit tile-provider="osm"></leaflet-geokit>
130
+ ```
131
+
132
+ ### HERE Maps
133
+
134
+ Requires a HERE API key ([get one here](https://developer.here.com/)):
135
+
136
+ ```html
137
+ <leaflet-geokit
138
+ tile-provider="here"
139
+ tile-style="lite.day"
140
+ api-key="YOUR_HERE_API_KEY"
141
+ ></leaflet-geokit>
142
+ ```
143
+
144
+ `api-key` is the canonical attribute. `here-api-key` is also accepted as a legacy alias.
145
+
146
+ **Available HERE Styles**:
147
+
148
+ - `lite.day` - Lightweight basemap (default)
149
+ - `normal.day` - Standard street map
150
+ - `satellite.day` - Satellite imagery
151
+
152
+ ### Custom Tile Server (Backward Compatible)
153
+
154
+ You can still use custom tile URLs:
155
+
156
+ ```html
157
+ <leaflet-geokit
158
+ tile-url="https://example.com/tiles/{z}/{x}/{y}.png"
159
+ ></leaflet-geokit>
160
+ ```
161
+
162
+ ### Security Note
163
+
164
+ ⚠️ For production use, **do not** expose API keys client-side. Use a server-side proxy to request tiles.
165
+
166
+ ---
167
+
121
168
  ## Build and compilation
122
169
 
123
170
  Tooling