antontranelis/utopia-ui
1
0
Fork 0
mirror of https://github.com/utopia-os/utopia-ui.git synced 2025-12-13 07:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
AT 2022-07-09 20:58:04 +02:00
parent 9b6143d46e
commit b0af669c16
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -15,30 +15,40 @@ Map UI is a JavaScript Map Library to create nice and easy to use Maps
### Getting Started
install via npm
```
npm install utopia-ui
```
import in your React App
then import in your React App
```
import Map from 'utopia-ui'
import UtopiaMap from 'utopia-ui'
```
use the Map UI Component
use the [Map UI Component](/docs/utopia-ui/map-components/map)
```
<Map height='100vh' width='100hw'></Map>
<UtopiaMap>
height='360px'
width='100vw'
center={[51.3, 9.6]}
zoom={6}
places={places}
events={events}
</UtopiaMap>
```
### Options
Option | Type | Default | Description
--- | --- | --- | ---
height | string | - | height of the map
width | string | - | width of the map
Option | Type | Default | Required | Description
--- | --- | --- | --- | ---
`height` | `string` | - | | height of the map
`width` | `string` | - | | width of the map
`center` | `LatLngExpression`| - | | initial map position
`zoom` | `number` | - | | initial zoom level
`places` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| - | | Array with Items
`events` | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item) | - | | Array with Items
## Coming Soon

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "utopia-ui",
"version": "1.0.4",
"version": "1.0.5",
"description": "Reuseable React Components to build mapping apps for all kinds of communities ",
"repository": "https://github.com/utopia-os/utopia-ui",
"homepage:": "https://utopia.os/",