@mappedin/mappedin-js 4.0.16 → 4.0.19

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
@@ -1,7 +1,14 @@
1
- # Mappedin Web Renderer
1
+ # Mappedin Web SDK
2
2
 
3
+ ## Resources
4
+ - [Mappedin Developer Portal](https://developer.mappedin.com)
5
+ - [Web SDK V4 guides](https://developer.mappedin.com/guides/webv4/quickstart)
6
+ - [Release notes](https://developer.mappedin.com/blog/2021-11-23-web-sdk-v4-release-notes/)
7
+ - [Migration guide to V4](https://developer.mappedin.com/blog/2021-11-19-mappedin-web-sdk-v4-migration-guide/)
8
+ - [Trial Keys](https://developer.mappedin.com/guides/api-keys)
9
+ - [API Reference](https://developer.mappedin.com/docs/web/latest)
3
10
 
4
- ## How to use
11
+ ## Usage
5
12
 
6
13
  ### In ES6 modular apps, using NPM
7
14
 
@@ -47,7 +54,7 @@ Usage in the browser requires adding a script and link tags that point at the CD
47
54
  <title>Sample</title>
48
55
  <meta name="viewport" content="width=device-width,initial-scale=1" />
49
56
  <link rel="icon" href="favicon.ico" />
50
- <link rel="stylesheet" href="<MAPPEDIN_URL>/iife/index.css" />
57
+ <link rel="stylesheet" href="https://d1p5cqqchvbqmy.cloudfront.net/websdk/v4.0.16/mappedin.css" />
51
58
  </head>
52
59
  <body>
53
60
  <div data-key="" id="mappedin-map"></div>
@@ -59,7 +66,7 @@ Usage in the browser requires adding a script and link tags that point at the CD
59
66
  height: 100%;
60
67
  }
61
68
  </style>
62
- <script src="<MAPPEDIN_URL>/iife/index.js"></script>
69
+ <script src="https://d1p5cqqchvbqmy.cloudfront.net/websdk/v4.0.16/mappedin.js"></script>
63
70
  <script>
64
71
  async function init() {
65
72
  const venue = await Mappedin.getVenue(
@@ -89,24 +96,24 @@ The Mappedin SDK supports ESM (EcmaScriptModules), meaning we can import files d
89
96
  <html>
90
97
  <head>
91
98
  <meta charset="utf-8" />
92
- <title>Sample</title>
99
+ <title>Mappedin Sample</title>
93
100
  <meta name="viewport" content="width=device-width,initial-scale=1" />
94
101
  <link rel="icon" href="favicon.ico" />
95
- <link rel="stylesheet" href="<MAPPEDIN_URL>/esm/renderer/index.css" />
102
+ <link rel="stylesheet" href="https://d1p5cqqchvbqmy.cloudfront.net/websdk/v4.0.16/esm/renderer/index.css" />
96
103
  </head>
97
104
  <body>
98
- <div data-key="" id="mappedin-map"></div>
105
+ <div id="mappedin-map"></div>
99
106
  <style>
100
107
  body,
101
108
  html,
102
109
  #mappedin-map {
103
110
  width: 100%;
104
111
  height: 100%;
112
+ position: relative
105
113
  }
106
114
  </style>
107
115
  <script type="module">
108
-
109
- import { getVenue, showVenue } from '<MAPPEDIN_URL>/esm/renderer/index.js';
116
+ import { getVenue, showVenue } from 'https://d1p5cqqchvbqmy.cloudfront.net/websdk/v4.0.16/esm/renderer/index.js';
110
117
 
111
118
  async function init() {
112
119
  const venue = await getVenue(
@@ -129,7 +136,7 @@ The Mappedin SDK supports ESM (EcmaScriptModules), meaning we can import files d
129
136
 
130
137
  ### Using get-venue or navigator modules without the renderer
131
138
 
132
- Both `get-venue` and `navigator` can be used separately, without loading the renderer. This is useful for applications that need access to Mappedin API data and/or Directions engine, but without needing a renderer.
139
+ Both `get-venue` and `navigator` packages can be used separately, without loading the renderer. This is useful for applications that need access to Mappedin API data and/or Directions engine, but without needing a renderer.
133
140
 
134
141
  ```javascript
135
142
  import getVenue from '@mappedin/mappedin-js/lib/esm/get-venue';
@@ -145,7 +152,3 @@ async function init() {
145
152
  }
146
153
  document.addEventListener('DOMContentLoaded', init);
147
154
  ```
148
-
149
- ### Adding mappedin-js CSS styles into your app
150
-
151
- TBD...