perare-web-sdk

Welcome to Perare Web Sdk 👋

Perare WEB Sdk package for displaying Proplink-verified map-widget on your webstie

🏠 Homepage

Install

npm install perare-web-sdk

Add those two style files to the bundle (e.g. with Webpack)

- "mapbox-gl/dist/mapbox-gl.css",
- "perare-web-sdk/dist/index.css"

If you're using a CSS loader like webpack css-loader, you can import the CSS directly in your JavaScript/Typescript.

import 'mapbox-gl/dist/mapbox-gl.css';
import 'perare-web-sdk/dist/index.css';

Or add those css files as externally-added to bundle css files.

Bundle size

This package depends on mapbox-gl-js, which is quite big package. Almost all map initializations are cached, but to prevent increased initial-bundle size, use lazy-loading of component/module.

Usage

import { PerareWebSdk } from "perare-web-sdk";

// first you need to create and wait toapprove of proplink
const id = createdProplink.id;
PerareWebSdk.register({
    token: '<YOUR_TOKEN>',
    apiUrl: '<SANDBOX/PROD API URL>',
});

PerareWebSdk.drawMapBanner({
    container: document.getElementById('perare-map-banner'),
    proplinkId: id,
});

Demo page

Coming soon

Author

👤 Perare