@geospatial-sdk/elements 0.0.5-dev.44 → 0.0.5-dev.46

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.
Files changed (6) hide show
  1. package/README.md +29 -5
  2. package/dist/index.d.ts +6 -0
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +6 -1
  5. package/lib/index.ts +7 -1
  6. package/package.json +4 -4
package/README.md CHANGED
@@ -1,11 +1,35 @@
1
- # `elements`
1
+ # `@geospatial-sdk/elements`
2
2
 
3
- > TODO: description
3
+ <!-- #region body -->
4
4
 
5
- ## Usage
5
+ This package provides framework-agnostic [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) built with [Lit](https://lit.dev/) that allow you to display interactive maps using the Map Context model.
6
+
7
+ ## Installation
6
8
 
9
+ ```sh
10
+ npm install @geospatial-sdk/elements
7
11
  ```
8
- const openlayers = require('elements');
9
12
 
10
- // TODO: DEMONSTRATE API
13
+ ## Usage
14
+
15
+ ```html
16
+ <script type="module">
17
+ import "@geospatial-sdk/elements";
18
+
19
+ const mapElement = document.querySelector("geosdk-map");
20
+ mapElement.context = {
21
+ layers: [
22
+ { type: "xyz", url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png" },
23
+ ],
24
+ view: { center: [6, 48.5], zoom: 5 },
25
+ };
26
+ </script>
27
+
28
+ <geosdk-map style="width: 800px; height: 600px;"></geosdk-map>
11
29
  ```
30
+
31
+ <!-- #endregion body -->
32
+
33
+ ## Documentation
34
+
35
+ For more detailed API documentation, see the [documentation website](https://camptocamp.github.io/geospatial-sdk/docs/).
package/dist/index.d.ts CHANGED
@@ -1,2 +1,8 @@
1
+ /**
2
+ * {@include ../README.md#body}
3
+ *
4
+ * @hideGroups
5
+ * @module 📦 elements
6
+ */
1
7
  export * from "./map-element.js";
2
8
  //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,kBAAkB,CAAC"}
package/dist/index.js CHANGED
@@ -1,2 +1,7 @@
1
- // PUBLIC API
1
+ /**
2
+ * {@include ../README.md#body}
3
+ *
4
+ * @hideGroups
5
+ * @module 📦 elements
6
+ */
2
7
  export * from "./map-element.js";
package/lib/index.ts CHANGED
@@ -1,2 +1,8 @@
1
- // PUBLIC API
1
+ /**
2
+ * {@include ../README.md#body}
3
+ *
4
+ * @hideGroups
5
+ * @module 📦 elements
6
+ */
7
+
2
8
  export * from "./map-element.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geospatial-sdk/elements",
3
- "version": "0.0.5-dev.44+44c94a2",
3
+ "version": "0.0.5-dev.46+b8d315e",
4
4
  "description": "Custom elements provided by the SDK",
5
5
  "keywords": [
6
6
  "web",
@@ -33,8 +33,8 @@
33
33
  "lit": "^3.2.1"
34
34
  },
35
35
  "dependencies": {
36
- "@geospatial-sdk/core": "^0.0.5-dev.44+44c94a2",
37
- "@geospatial-sdk/openlayers": "^0.0.5-dev.44+44c94a2"
36
+ "@geospatial-sdk/core": "^0.0.5-dev.46+b8d315e",
37
+ "@geospatial-sdk/openlayers": "^0.0.5-dev.46+b8d315e"
38
38
  },
39
- "gitHead": "44c94a2e3458beb7e3f3ffc98ed170c21a0fc460"
39
+ "gitHead": "b8d315eaf71bccb50823f6e11c18c045ab1b6c5d"
40
40
  }