Sankey Diagram — klin

Vista previa#

Flujos ponderados entre etapas. Demo completa con datos realistas, renderizada en el servidor. Más abajo están las configuraciones, una por una.

RegistroExamenAceptadosInscritosNo aceptados

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.

GeneraciónTransmisiónHogaresIndustria

flujos de energía con leyenda

embudo web con formato de miles y sin leyenda

PresaCanalParcelas

cadena corta con colores por nodo

Uso#

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

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

import { ChartTooltipPortal, SankeyDiagram } from "@carlos-burelo/klin";
 
/** Flujo de aspirantes desde registro hasta inscripción (personas). */
export default function SankeyDiagramDemo() {
  return (
    <ChartTooltipPortal>
      <SankeyDiagram
        ariaLabel="Flujo de aspirantes desde el registro hasta la inscripción"
        nodes={[
          { id: "registro", label: "Registro" },
          { id: "examen", label: "Examen" },
          { id: "aceptados", label: "Aceptados" },
          { id: "inscritos", label: "Inscritos" },
          { id: "rechazados", label: "No aceptados" },
        ]}
        flows={[
          { from: "registro", to: "examen", value: 8400 },
          { from: "examen", to: "aceptados", value: 3200 },
          { from: "examen", to: "rechazados", value: 5200 },
          { from: "aceptados", to: "inscritos", value: 2600 },
        ]}
      />
    </ChartTooltipPortal>
  );
}

Props#

11 props · 3 requeridas

Prop	Tipo	Descripción
nodes req	SankeyNode[]	Nodos del diagrama (ids únicos, etiquetas).
flows req	SankeyFlow[]	Sin descripción aún — pide docs.
ariaLabel req	string	Etiqueta descriptiva del SVG (role=img). Describe la conclusión, no solo el tipo.
format opc	(value: number) => string	Sin descripción aún — pide docs.
locale opc	string	Locale de formato (por defecto es-MX).
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).
showLegend opc	boolean	Muestra la leyenda HTML SSR (por defecto true donde aplica).

Tipo completo: SankeyDiagramProps en sankey-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: sankey-diagram.tsx
Guías: SSR-first · Tema · Tooltip