> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# DmsListElement (ancienne version)

> Référence de l'ancien DmsListElement. Pour les nouvelles intégrations, utilisez ChannelListElement de @whop/elements.

## Vue d'ensemble

Un élément d'interface qui affiche une liste de DM.

## Utilisation

### Utilisation de base

```typescript theme={null}
// Create the element
const element = session.createElement("dms-list-element", {
  onReady: (element) => {
    console.log("Dms list element is ready");
  },
});

// Mount it to a container
element.mount("#dms-list-container");
```

### Écouter les événements

```typescript theme={null}
const element = session.createElement("dms-list-element", {});

element.on("ready", () => {
  console.log("Dms list element is ready");
});

element.on("channelSelected", (ev) => {
  console.log("Channel selected:", ev.detail.id);
});

element.mount("#dms-list-container");
```

```typescript theme={null}
const element = session.createElement("dms-list-element", {
  onReady: (element) => {
    console.log("Dms list element is ready");
  },
});
```

## Événements

Événements émis par le DmListElement.

Écoutez ces événements avec la méthode `on()` ou en passant des fonctions de rappel dans les options.

### `error`

Émis lorsqu'une erreur se produit pendant l'initialisation ou le fonctionnement de l'élément.

**Signature du callback :** (error: `unknown`) => void

### `ready`

Émis lorsque l'élément a fini de se charger et est prêt pour l'interaction de l'utilisateur.

**Signature du callback :** (element: `DmsListElement`) => void

### `optionsUpdated`

Émis lorsque les options de l'élément sont mises à jour via `updateOptions()`.

**Signature du callback :** (options: [`DmsListElementOptions`](#dmslistelementoptions)) => void

### `snapshot`

Émis lorsque l'état interne de l'élément change.

**Signature du callback :** (snapshot: [`DmsListElementSnapshot`](#dmslistelementsnapshot)) => void

### `channelSelected`

Émis lorsque l'utilisateur clique sur un canal.

**Signature du callback :** (ev: `CustomEvent`\<\{ id: `string`; }>) => void

## Méthodes

### `mount(container)`

Monte l'élément dans un conteneur du DOM.

Le conteneur doit être un élément vide. L'élément y sera ajouté en tant qu'enfant.
Si l'élément est déjà monté, cette méthode affiche un avertissement dans la console et s'arrête.

| Paramètre | Type | Description |
| - | - | - |
| `container` | `HTMLElement` \| `#$\{`string`\}` | L'élément conteneur ou un sélecteur CSS commençant par '#' |

```typescript theme={null}
// Using a selector
element.mount("#my-container");

// Using an element reference
const container = document.getElementById("my-container");
element.mount(container);
```

### `unmount()`

Retire l'élément du DOM et supprime tous les écouteurs d'événements.

Après le démontage, l'instance de l'élément ne doit pas être réutilisée.
Créez une nouvelle instance de l'élément si vous devez le monter à nouveau.

```typescript theme={null}
// Unmount when done
element.unmount();

// Commonly used in event handlers
element.on("complete", () => {
  element.unmount();
});
```

### `updateOptions(options)`

Met à jour les options de configuration de l'élément après sa création.

Seules les options fournies sont mises à jour ; les autres options restent inchangées.
L'élément se réaffiche avec les nouvelles options.

| Paramètre | Type | Description |
| - | - | - |
| `options` | `Partial`\<[`DmsListElementOptions`](#dmslistelementoptions)> | Objet d'options partiel contenant les valeurs à mettre à jour |

```typescript theme={null}
// Update a single option
element.updateOptions({
  onComplete: (ev) => {
    console.log("New handler!");
  },
});
```

### `getSnapshot()`

Récupère l'instantané de l'état actuel de l'élément.

L'instantané contient l'état interne actuel de l'élément, comme
le statut de chargement, les valeurs de formulaire ou d'autres données propres à l'élément.

**Renvoie :** [`DmsListElementSnapshot`](#dmslistelementsnapshot)

```typescript theme={null}
const snapshot = element.getSnapshot();
console.log("Current state:", snapshot.state);

// Or listen for changes
element.on("snapshot", (snapshot) => {
  console.log("State changed:", snapshot);
});
```

## Style

Personnalisez cet élément avec `appearance.classes`. Consultez la [référence de style](https://docs.whop.com/fr/sdk/elements/styling-reference.md) pour la liste complète des noms de classes stables et des exemples d'extraits.

## Types

### DmsListElementOptions

Options de configuration du DmsListElement.

| Propriété | Type | Obligatoire | Par défaut | Description |
| - | - | - | - | - |
| `companyId` | `string \| undefined` | Non | - | L'ID du compte selon lequel filtrer les canaux. |
| `selectedChannel` | `string \| undefined` | Non | - | L'ID du canal actuellement sélectionné. |
| `emptyState` | `EmptyStateOptions \| undefined` | Non | - | État vide personnalisé affiché lorsqu'il n'y a aucun canal. |
| `onReady` | `((element: DmsListElement) => void) \| undefined` | Non | - | Callback déclenché lorsque l'élément a fini de se charger et est prêt pour l'interaction. Équivaut à écouter l'événement 'ready'. |
| `onEvent` | `((event: DmsListElementEvent) => void) \| undefined` | Non | - | Callback déclenché lorsqu'un événement de l'élément de liste de DM est émis. |

### DmsListElementSnapshot

Représente l'état actuel du DmsListElement.

Utilisez `element.getSnapshot()` pour obtenir l'état actuel, ou écoutez l'événement `snapshot` pour suivre les changements.

| Propriété | Type | Obligatoire | Par défaut | Description |
| - | - | - | - | - |
| `state` | `"ready" \| "loading"` | Oui | - | L'état de chargement actuel de l'élément. - '"loading"' - L'élément est en cours d'initialisation - '"ready"' - L'élément est entièrement chargé et interactif |


## Related topics

- [Intégrer l'élément de liste des canaux](https://docs.whop.com/fr/developer/guides/chat/dms-list-element.md)
- [Sessions Element (ancienne version)](https://docs.whop.com/fr/sdk/elements/overview.md)
- [ChatElement (ancienne version)](https://docs.whop.com/fr/sdk/elements/chat-element.md)
