Class Diagram — klin

Vista previa#

Herencia y composición. 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.

herencia vertical entre vehículo, auto y moto

composición y dependencia en módulo de pedidos

clases solo con nombre unidas por asociación simple

Uso#

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

import { ChartTooltipPortal, ClassDiagram } from "@carlos-burelo/klin";
import "@carlos-burelo/klin/styles.css";
 
<ChartTooltipPortal>
<ClassDiagram
  nodes={/* … */}
  edges={/* … */}
  ariaLabel="Class 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/class-diagram.tsx)

/**
 * Demo Clases UML del site (no se publica en el bundle de la lib).
 */
import { ChartTooltipPortal, ClassDiagram } from "@carlos-burelo/klin";
 
export default function ClassDiagramDemo() {
  return (
    <ChartTooltipPortal>
      <ClassDiagram
        ariaLabel="Diagrama de clases del módulo de pedidos"
        nodes={[
          {
            id: "pedido",
            name: "Pedido",
            attributes: ["id: string", "total: number"],
            methods: ["confirmar()", "cancelar()"],
          },
          {
            id: "linea",
            name: "Línea",
            attributes: ["cantidad: number", "precio: number"],
            methods: ["subtotal()"],
          },
          {
            id: "cliente",
            name: "Cliente",
            attributes: ["nombre: string"],
            methods: ["comprar()"],
          },
        ]}
        edges={[
          {
            from: "linea",
            to: "pedido",
            kind: "composition",
            label: "contiene",
          },
          { from: "cliente", to: "pedido", kind: "association", label: "crea" },
        ]}
      />
    </ChartTooltipPortal>
  );
}

Props#

13 props · 3 requeridas

Prop	Tipo	Descripción
nodes req	ClassNode[]	Nodos del diagrama (ids únicos, etiquetas).
edges req	ClassEdge[]	Aristas entre nodos (origen, destino, etiqueta opcional).
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.
showMethods opc	boolean	Muestra la sección de métodos de cada clase.
showAttributes opc	boolean	Muestra la sección de atributos de cada clase.
visibility opc	'all' \| 'public'	Filtra miembros por visibilidad (`public` conserva `+` y sin prefijo).
memberLimit opc	number	Máximo de miembros visibles por clase; el resto se colapsa en `+N más`.
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: ClassDiagramProps en class-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: class-diagram.tsx
Guías: SSR-first · Tema · Tooltip