🗺️ Kortjs
A minimal slippy map as a web component
Key features
- Less than 4kB in a single Javascript file with zero dependencies.
- Image fetching and decoding in a worker ensures good performance and a responsive interface even on lower end devices.
- Customization through attributes and slotted elements without extra JavaScript.
The first version (0.1.0) focused on a location-picker use case. See specifics below.
🎇 Getting started
Include the script in your html:
<script defer type="module" src="https://unpkg.com/kortjs@latest/web-component/dist/kortjs.min.js"></script>
Add the markup:
<kort-js data-url="https://tile.openstreetmap.org/${z}/${x}/${y}.png">
<p slot="attribution-text">© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
</kort-js>
That's it - you got a working slippy map!
Also available on npm:
npm install kortjs
⚙️ Customization
The slippy map is customized with data-attributes and the <slot>
element - no Javascript needed!
Tile provider
A tile provider is specified using the following attributes:
-
data-url
(required) -
data-id
(optional) -
data-token
(optional) -
data-tilesize
(optional, default 256) -
data-maxzoom
(optional, default 19) -
data-minzoom
(optional, default 0)
The URL must use ${x}
, ${y}
and ${z}
as placeholders for tile numbers and zoom level.
Placeholders for the token (API key) and id are ${token}
and ${id}
respectively.
Should your chosen tile provider deviate from the defaults provided by Kortjs as listed, the attributes data-tilesize
, data-maxzoom
and data-minzoom
must be set accordingly. data-maxzoom
and data-minzoom
can also be used to limit zoom levels regardless of tile provider capabilities.
The data-id
can be used to provide an additional parameter, e.g. map style.
Example - Mapbox
Note how Mapbox serves tiles in a size of 512 pixels and zoom down to level 22. The id is used to specificy a style. This could also have been set in the url directly, but keeping it in a separate attribute may be useful in some circumstances.<kort-js
data-url="https://api.mapbox.com/styles/v1/mapbox/${id}/tiles/${z}/${x}/${y}?${token}"
data-id="light-v10"
data-token="YOUR_ACCESS_TOKEN"
data-tilesize="512"
data-maxzoom="22"
data-set-latitude="40.712778"
data-set-longitude="-74.006111"
data-set-zoom="10">
<p slot="attribution-text">© <a href="https://www.mapbox.com/about/maps/">Mapbox</a> © <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback/" target="_blank">Improve this map</a></strong></p>
<div slot="attribution-icon"></div>
</kort-js>
div[slot="attribution-icon"] {
position: absolute;
height: 20px;
width: 65px;
left: 10px;
bottom: 10px;
text-indent: -9999px;
background-image: url(data:image/svg+xml;base64,<?xml version="1.0" encoding="utf-8"?><svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 80.47 20.02" style="enable-background:new 0 0 80.47 20.02;" xml:space="preserve"><style type="text/css">.st0{opacity:0.6;fill:#FFFFFF;enable-background:new    ;}.st1{opacity:0.6;enable-background:new    ;}</style><g><path class="st0" d="M79.29,13.61c0,0.11-0.09,0.2-0.2,0.2h-1.53c-0.12,0-0.23-0.06-0.29-0.16l-1.37-2.28l-1.37,2.28c-0.06,0.1-0.17,0.16-0.29,0.16h-1.53c-0.04,0-0.08-0.01-0.11-0.03c-0.09-0.06-0.12-0.18-0.06-0.27c0,0,0,0,0,0l2.31-3.5l-2.28-3.47c-0.02-0.03-0.03-0.07-0.03-0.11c0-0.11,0.09-0.2,0.2-0.2h1.53c0.12,0,0.23,0.06,0.29,0.16l1.34,2.25l1.33-2.24c0.06-0.1,0.17-0.16,0.29-0.16h1.53c0.04,0,0.08,0.01,0.11,0.03c0.09,0.06,0.12,0.18,0.06,0.27c0,0,0,0,0,0L76.96,10l2.31,3.5C79.28,13.53,79.29,13.57,79.29,13.61z"/><path class="st0" d="M63.09,9.16c-0.37-1.79-1.87-3.12-3.66-3.12c-0.98,0-1.93,0.4-2.6,1.12V3.37c0-0.12-0.1-0.22-0.22-0.22h-1.33c-0.12,0-0.22,0.1-0.22,0.22v10.21c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22v-0.7c0.68,0.71,1.62,1.12,2.6,1.12c1.79,0,3.29-1.34,3.66-3.13C63.21,10.3,63.21,9.72,63.09,9.16L63.09,9.16z M59.12,12.41c-1.26,0-2.28-1.06-2.3-2.36V9.99c0.02-1.31,1.04-2.36,2.3-2.36s2.3,1.07,2.3,2.39S60.39,12.41,59.12,12.41z"/><path class="st0" d="M68.26,6.04c-1.89-0.01-3.54,1.29-3.96,3.13c-0.12,0.56-0.12,1.13,0,1.69c0.42,1.85,2.07,3.16,3.97,3.14c2.24,0,4.06-1.78,4.06-3.99S70.51,6.04,68.26,6.04z M68.24,12.42c-1.27,0-2.3-1.07-2.3-2.39s1.03-2.4,2.3-2.4s2.3,1.07,2.3,2.39S69.51,12.41,68.24,12.42L68.24,12.42z"/><path class="st1" d="M59.12,7.63c-1.26,0-2.28,1.06-2.3,2.36v0.06c0.02,1.31,1.04,2.36,2.3,2.36s2.3-1.07,2.3-2.39S60.39,7.63,59.12,7.63z M59.12,11.23c-0.6,0-1.09-0.53-1.11-1.19V10c0.01-0.66,0.51-1.19,1.11-1.19s1.11,0.54,1.11,1.21S59.74,11.23,59.12,11.23z"/><path class="st1" d="M68.24,7.63c-1.27,0-2.3,1.07-2.3,2.39s1.03,2.39,2.3,2.39s2.3-1.07,2.3-2.39S69.51,7.63,68.24,7.63z M68.24,11.23c-0.61,0-1.11-0.54-1.11-1.21s0.5-1.2,1.11-1.2s1.11,0.54,1.11,1.21S68.85,11.23,68.24,11.23z"/><path class="st0" d="M43.56,6.24h-1.33c-0.12,0-0.22,0.1-0.22,0.22v0.7c-0.68-0.71-1.62-1.12-2.6-1.12c-2.07,0-3.75,1.78-3.75,3.99s1.69,3.99,3.75,3.99c0.99,0,1.93-0.41,2.6-1.13v0.7c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22V6.44c0-0.11-0.09-0.21-0.21-0.21C43.57,6.24,43.57,6.24,43.56,6.24z M42.02,10.05c-0.01,1.31-1.04,2.36-2.3,2.36s-2.3-1.07-2.3-2.39s1.03-2.4,2.29-2.4c1.27,0,2.28,1.06,2.3,2.36L42.02,10.05z"/><path class="st1" d="M39.72,7.63c-1.27,0-2.3,1.07-2.3,2.39s1.03,2.39,2.3,2.39s2.28-1.06,2.3-2.36V9.99C42,8.68,40.98,7.63,39.72,7.63z M38.62,10.02c0-0.67,0.5-1.21,1.11-1.21c0.61,0,1.09,0.53,1.11,1.19v0.04c-0.01,0.65-0.5,1.18-1.11,1.18S38.62,10.68,38.62,10.02z"/><path class="st0" d="M49.91,6.04c-0.98,0-1.93,0.4-2.6,1.12V6.45c0-0.12-0.1-0.22-0.22-0.22h-1.33c-0.12,0-0.22,0.1-0.22,0.22v10.21c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22v-3.78c0.68,0.71,1.62,1.12,2.61,1.12c2.07,0,3.75-1.78,3.75-3.99S51.98,6.04,49.91,6.04z M49.6,12.42c-1.26,0-2.28-1.06-2.3-2.36V9.99c0.02-1.31,1.04-2.37,2.29-2.37c1.26,0,2.3,1.07,2.3,2.39S50.86,12.41,49.6,12.42L49.6,12.42z"/><path class="st1" d="M49.6,7.63c-1.26,0-2.28,1.06-2.3,2.36v0.06c0.02,1.31,1.04,2.36,2.3,2.36s2.3-1.07,2.3-2.39S50.86,7.63,49.6,7.63z M49.6,11.23c-0.6,0-1.09-0.53-1.11-1.19V10C48.5,9.34,49,8.81,49.6,8.81c0.6,0,1.11,0.55,1.11,1.21S50.21,11.23,49.6,11.23z"/><path class="st0" d="M34.36,13.59c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.76,0-1.39,0.67-1.51,1.54l0.01,4.44c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.81,0-1.47,0.75-1.52,1.71v4.27c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.44c0.01-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.21,0.1,0.22,0.21v0.63c0.48-0.65,1.24-1.04,2.06-1.05h0.03c1.04,0,1.99,0.57,2.48,1.48c0.43-0.9,1.33-1.48,2.32-1.49c1.54,0,2.79,1.19,2.76,2.65L34.36,13.59z"/><path class="st1" d="M80.32,12.97l-0.07-0.12L78.38,10l1.85-2.81c0.42-0.64,0.25-1.49-0.39-1.92c-0.01-0.01-0.02-0.01-0.03-0.02c-0.22-0.14-0.48-0.21-0.74-0.21h-1.53c-0.53,0-1.03,0.28-1.3,0.74l-0.32,0.53l-0.32-0.53c-0.28-0.46-0.77-0.74-1.31-0.74h-1.53c-0.57,0-1.08,0.35-1.29,0.88c-2.09-1.58-5.03-1.4-6.91,0.43c-0.33,0.32-0.62,0.69-0.85,1.09c-0.85-1.55-2.45-2.6-4.28-2.6c-0.48,0-0.96,0.07-1.41,0.22V3.37c0-0.78-0.63-1.41-1.4-1.41h-1.33c-0.77,0-1.4,0.63-1.4,1.4v3.57c-0.9-1.3-2.38-2.08-3.97-2.09c-0.7,0-1.39,0.15-2.02,0.45c-0.23-0.16-0.51-0.25-0.8-0.25h-1.33c-0.43,0-0.83,0.2-1.1,0.53c-0.02-0.03-0.04-0.05-0.07-0.08c-0.27-0.29-0.65-0.45-1.04-0.45h-1.32c-0.29,0-0.57,0.09-0.8,0.25C40.8,5,40.12,4.85,39.42,4.85c-1.74,0-3.27,0.95-4.16,2.38c-0.19-0.44-0.46-0.85-0.79-1.19c-0.76-0.77-1.8-1.19-2.88-1.19h-0.01c-0.85,0.01-1.67,0.31-2.34,0.84c-0.7-0.54-1.56-0.84-2.45-0.84h-0.03c-0.28,0-0.55,0.03-0.82,0.1c-0.27,0.06-0.53,0.15-0.78,0.27c-0.2-0.11-0.43-0.17-0.67-0.17h-1.33c-0.78,0-1.4,0.63-1.4,1.4v7.14c0,0.78,0.63,1.4,1.4,1.4h1.33c0.78,0,1.41-0.63,1.41-1.41c0,0,0,0,0,0V9.35c0.03-0.34,0.22-0.56,0.34-0.56c0.17,0,0.36,0.17,0.36,0.45v4.35c0,0.78,0.63,1.4,1.4,1.4h1.34c0.78,0,1.4-0.63,1.4-1.4l-0.01-4.35c0.06-0.3,0.24-0.45,0.33-0.45c0.17,0,0.36,0.17,0.36,0.45v4.35c0,0.78,0.63,1.4,1.4,1.4h1.34c0.78,0,1.4-0.63,1.4-1.4v-0.36c0.91,1.23,2.34,1.96,3.87,1.96c0.7,0,1.39-0.15,2.02-0.45c0.23,0.16,0.51,0.25,0.8,0.25h1.32c0.29,0,0.57-0.09,0.8-0.25v1.91c0,0.78,0.63,1.4,1.4,1.4h1.33c0.78,0,1.4-0.63,1.4-1.4v-1.69c0.46,0.14,0.94,0.22,1.42,0.21c1.62,0,3.07-0.83,3.97-2.1v0.5c0,0.78,0.63,1.4,1.4,1.4h1.33c0.29,0,0.57-0.09,0.8-0.25c0.63,0.3,1.32,0.45,2.02,0.45c1.83,0,3.43-1.05,4.28-2.6c1.47,2.52,4.71,3.36,7.22,1.89c0.17-0.1,0.34-0.21,0.5-0.34c0.21,0.52,0.72,0.87,1.29,0.86h1.53c0.53,0,1.03-0.28,1.3-0.74l0.35-0.58l0.35,0.58c0.28,0.46,0.77,0.74,1.31,0.74h1.52c0.77,0,1.39-0.63,1.38-1.39C80.47,13.38,80.42,13.17,80.32,12.97L80.32,12.97z M34.15,13.81h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.76,0-1.39,0.67-1.51,1.54l0.01,4.44c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.81,0-1.47,0.75-1.52,1.71v4.27c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.44c0.01-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.21,0.1,0.22,0.21v0.63c0.48-0.65,1.24-1.04,2.06-1.05h0.03c1.04,0,1.99,0.57,2.48,1.48c0.43-0.9,1.33-1.48,2.32-1.49c1.54,0,2.79,1.19,2.76,2.65l0.01,4.91C34.37,13.7,34.27,13.8,34.15,13.81C34.15,13.81,34.15,13.81,34.15,13.81z M43.78,13.59c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22v-0.71C41.34,13.6,40.4,14,39.42,14c-2.07,0-3.75-1.78-3.75-3.99s1.69-3.99,3.75-3.99c0.98,0,1.92,0.41,2.6,1.12v-0.7c0-0.12,0.1-0.22,0.22-0.22h1.33c0.11-0.01,0.21,0.08,0.22,0.2c0,0.01,0,0.01,0,0.02V13.59z M49.91,14c-0.98,0-1.92-0.41-2.6-1.12v3.78c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.45c0-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.22,0.1,0.22,0.22v0.7c0.68-0.72,1.62-1.12,2.6-1.12c2.07,0,3.75,1.77,3.75,3.98S51.98,14,49.91,14z M63.09,10.87C62.72,12.65,61.22,14,59.43,14c-0.98,0-1.92-0.41-2.6-1.12v0.7c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V3.37c0-0.12,0.1-0.22,0.22-0.22h1.33c0.12,0,0.22,0.1,0.22,0.22v3.78c0.68-0.71,1.62-1.12,2.6-1.11c1.79,0,3.29,1.33,3.66,3.12C63.21,9.73,63.21,10.31,63.09,10.87L63.09,10.87L63.09,10.87z M68.26,14.01c-1.9,0.01-3.55-1.29-3.97-3.14c-0.12-0.56-0.12-1.13,0-1.69c0.42-1.85,2.07-3.15,3.97-3.14c2.25,0,4.06,1.78,4.06,3.99S70.5,14.01,68.26,14.01L68.26,14.01z M79.09,13.81h-1.53c-0.12,0-0.23-0.06-0.29-0.16l-1.37-2.28l-1.37,2.28c-0.06,0.1-0.17,0.16-0.29,0.16h-1.53c-0.04,0-0.08-0.01-0.11-0.03c-0.09-0.06-0.12-0.18-0.06-0.27c0,0,0,0,0,0l2.31-3.5l-2.28-3.47c-0.02-0.03-0.03-0.07-0.03-0.11c0-0.11,0.09-0.2,0.2-0.2h1.53c0.12,0,0.23,0.06,0.29,0.16l1.34,2.25l1.34-2.25c0.06-0.1,0.17-0.16,0.29-0.16h1.53c0.04,0,0.08,0.01,0.11,0.03c0.09,0.06,0.12,0.18,0.06,0.27c0,0,0,0,0,0L76.96,10l2.31,3.5c0.02,0.03,0.03,0.07,0.03,0.11C79.29,13.72,79.2,13.81,79.09,13.81C79.09,13.81,79.09,13.81,79.09,13.81L79.09,13.81z"/><path class="st0" d="M10,1.21c-4.87,0-8.81,3.95-8.81,8.81s3.95,8.81,8.81,8.81s8.81-3.95,8.81-8.81C18.81,5.15,14.87,1.21,10,1.21z M14.18,12.19c-1.84,1.84-4.55,2.2-6.38,2.2c-0.67,0-1.34-0.05-2-0.15c0,0-0.97-5.37,2.04-8.39c0.79-0.79,1.86-1.22,2.98-1.22c1.21,0,2.37,0.49,3.23,1.35C15.8,7.73,15.85,10.5,14.18,12.19z"/><path class="st1" d="M10,0.02c-5.52,0-10,4.48-10,10s4.48,10,10,10s10-4.48,10-10C19.99,4.5,15.52,0.02,10,0.02z M10,18.83c-4.87,0-8.81-3.95-8.81-8.81S5.13,1.2,10,1.2s8.81,3.95,8.81,8.81C18.81,14.89,14.87,18.83,10,18.83z"/><path class="st1" d="M14.04,5.98c-1.75-1.75-4.53-1.81-6.2-0.14C4.83,8.86,5.8,14.23,5.8,14.23s5.37,0.97,8.39-2.04C15.85,10.5,15.8,7.73,14.04,5.98z M11.88,9.87l-0.87,1.78l-0.86-1.78L8.38,9.01l1.77-0.86l0.86-1.78l0.87,1.78l1.77,0.86L11.88,9.87z"/><polygon class="st0" points="13.65,9.01 11.88,9.87 11.01,11.65 10.15,9.87 8.38,9.01 10.15,8.15 11.01,6.37 11.88,8.15 "/></g></svg>);
background-size: 65px 20px;
}
Example - Retina tiles with MapTiles API
Note how MapTiles serves tiles in a size of 512 pixels.<kort-js
data-url="https://retina-tiles.p.rapidapi.com/local/osm@2x/v1/${z}/${x}/${y}.png?rapidapi-key=${token}"
data-token="YOUR_ACCESS_TOKEN"
data-tilesize="512"
data-set-latitude="40.712778"
data-set-longitude="-74.006111"
data-set-zoom="12">
<p slot="attribution-text">Tiles ©: <a href="https://www.maptilesapi.com/retina-tiles/">Retina Tiles API</a>, Map data © <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
</kort-js>
Example - 1024px tiles with MapTiler
<kort-js
data-url="https://api.maptiler.com/maps/basic/${z}/${x}/${y}@2x.png?key=${token}"
data-token="YOUR_ACCESS_TOKEN"
data-tilesize="1024"
data-set-latitude="40.712778"
data-set-longitude="-74.006111"
data-set-zoom="12">
<p slot="attribution-text"><a href="https://www.maptiler.com/copyright/" target="_blank">© MapTiler</a> <a href="https://www.openstreetmap.org/copyright" target="_blank">© OpenStreetMap contributors</a></p>
<div slot="attribution-icon"><a href="https://www.maptiler.com"><img src="https://api.maptiler.com/resources/logo.svg" alt="MapTiler logo"></a></div>
</kort-js>
div[slot="attribution-icon"] {
position: absolute;
left: 10px;
bottom: 10px;
}
Example - Minimal implementation with OpenStreetMaps
Please see the OpenStreetMaps tile usage policy before use. Note how the lack of referer header in sent requests may be problematic with OpenStreetMaps. See Known Issues for further details.<kort-js data-url="https://tile.openstreetmap.org/${z}/${x}/${y}.png">
<p slot="attribution-text">© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
</kort-js>
Attribution
Attribution is provided with the attribution-text-slot (slot="attribution-text"
) and attribution-icon-slot (slot="attribution-icon"
).
By default, it is assumed the text content provided is a paragraph tag with embedded anchor tags and will be placed as a single line of text in the bottom-right corner of the map. Any content can be provided, though you will have to style it accordingly. See details on styling further below.
Some tile providers require their logo as part of the attribution, which is the purpose of the attribution-icon-slot.
Example - Attribution required for Mapbox
<kort-js
data-url="https://api.mapbox.com/styles/v1/mapbox/${id}/tiles/${z}/${x}/${y}?${token}"
data-id="light-v10"
data-token="YOUR_ACCESS_TOKEN"
data-tilesize="512"
data-maxzoom="22"
data-set-latitude="40.712778"
data-set-longitude="-74.006111"
data-set-zoom="10">
<p slot="attribution-text">© <a href="https://www.mapbox.com/about/maps/">Mapbox</a> © <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback/" target="_blank">Improve this map</a></strong></p>
<div slot="attribution-icon"></div>
</kort-js>
p[slot="attribution-icon"] {
position: absolute;
height: 20px;
width: 65px;
left: 10px;
bottom: 10px;
text-indent: -9999px;
background-image: url(data:image/svg+xml;base64,<?xml version="1.0" encoding="utf-8"?><svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 80.47 20.02" style="enable-background:new 0 0 80.47 20.02;" xml:space="preserve"><style type="text/css">.st0{opacity:0.6;fill:#FFFFFF;enable-background:new    ;}.st1{opacity:0.6;enable-background:new    ;}</style><g><path class="st0" d="M79.29,13.61c0,0.11-0.09,0.2-0.2,0.2h-1.53c-0.12,0-0.23-0.06-0.29-0.16l-1.37-2.28l-1.37,2.28c-0.06,0.1-0.17,0.16-0.29,0.16h-1.53c-0.04,0-0.08-0.01-0.11-0.03c-0.09-0.06-0.12-0.18-0.06-0.27c0,0,0,0,0,0l2.31-3.5l-2.28-3.47c-0.02-0.03-0.03-0.07-0.03-0.11c0-0.11,0.09-0.2,0.2-0.2h1.53c0.12,0,0.23,0.06,0.29,0.16l1.34,2.25l1.33-2.24c0.06-0.1,0.17-0.16,0.29-0.16h1.53c0.04,0,0.08,0.01,0.11,0.03c0.09,0.06,0.12,0.18,0.06,0.27c0,0,0,0,0,0L76.96,10l2.31,3.5C79.28,13.53,79.29,13.57,79.29,13.61z"/><path class="st0" d="M63.09,9.16c-0.37-1.79-1.87-3.12-3.66-3.12c-0.98,0-1.93,0.4-2.6,1.12V3.37c0-0.12-0.1-0.22-0.22-0.22h-1.33c-0.12,0-0.22,0.1-0.22,0.22v10.21c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22v-0.7c0.68,0.71,1.62,1.12,2.6,1.12c1.79,0,3.29-1.34,3.66-3.13C63.21,10.3,63.21,9.72,63.09,9.16L63.09,9.16z M59.12,12.41c-1.26,0-2.28-1.06-2.3-2.36V9.99c0.02-1.31,1.04-2.36,2.3-2.36s2.3,1.07,2.3,2.39S60.39,12.41,59.12,12.41z"/><path class="st0" d="M68.26,6.04c-1.89-0.01-3.54,1.29-3.96,3.13c-0.12,0.56-0.12,1.13,0,1.69c0.42,1.85,2.07,3.16,3.97,3.14c2.24,0,4.06-1.78,4.06-3.99S70.51,6.04,68.26,6.04z M68.24,12.42c-1.27,0-2.3-1.07-2.3-2.39s1.03-2.4,2.3-2.4s2.3,1.07,2.3,2.39S69.51,12.41,68.24,12.42L68.24,12.42z"/><path class="st1" d="M59.12,7.63c-1.26,0-2.28,1.06-2.3,2.36v0.06c0.02,1.31,1.04,2.36,2.3,2.36s2.3-1.07,2.3-2.39S60.39,7.63,59.12,7.63z M59.12,11.23c-0.6,0-1.09-0.53-1.11-1.19V10c0.01-0.66,0.51-1.19,1.11-1.19s1.11,0.54,1.11,1.21S59.74,11.23,59.12,11.23z"/><path class="st1" d="M68.24,7.63c-1.27,0-2.3,1.07-2.3,2.39s1.03,2.39,2.3,2.39s2.3-1.07,2.3-2.39S69.51,7.63,68.24,7.63z M68.24,11.23c-0.61,0-1.11-0.54-1.11-1.21s0.5-1.2,1.11-1.2s1.11,0.54,1.11,1.21S68.85,11.23,68.24,11.23z"/><path class="st0" d="M43.56,6.24h-1.33c-0.12,0-0.22,0.1-0.22,0.22v0.7c-0.68-0.71-1.62-1.12-2.6-1.12c-2.07,0-3.75,1.78-3.75,3.99s1.69,3.99,3.75,3.99c0.99,0,1.93-0.41,2.6-1.13v0.7c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22V6.44c0-0.11-0.09-0.21-0.21-0.21C43.57,6.24,43.57,6.24,43.56,6.24z M42.02,10.05c-0.01,1.31-1.04,2.36-2.3,2.36s-2.3-1.07-2.3-2.39s1.03-2.4,2.29-2.4c1.27,0,2.28,1.06,2.3,2.36L42.02,10.05z"/><path class="st1" d="M39.72,7.63c-1.27,0-2.3,1.07-2.3,2.39s1.03,2.39,2.3,2.39s2.28-1.06,2.3-2.36V9.99C42,8.68,40.98,7.63,39.72,7.63z M38.62,10.02c0-0.67,0.5-1.21,1.11-1.21c0.61,0,1.09,0.53,1.11,1.19v0.04c-0.01,0.65-0.5,1.18-1.11,1.18S38.62,10.68,38.62,10.02z"/><path class="st0" d="M49.91,6.04c-0.98,0-1.93,0.4-2.6,1.12V6.45c0-0.12-0.1-0.22-0.22-0.22h-1.33c-0.12,0-0.22,0.1-0.22,0.22v10.21c0,0.12,0.1,0.22,0.22,0.22h1.33c0.12,0,0.22-0.1,0.22-0.22v-3.78c0.68,0.71,1.62,1.12,2.61,1.12c2.07,0,3.75-1.78,3.75-3.99S51.98,6.04,49.91,6.04z M49.6,12.42c-1.26,0-2.28-1.06-2.3-2.36V9.99c0.02-1.31,1.04-2.37,2.29-2.37c1.26,0,2.3,1.07,2.3,2.39S50.86,12.41,49.6,12.42L49.6,12.42z"/><path class="st1" d="M49.6,7.63c-1.26,0-2.28,1.06-2.3,2.36v0.06c0.02,1.31,1.04,2.36,2.3,2.36s2.3-1.07,2.3-2.39S50.86,7.63,49.6,7.63z M49.6,11.23c-0.6,0-1.09-0.53-1.11-1.19V10C48.5,9.34,49,8.81,49.6,8.81c0.6,0,1.11,0.55,1.11,1.21S50.21,11.23,49.6,11.23z"/><path class="st0" d="M34.36,13.59c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.76,0-1.39,0.67-1.51,1.54l0.01,4.44c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.81,0-1.47,0.75-1.52,1.71v4.27c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.44c0.01-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.21,0.1,0.22,0.21v0.63c0.48-0.65,1.24-1.04,2.06-1.05h0.03c1.04,0,1.99,0.57,2.48,1.48c0.43-0.9,1.33-1.48,2.32-1.49c1.54,0,2.79,1.19,2.76,2.65L34.36,13.59z"/><path class="st1" d="M80.32,12.97l-0.07-0.12L78.38,10l1.85-2.81c0.42-0.64,0.25-1.49-0.39-1.92c-0.01-0.01-0.02-0.01-0.03-0.02c-0.22-0.14-0.48-0.21-0.74-0.21h-1.53c-0.53,0-1.03,0.28-1.3,0.74l-0.32,0.53l-0.32-0.53c-0.28-0.46-0.77-0.74-1.31-0.74h-1.53c-0.57,0-1.08,0.35-1.29,0.88c-2.09-1.58-5.03-1.4-6.91,0.43c-0.33,0.32-0.62,0.69-0.85,1.09c-0.85-1.55-2.45-2.6-4.28-2.6c-0.48,0-0.96,0.07-1.41,0.22V3.37c0-0.78-0.63-1.41-1.4-1.41h-1.33c-0.77,0-1.4,0.63-1.4,1.4v3.57c-0.9-1.3-2.38-2.08-3.97-2.09c-0.7,0-1.39,0.15-2.02,0.45c-0.23-0.16-0.51-0.25-0.8-0.25h-1.33c-0.43,0-0.83,0.2-1.1,0.53c-0.02-0.03-0.04-0.05-0.07-0.08c-0.27-0.29-0.65-0.45-1.04-0.45h-1.32c-0.29,0-0.57,0.09-0.8,0.25C40.8,5,40.12,4.85,39.42,4.85c-1.74,0-3.27,0.95-4.16,2.38c-0.19-0.44-0.46-0.85-0.79-1.19c-0.76-0.77-1.8-1.19-2.88-1.19h-0.01c-0.85,0.01-1.67,0.31-2.34,0.84c-0.7-0.54-1.56-0.84-2.45-0.84h-0.03c-0.28,0-0.55,0.03-0.82,0.1c-0.27,0.06-0.53,0.15-0.78,0.27c-0.2-0.11-0.43-0.17-0.67-0.17h-1.33c-0.78,0-1.4,0.63-1.4,1.4v7.14c0,0.78,0.63,1.4,1.4,1.4h1.33c0.78,0,1.41-0.63,1.41-1.41c0,0,0,0,0,0V9.35c0.03-0.34,0.22-0.56,0.34-0.56c0.17,0,0.36,0.17,0.36,0.45v4.35c0,0.78,0.63,1.4,1.4,1.4h1.34c0.78,0,1.4-0.63,1.4-1.4l-0.01-4.35c0.06-0.3,0.24-0.45,0.33-0.45c0.17,0,0.36,0.17,0.36,0.45v4.35c0,0.78,0.63,1.4,1.4,1.4h1.34c0.78,0,1.4-0.63,1.4-1.4v-0.36c0.91,1.23,2.34,1.96,3.87,1.96c0.7,0,1.39-0.15,2.02-0.45c0.23,0.16,0.51,0.25,0.8,0.25h1.32c0.29,0,0.57-0.09,0.8-0.25v1.91c0,0.78,0.63,1.4,1.4,1.4h1.33c0.78,0,1.4-0.63,1.4-1.4v-1.69c0.46,0.14,0.94,0.22,1.42,0.21c1.62,0,3.07-0.83,3.97-2.1v0.5c0,0.78,0.63,1.4,1.4,1.4h1.33c0.29,0,0.57-0.09,0.8-0.25c0.63,0.3,1.32,0.45,2.02,0.45c1.83,0,3.43-1.05,4.28-2.6c1.47,2.52,4.71,3.36,7.22,1.89c0.17-0.1,0.34-0.21,0.5-0.34c0.21,0.52,0.72,0.87,1.29,0.86h1.53c0.53,0,1.03-0.28,1.3-0.74l0.35-0.58l0.35,0.58c0.28,0.46,0.77,0.74,1.31,0.74h1.52c0.77,0,1.39-0.63,1.38-1.39C80.47,13.38,80.42,13.17,80.32,12.97L80.32,12.97z M34.15,13.81h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.76,0-1.39,0.67-1.51,1.54l0.01,4.44c0,0.12-0.1,0.22-0.22,0.22h-1.34c-0.12,0-0.22-0.1-0.22-0.22V9.24c0-0.93-0.7-1.63-1.54-1.63c-0.81,0-1.47,0.75-1.52,1.71v4.27c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.44c0.01-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.21,0.1,0.22,0.21v0.63c0.48-0.65,1.24-1.04,2.06-1.05h0.03c1.04,0,1.99,0.57,2.48,1.48c0.43-0.9,1.33-1.48,2.32-1.49c1.54,0,2.79,1.19,2.76,2.65l0.01,4.91C34.37,13.7,34.27,13.8,34.15,13.81C34.15,13.81,34.15,13.81,34.15,13.81z M43.78,13.59c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22v-0.71C41.34,13.6,40.4,14,39.42,14c-2.07,0-3.75-1.78-3.75-3.99s1.69-3.99,3.75-3.99c0.98,0,1.92,0.41,2.6,1.12v-0.7c0-0.12,0.1-0.22,0.22-0.22h1.33c0.11-0.01,0.21,0.08,0.22,0.2c0,0.01,0,0.01,0,0.02V13.59z M49.91,14c-0.98,0-1.92-0.41-2.6-1.12v3.78c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V6.45c0-0.12,0.1-0.21,0.22-0.21h1.33c0.12,0,0.22,0.1,0.22,0.22v0.7c0.68-0.72,1.62-1.12,2.6-1.12c2.07,0,3.75,1.77,3.75,3.98S51.98,14,49.91,14z M63.09,10.87C62.72,12.65,61.22,14,59.43,14c-0.98,0-1.92-0.41-2.6-1.12v0.7c0,0.12-0.1,0.22-0.22,0.22h-1.33c-0.12,0-0.22-0.1-0.22-0.22V3.37c0-0.12,0.1-0.22,0.22-0.22h1.33c0.12,0,0.22,0.1,0.22,0.22v3.78c0.68-0.71,1.62-1.12,2.6-1.11c1.79,0,3.29,1.33,3.66,3.12C63.21,9.73,63.21,10.31,63.09,10.87L63.09,10.87L63.09,10.87z M68.26,14.01c-1.9,0.01-3.55-1.29-3.97-3.14c-0.12-0.56-0.12-1.13,0-1.69c0.42-1.85,2.07-3.15,3.97-3.14c2.25,0,4.06,1.78,4.06,3.99S70.5,14.01,68.26,14.01L68.26,14.01z M79.09,13.81h-1.53c-0.12,0-0.23-0.06-0.29-0.16l-1.37-2.28l-1.37,2.28c-0.06,0.1-0.17,0.16-0.29,0.16h-1.53c-0.04,0-0.08-0.01-0.11-0.03c-0.09-0.06-0.12-0.18-0.06-0.27c0,0,0,0,0,0l2.31-3.5l-2.28-3.47c-0.02-0.03-0.03-0.07-0.03-0.11c0-0.11,0.09-0.2,0.2-0.2h1.53c0.12,0,0.23,0.06,0.29,0.16l1.34,2.25l1.34-2.25c0.06-0.1,0.17-0.16,0.29-0.16h1.53c0.04,0,0.08,0.01,0.11,0.03c0.09,0.06,0.12,0.18,0.06,0.27c0,0,0,0,0,0L76.96,10l2.31,3.5c0.02,0.03,0.03,0.07,0.03,0.11C79.29,13.72,79.2,13.81,79.09,13.81C79.09,13.81,79.09,13.81,79.09,13.81L79.09,13.81z"/><path class="st0" d="M10,1.21c-4.87,0-8.81,3.95-8.81,8.81s3.95,8.81,8.81,8.81s8.81-3.95,8.81-8.81C18.81,5.15,14.87,1.21,10,1.21z M14.18,12.19c-1.84,1.84-4.55,2.2-6.38,2.2c-0.67,0-1.34-0.05-2-0.15c0,0-0.97-5.37,2.04-8.39c0.79-0.79,1.86-1.22,2.98-1.22c1.21,0,2.37,0.49,3.23,1.35C15.8,7.73,15.85,10.5,14.18,12.19z"/><path class="st1" d="M10,0.02c-5.52,0-10,4.48-10,10s4.48,10,10,10s10-4.48,10-10C19.99,4.5,15.52,0.02,10,0.02z M10,18.83c-4.87,0-8.81-3.95-8.81-8.81S5.13,1.2,10,1.2s8.81,3.95,8.81,8.81C18.81,14.89,14.87,18.83,10,18.83z"/><path class="st1" d="M14.04,5.98c-1.75-1.75-4.53-1.81-6.2-0.14C4.83,8.86,5.8,14.23,5.8,14.23s5.37,0.97,8.39-2.04C15.85,10.5,15.8,7.73,14.04,5.98z M11.88,9.87l-0.87,1.78l-0.86-1.78L8.38,9.01l1.77-0.86l0.86-1.78l0.87,1.78l1.77,0.86L11.88,9.87z"/><polygon class="st0" points="13.65,9.01 11.88,9.87 11.01,11.65 10.15,9.87 8.38,9.01 10.15,8.15 11.01,6.37 11.88,8.15 "/></g></svg>);
background-size: 65px 20px;
}
See further details on proper attribution for Mapbox here.
Starting location
To specify a starting location, set the following attributes on the main kortjs-element. Kortjs defaults to Greenwich, England if no location is provided.
data-set-longitude
data-set-latitude
data-set-zoom
Example - New York City as starting location
<kort-js
data-url="TILE_SERVER_URL"
data-set-latitude="40.712778"
data-set-longitude="-74.006111"
data-set-zoom="10">
<p slot="attribution-text">...</p>
</kort-js>
Marker
A center marker can be provided using the marker-slot (slot="marker"
). By default, it is assumed the marker is pointing at the middle of its bottom edge. Change it using the data-offsetx
and data-offsety
attributes on the marker-element itself. The offset is measured in pixels from the marker's upper-left corner.
Example - Using a Google Fonts icon with default offsets
<kort-js data-url="https://tile.openstreetmap.org/${z}/${x}/${y}.png">
<p slot="attribution-text">© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
<svg slot="marker" part="marker" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M12 2C8 2 5 5 5 9c0 5 7 13 7 13s7-8 7-13c0-4-3-7-7-7zM7 9a5 5 0 0 1 10 0c0 3-3 7-5 10-2-3-5-7-5-10z" />
<circle part="marker-circle" cx="12" cy="9" r="2.5" />
</svg>
</kort-js>
Example - Using a Google Fonts icon with custom offsets
<kort-js data-url="https://tile.openstreetmap.org/${z}/${x}/${y}.png">
<p slot="attribution-text">© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
<svg slot="marker" part="marker" data-offsetx="-18" data-offsety="-18"xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M15.5 14h-.8l-.3-.3c1-1.1 1.6-2.6 1.6-4.2a6.5 6.5 0 1 0-2.3 5l.3.2v.8l5 5 1.5-1.5-5-5zm-6 0a4.5 4.5 0 1 1 0-9 4.5 4.5 0 0 1 0 9z"/>
</svg>
</kort-js>
🖌️ Styling
Main kortjs-element
By default, web components are inline. You are free to change the kortjs-element to a block-level element along with any other properties by targeting either kort-js
or using a class, id, etc.
Example - Styling the kortjs-element
kort-js {
display: block;
height: 400px;
width: 400px;
overflow: hidden;
border-radius: 12px;
}
Attribution slot-elements
The content provided to the attribution-text slot-element can be styled as normal with a class, id etc. or by targeting the slot="attribution-text"
attribute directly.
The container, in which the attribution-text slot-element sits, must be styled with the ::part(attribution-container)
pseudo-element. The name of the part is set by Kortjs and cannot be changed. Minimal default styling is provided by Kortjs.
The content provided to the attribution-icon slot-element can be styled as normal with a class, id etc. or by targeting the slot="attribution-icon"
attribute directly. No default styling is provided for this element.
Example - Styling the attribution-element
p[slot="attribution-text"] {
font-size: 16px;
}
kort-js::part(attribution-container){
background: white;
}
div[slot="attribution-icon"] {
...
}
Center marker slot-element
The marker slot-element must be styled using a ::part
pseudo-element. Any nested elements must likewise be styled using ::part
pseudo-elements. The names of these elements are set på you. You are free to name them as you see fit, e.g. part="marker"
. Minimal default styling is provided by Kortjs.
Example - Styling the marker and a nested element
<kort-js data-url="https://tile.openstreetmap.org/${z}/${x}/${y}.png">
<p slot="attribution-text">© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors</p>
<svg slot="marker" part="marker" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M12 2C8 2 5 5 5 9c0 5 7 13 7 13s7-8 7-13c0-4-3-7-7-7zM7 9a5 5 0 0 1 10 0c0 3-3 7-5 10-2-3-5-7-5-10z" />
<circle part="marker-circle" cx="12" cy="9" r="2.5" />
</svg>
</kort-js>
kort-js::part(marker){
fill: teal;
width: 128px;
height: 128px;
filter: drop-shadow(0 0.2rem 0.25rem rgba(0, 0, 0, 0.2));
}
kort-js::part(marker-circle){
fill: black;
}
Color of map background
The color of the map background is styled with the custom property --kortjs-backgroundColor
. The default color is #dddddd
.
Example - Setting the background to white
kort-js {
--kortjs-backgroundColor: white;
}
🚴 Reacting to lifecycle events
The attribute data-is-connected
on the kortjs-element is set in correspondence with the web component lifecycle callbacks: connectedCallback
and disconnectedCallback
.
The data-is-connected
attribute is added at the first occurence of connectedCallback
with a value of true
.
On disconnectedCallback
its value is set to false
.
The state of the kortjs-element can also be accessed in javascript with the native isConnected property.
Example - Hiding all slotted elements until Kortjs has loaded
kort-js * {
display: none;
}
kort-js[data-is-connected="true"] * {
display: revert;
}
📌 Use case - Location-picker
The first released version (0.1.0) focuses on the use case of interactively selecting a location using a slippy map instead of having to find and input coordinates manually. As such, any marker provided as a slotted element will be placed in the center of the map. Aside from panning and zooming, no other user interaction is supported in this version.
As the user pans and zooms around the map, a set of separate location attributes will be updated on the kortjs-element corresponding to the location in the center of the map. These are:
data-get-longitude
data-get-latitude
data-get-zoom
As the attributes use a data
prefix, the coordinates can be accessed with the dataset
property on the kortjs-element.
Example - Getting location on button press
const kortjs = document.getElementsByTagName("kort-js")[0];
const button = document.getElementById("myBytton");
button.addEventListener("click", () => {
const longitude = kortjs.dataset.getLongitude;
const latitude = kortjs.dataset.getLatitude;
const zoom = kortjs.dataset.getZoom;
console.log(longitude, latitude, zoom);
});
⚠️ Known issues
Missing referer header on tile-requests in Chromium-based browsers
In Chromium-based browsers, fetch-requests made by a worker spawned using a blob-url will not include a referer header. The worker in Kortjs is spawned this way.
The missing referer header can lead to some tile-servers blocking the requests. Most notably the OpenStreetMaps tile-server uses the referer header to throttle incoming requests and blacklists clients if usage is deemed outside of the provided guidelines. Due to the missing referer header, requests from different clients may be seen as coming from just one, increasing the risk of getting blacklisted.
🌲 Browser support
Kortjs has been tested in the newest versions of Chrome (desktop and Android) and Firefox (desktop). Support in other browsers (and older versions) may be sporadic and/or nonexistent. Backwards-compatibility is not - and will not ever become - a priority. Refer to other map-libraries for backwards-compatibility.
Safari has been left out due to the author - that's me! - not having access to a debuggable instance.
License
Kortjs is available under the MIT license