Getting started

Last updated 1 month ago

Was this helpful?

Getting started

The Felt SDK allows you to embed, connect to and ultimately control Felt map embeds, enabling you to build powerful, interactive custom applications around Felt.

You are able to control many aspects of the Felt UI and map contents, as well as being notified of events happening in the map such as clicks, selections, etc.

This feature is available to customers on the . Reach out to .

Installation

Assuming you are using a modern JavaScript environment, install the SDK using your preferred package manager:

npm install @feltmaps/js-sdk

Create an HTML page with a container element:

<html>
  <body>
    <div id="container"></div>
  </body>
</html>

Embed a Felt map in your container element and use the SDK to control it:

import { Felt } from "@feltmaps/js-sdk";

const map = await Felt.embed(
  document.querySelector("#container"),
  "FELT_MAP_ID",
);
const layers = await map.getLayers();
const elements = await map.getElements();

React

PreviousProjects NextGeneral concepts

Last updated 1 month ago

Was this helpful?