Felt

---

const Felt: { embed: Promise<FeltController>; connect: Promise<FeltController>; }

The Felt SDK is a library for embedding Felt maps into your website, allowing you to control and inspect the map programmatically.

Type declaration

embed()

Embeds a Felt map into the provided container, returning a promise that resolves to a FeltController object that you can use to control the map.

Parameters

Parameter	Type	Description
container	HTMLElement	The container element to embed the map into.
mapId	string	The ID of the map to embed.
options?	FeltEmbedOptions	The options to configure the map.

Returns

Promise<FeltController>

A promise for a FeltController.

connect()

Binds to an existing Felt map iframe.

Parameters

Parameter	Type	Description
feltWindow	Pick<Window, "postMessage">	The iframe element containing the Felt map.

Returns

Promise<FeltController>