Ir al contenido

API del paquete

FrameKit publica un pequeño conjunto de puntos de entrada explícitos del paquete. Importa únicamente desde estas rutas; el paquete no expone su árbol src/ como una API para consumidores.

  • API principal — las definiciones de plantillas compartidas, los campos, la validación, los auxiliares de datos y Markdown.
  • API del cliente — el componente de cliente utilizado por la página privada de renderizado.
  • API del editor — componentes interactivos del editor y de navegación.
  • API de códigos QR — códigos QR SVG con un div contenedor fácil de posicionar en plantillas.
  • API de Next.js — el wrapper de configuración de Next.js compatible.
  • API de Studio — la superficie de Studio del lado del cliente y sus mensajes y tipos.
  • API raíz de Studio — fábricas de documentos y páginas del lado del servidor para las rutas de Studio.
  • API de desarrollo — utilidades avanzadas del lado del servidor para descubrimiento, generación de código y supervisión.
  • API del servidor — manejadores de Node.js y contratos de renderizado del lado del servidor.
  • Hoja de estilos — el punto de entrada CSS publicado.

El paquete es exclusivamente ESM. Sus rangos de dependencias peer son Next.js >=16 <17, React >=19 <20 y React DOM >=19 <20. El paquete requiere Node.js >=22.13.0; el requisito del gestor de paquetes es pnpm >=11.14.0.

Para configurar un proyecto, consulta integrar un proyecto existente de Next.js. Para el contrato de plantillas, consulta la referencia de plantillas.