radar-sdk-js

Website | Blog | Documentation | Support

⚡ Use Radar SDKs and APIs to add location context to your apps with just a few lines of code. ⚡

🔥 Try it! 🔥

• Geofencing
• Maps APIs
• Maps UI
• Autocomplete UI

🚀 Installation and Usage

With npm

> Note: The Radar JS SDK has a peer dependency on maplibre-gl-js.

Add the radar-sdk-js and maplibre-gl packages

# with npm
npm install --save radar-sdk-js maplibre-gl

# with yarn
yarn add radar-sdk-js maplibre-gl

Then import as an ES Module in your project

import Radar from 'radar-sdk-js';
import 'radar-sdk-js/dist/radar.css'

// initialize with your test or live publishable key
Radar.initialize('prj_test_pk_...', { /* options */ });

In your html

> The MapLibre dependency is not necessary to install when using installation with the script tag.

Add the following script in your html file

Then initialize the Radar SDK

Quickstart

Create a map

To create a map, first initialize the Radar SDK with your publishable key. Then specify the HTML element where you want to render the map, by providing the element's ID, or the element object itself.

  
    
    
  

  
    <div style="width: 100%; height: 500px;" id="map">

    
  

> Remember to provide a width and height on the element the map is being rendered to

Create an autocomplete input

To create an autocomplete input, first initialize the Radar SDK with your publishable key. Then specify the HTML element where you want to render the input.

  
    
    
  

  
    <div id="autocomplete">

    
  

Geofencing

To power geofencing experiences on the web, use the Track API to grab the user's current location for geofence and event detection.

See more examples and usage in the Radar web SDK documentation here.

🔗 Other links

• Contributing
• Migrating from 3.x to 4.x

📫 Support

Have questions? We're here to help! Email us at support@radar.com.