ER Diagram — klin

Vista previa#

Entidades y cardinalidad. Demo completa con datos realistas, renderizada en el servidor. Más abajo están las configuraciones, una por una.

Ejemplos#

Todas las configuraciones del componente, cada una viva y con datos propios. Cambia entre Preview y Code en cada tarjeta y copia lo que necesites.

dirección horizontal con claves foráneas y cardinalidad 1:N

dirección vertical con relación uno a uno

Uso#

Ejemplo mínimo con las props requeridas. Copia, pega y cambia los datos:

import { ChartTooltipPortal, ErDiagram } from "@carlos-burelo/klin";
import "@carlos-burelo/klin/styles.css";
 
<ChartTooltipPortal>
<ErDiagram
  entities={/* … */}
  relations={/* … */}
  ariaLabel="ER Diagram"
/>
</ChartTooltipPortal>

SSR-first

La gráfica es función pura de props a SVG: el HTML llega renderizado y sin JS se ve completa. Envuelve en ChartTooltipPortal solo si quieres tooltip rico; sin JS queda \<title\> nativo. Lee la guía /docs/ssr-first una vez y listo.

Código de esta demo#

Ver fuente (src/demos/er-diagram.tsx)

/**
 * Demo Entidad-relación del site (no se publica en el bundle de la lib).
 */
import { ChartTooltipPortal, ErDiagram } from "@carlos-burelo/klin";
 
export default function ErDiagramDemo() {
  return (
    <ChartTooltipPortal>
      <ErDiagram
        ariaLabel="Diagrama entidad-relación de tienda"
        entities={[
          {
            id: "cliente",
            name: "Cliente",
            attributes: [
              { key: "PK", name: "id" },
              { name: "nombre" },
              { name: "correo" },
            ],
          },
          {
            id: "pedido",
            name: "Pedido",
            attributes: [
              { key: "PK", name: "id" },
              { key: "FK", name: "cliente_id" },
              { name: "fecha" },
            ],
          },
          {
            id: "producto",
            name: "Producto",
            attributes: [
              { key: "PK", name: "id" },
              { name: "nombre" },
              { name: "precio" },
            ],
          },
        ]}
        relations={[
          { from: "cliente", label: "1:N", to: "pedido" },
          { from: "pedido", label: "N:M", to: "producto" },
        ]}
      />
    </ChartTooltipPortal>
  );
}

Props#

12 props · 3 requeridas

Prop	Tipo	Descripción
entities req	ErEntity[]	Sin descripción aún — pide docs.
relations req	ErRelation[]	Sin descripción aún — pide docs.
ariaLabel req	string	Etiqueta descriptiva del SVG (role=img). Describe la conclusión, no solo el tipo.
direction opc	'TB' \| 'LR'	Sin descripción aún — pide docs.
showKeys opc	boolean	Muestra las insignias de clave (`PK`/`FK`) en los atributos.
crowFoot opc	boolean	Dibuja pata de gallo en el extremo múltiple (`N`/`M`) de cada relación.
showWeak opc	boolean	Resalta con doble borde las entidades débiles (`weak`).
emptyTitle opc	string	Título del estado vacío (por defecto EMPTY_TITLE).
emptyDescription opc	string	Descripción del estado vacío.
className opc	string	Clase extra en el contenedor (aditivo, no rompe estilos).
style opc	CSSProperties	Estilos inline extra en el contenedor.
ariaDescribedBy opc	string	Id de un texto largo que describe la gráfica (opcionales detalles).

Tipo completo: ErDiagramProps en er-diagram.tsx.

Accesibilidad#

Toda gráfica exige ariaLabel descriptivo; el SVG usa role="img" con \<title\>.
Cada forma lleva \<title\> nativo (tooltip sin JS) y data-chart-tip para el portal rico.
Sin datos se renderiza estado vacío homogéneo (ChartEmpty), nunca SVG roto.
Detalle del contrato en /docs/accesibilidad.

Recursos#

Fuente del componente: er-diagram.tsx
Guías: SSR-first · Tema · Tooltip