> ## 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 (heredado)

> Referencia del DmsListElement heredado. Para nuevas integraciones, usa ChannelListElement de @whop/elements.

## Descripción general

Un elemento de interfaz que muestra una lista de DMs.

## Uso

### Uso básico

```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");
```

### Escuchar eventos

```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");
  },
});
```

## Eventos

Eventos emitidos por el DmListElement.

Escucha estos eventos con el método `on()` o pasando funciones de callback en las opciones.

### `error`

Se emite cuando se produce un error durante la inicialización o el funcionamiento del elemento.

**Firma del callback:** (error: `unknown`) => void

### `ready`

Se emite cuando el elemento ha terminado de cargarse y está listo para la interacción del usuario.

**Firma del callback:** (element: `DmsListElement`) => void

### `optionsUpdated`

Se emite cuando las opciones del elemento se actualizan mediante `updateOptions()`.

**Firma del callback:** (options: [`DmsListElementOptions`](#dmslistelementoptions)) => void

### `snapshot`

Se emite cuando cambia el estado interno del elemento.

**Firma del callback:** (snapshot: [`DmsListElementSnapshot`](#dmslistelementsnapshot)) => void

### `channelSelected`

Se emite cuando el usuario hace clic en un canal.

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

## Métodos

### `mount(container)`

Monta el elemento en un contenedor del DOM.

El contenedor debe ser un elemento vacío. El elemento se añadirá como hijo.
Si el elemento ya está montado, este método registrará una advertencia y terminará.

| Parámetro | Tipo | Descripción |
| - | - | - |
| `container` | `HTMLElement` \| `#$\{`string`\}` | El elemento contenedor o un selector CSS que empiece por '#' |

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

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

### `unmount()`

Elimina el elemento del DOM y limpia todos los listeners de eventos.

Después de desmontarla, la instancia del elemento no debe reutilizarse.
Crea una nueva instancia del elemento si necesitas volver a montarlo.

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

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

### `updateOptions(options)`

Actualiza las opciones de configuración del elemento después de su creación.

Solo se actualizarán las opciones proporcionadas; las demás opciones no cambian.
El elemento se volverá a renderizar con las nuevas opciones.

| Parámetro | Tipo | Descripción |
| - | - | - |
| `options` | `Partial`\<[`DmsListElementOptions`](#dmslistelementoptions)> | Objeto de opciones parcial con los valores que se van a actualizar |

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

### `getSnapshot()`

Obtiene la instantánea del estado actual del elemento.

La instantánea contiene el estado interno actual del elemento, como el
estado de carga, los valores del formulario u otros datos específicos del elemento.

**Devuelve:** [`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);
});
```

## Estilos

Personaliza este elemento con `appearance.classes`. Consulta la [referencia de estilos](https://docs.whop.com/es/sdk/elements/styling-reference.md) para ver la lista completa de nombres de clase estables y fragmentos de ejemplo.

## Tipos

### DmsListElementOptions

Opciones de configuración del DmsListElement.

| Propiedad | Tipo | Obligatorio | Valor predeterminado | Descripción |
| - | - | - | - | - |
| `companyId` | `string \| undefined` | No | - | El ID de la cuenta por la que filtrar los canales. |
| `selectedChannel` | `string \| undefined` | No | - | El ID del canal seleccionado actualmente. |
| `emptyState` | `EmptyStateOptions \| undefined` | No | - | Estado vacío personalizado que se muestra cuando no hay canales. |
| `onReady` | `((element: DmsListElement) => void) \| undefined` | No | - | Callback que se ejecuta cuando el elemento ha terminado de cargarse y está listo para la interacción. Equivale a escuchar el evento 'ready'. |
| `onEvent` | `((event: DmsListElementEvent) => void) \| undefined` | No | - | Callback que se ejecuta cuando se emite un evento del elemento de lista de DMs. |

### DmsListElementSnapshot

Representa el estado actual del DmsListElement.

Usa `element.getSnapshot()` para obtener el estado actual, o escucha el evento `snapshot` para detectar cambios.

| Propiedad | Tipo | Obligatorio | Valor predeterminado | Descripción |
| - | - | - | - | - |
| `state` | `"ready" \| "loading"` | Sí | - | El estado de carga actual del elemento. - '"loading"': el elemento se está inicializando - '"ready"': el elemento está completamente cargado y es interactivo |


## Related topics

- [Incrustar el Channel List Element](https://docs.whop.com/es/developer/guides/chat/dms-list-element.md)
- [Sesiones de Element (heredado)](https://docs.whop.com/es/sdk/elements/overview.md)
- [ListElement](https://docs.whop.com/es/elements/latest/wallet/balances-list.md)
