utopia-ui 1.0.4 → 1.0.5
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 +20 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,30 +15,40 @@ Map UI is a JavaScript Map Library to create nice and easy to use Maps
|
|
|
15
15
|
|
|
16
16
|
### Getting Started
|
|
17
17
|
|
|
18
|
+
|
|
18
19
|
install via npm
|
|
19
20
|
```
|
|
20
21
|
npm install utopia-ui
|
|
21
22
|
```
|
|
22
23
|
|
|
23
|
-
import in your React App
|
|
24
|
-
|
|
24
|
+
then import in your React App
|
|
25
25
|
```
|
|
26
|
-
import
|
|
26
|
+
import UtopiaMap from 'utopia-ui'
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
use the Map UI Component
|
|
30
|
-
|
|
29
|
+
use the [Map UI Component](/docs/utopia-ui/map-components/map)
|
|
31
30
|
```
|
|
32
|
-
<
|
|
31
|
+
<UtopiaMap>
|
|
32
|
+
height='360px'
|
|
33
|
+
width='100vw'
|
|
34
|
+
center={[51.3, 9.6]}
|
|
35
|
+
zoom={6}
|
|
36
|
+
places={places}
|
|
37
|
+
events={events}
|
|
38
|
+
</UtopiaMap>
|
|
33
39
|
```
|
|
34
40
|
|
|
35
41
|
### Options
|
|
36
42
|
|
|
37
43
|
|
|
38
|
-
Option | Type
|
|
39
|
-
--- | ---
|
|
40
|
-
height
|
|
41
|
-
width
|
|
44
|
+
Option | Type | Default | Required | Description
|
|
45
|
+
--- | --- | --- | --- | ---
|
|
46
|
+
`height` | `string` | - | | height of the map
|
|
47
|
+
`width` | `string` | - | | width of the map
|
|
48
|
+
`center` | `LatLngExpression`| - | | initial map position
|
|
49
|
+
`zoom` | `number` | - | | initial zoom level
|
|
50
|
+
`places` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| - | | Array with Items
|
|
51
|
+
`events` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item) | - | | Array with Items
|
|
42
52
|
|
|
43
53
|
|
|
44
54
|
## Coming Soon
|
package/package.json
CHANGED