React Neshan Map Openlayers
An official React wrapper for neshan-map-openlayers library
## ⚙️ Before Install
You need a map key to use our map on your react web application.
You can signup and get a key from [Our Platfrom](https://platform.neshan.org/panel/api-key).
For more information, visit our [doc page](https://platform.neshan.org/sdk/react-component#).
## 📦 Install
```bash
npm install @neshan-maps-platform/react-openlayers
npm install @neshan-maps-platform/ol
```
```bash
yarn add @neshan-maps-platform/react-openlayers
yarn add @neshan-maps-platform/ol
```
## 🔨 Usage
```jsx
import {useEffect, useRef} from "react"
import {Map} from "@neshan-maps-platform/ol"
import NeshanMap, {NeshanMapRef} from "@neshan-maps-platform/react-openlayers"
function App() {
const mapRef = useRef(null)
const onInit = (map: Map) => {
map.setMapType("osm-bright")
map.switchTrafficLayer(true)
}
useEffect(() => {
if (mapRef.current?.map) {
mapRef.current?.map.switchTrafficLayer(true)
mapRef.current?.map.setMapType("standard-night")
}
}, [])
return (
)
}
export default App
```
### TypeScript
`@neshan-maps-platform/react-openlayers` is written in TypeScript with complete definitions.