# Felt

***

> `const` **Felt**: { `embed`: `Promise`<[`FeltController`](https://developers.felt.com/js-sdk-api-reference/main/feltcontroller)>; `connect`: `Promise`<[`FeltController`](https://developers.felt.com/js-sdk-api-reference/main/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](https://developers.felt.com/js-sdk-api-reference/main/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`](https://developers.felt.com/js-sdk-api-reference/main/feltembedoptions) | The options to configure the map.            |

#### Returns

`Promise`<[`FeltController`](https://developers.felt.com/js-sdk-api-reference/main/feltcontroller)>

A promise for a [FeltController](https://developers.felt.com/js-sdk-api-reference/main/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`](https://developers.felt.com/js-sdk-api-reference/main/feltcontroller)>