https://github.com/r17x/rescript-mapbox-gl
(WIP) ReScript bind for mapbox-gl
https://github.com/r17x/rescript-mapbox-gl
mapbox-gl-js rescript rescript-bindings
Last synced: 4 days ago
JSON representation
(WIP) ReScript bind for mapbox-gl
- Host: GitHub
- URL: https://github.com/r17x/rescript-mapbox-gl
- Owner: r17x
- Created: 2021-03-27T14:42:52.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-05T13:26:54.000Z (almost 5 years ago)
- Last Synced: 2025-03-05T04:36:06.534Z (10 months ago)
- Topics: mapbox-gl-js, rescript, rescript-bindings
- Language: ReScript
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rescript-mapbox-gl
> 🚧 binding for [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js)
## Table of Content
* [Installation](#installation)
* [TODO](#todo)
* [Example](#example)
* [API](#api)
* [Contribution](#contribution)
* [License](#license)
## Installation
Run the following in your favorit console:
```console
> yarn add rescript-mapbox-gl
```
## TODO
> Legend: 🏗 WIP, 🚧 Isn't implemented
- [ ] [**Map**](https://docs.mapbox.com/mapbox-gl-js/api/map/) (🏗)
- [x] instance member (addControl,addControlWithOptions)
- [ ] [**Properties and Options**](https://docs.mapbox.com/mapbox-gl-js/api/properties/) (🏗)
- [ ] [**Markers and Control**](https://docs.mapbox.com/mapbox-gl-js/api/markers/) (🚧)
- [x] Marker instance member
- [ ] Marker Event
- [x] Popup instance member
- [ ] Popup Event
- [x] [**Geography and Geometry**](https://docs.mapbox.com/mapbox-gl-js/api/geography/) (🏗)
- [x] LngLat instance member
- [x] LngLat static member
- [x] LngLatBounds instance member
- [x] LngLatBounds static member
- [x] LngLatLike
- [x] LngLatBoundsLike
- [x] Point
- [x] PointLike
- [x] MercatorCoordinate instance member
- [x] MercatorCoordinate static member
- [x] EdgeInsets static member (1/3)
- [ ] [**User interaction handlers**](https://docs.mapbox.com/mapbox-gl-js/api/handlers/) (🚧)
- [ ] [**Sources**](https://docs.mapbox.com/mapbox-gl-js/api/sources/) (🚧)
- [ ] [**Events**](https://docs.mapbox.com/mapbox-gl-js/api/events/) (🚧)
## Example
```rescript
open Mapbox
// create Map
let map = Map.make() // new Map.map()
// create Map with Options
let mapWithOpt = Map.makeOptions(~container=Map.id("app-hash-in-dom"), ())->Map.makeWithOption
```
Or you can check this [**example**](tree/main/example).
## API
The API closely match with [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js). You can refer to the [mapbox-gl-js documentation](https://docs.mapbox.com/mapbox-gl-js)
## Contribution
Feel Free
## License
MIT