Referencia de API

Páginas por símbolo para cada componente, hook y tipo de error público que exporta el SDK.

Secciones

• Componentes - cada componente de React en el happy path.
• Hooks - acceso por hook a los mismos flujos que manejan los componentes.
• Errores - RiftApiError, cada code registrado y las extensions tipadas que lleva cada uno.

Convenciones de página

Cada página de referencia sigue la misma forma para que puedas escanear una vez y leer el resto más rápido:

1. Introducción - una oración: qué es el símbolo y para qué sirve.
2. Uso básico - el bloque de código ejecutable más pequeño.
3. Referencia - la tabla de props (componentes) o tablas Parameters / Returns (hooks/funciones). Cada entrada tiene su propio H3 con descripción, valor por defecto y un ejemplo de código cuando aporta claridad.
4. Ejemplos - snippets con título de tarea que muestran desviaciones comunes del ejemplo básico.
5. Relacionado - enlaces a componentes, hooks y guías compañeras.

Cada página agrega una sección Version history cuando el SDK publique su primera versión numerada. Mientras la superficie es pre-release, la sección se omite para no dar una señal falsa de changelog.

La referencia usa tres estilos de callout, cada uno con un significado especifico:

Note Contexto adicional neutral que vale la pena conocer pero no bloquea al lector.

Tip Mejora opcional: una forma más rápida o más limpia de hacer lo mismo.

Warning El lector puede dañar estado, perder datos o violar un contrato. Siempre es accionable.