Candlestick Chart — klin

Vista previa#

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

AlcistaBajista

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.

AlcistaBajista

Cinco sesiones con leyenda

Tipo de cambio con resistencia anotada y sin leyenda

AlcistaBajista

Precio del aguacate por kilo en central de abastos

Uso#

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

import { CandlestickChart, ChartTooltipPortal } from "@carlos-burelo/klin";
import "@carlos-burelo/klin/styles.css";
 
<ChartTooltipPortal>
<CandlestickChart
  data={/* … */}
  labelKey={/* … */}
  openKey={/* … */}
  highKey={/* … */}
  lowKey={/* … */}
  closeKey={/* … */}
  ariaLabel="Candlestick Chart"
/>
</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/candlestick-chart.tsx)

/**
 * Demo Velas OHLC del site (no se publica en el bundle de la lib).
 */
import { CandlestickChart, ChartTooltipPortal } from "@carlos-burelo/klin";
 
export default function CandlestickChartDemo() {
  return (
    <ChartTooltipPortal>
      <CandlestickChart
        ariaLabel="Velas semanales de América Móvil en la BMV de enero a febrero, con cierre al alza en 17.45 pesos"
        data={[
          {
            semana: "6 ene",
            apertura: 16.8,
            maximo: 17.05,
            minimo: 16.6,
            cierre: 16.95,
          },
          {
            semana: "13 ene",
            apertura: 16.95,
            maximo: 17.2,
            minimo: 16.75,
            cierre: 17.1,
          },
          {
            semana: "20 ene",
            apertura: 17.1,
            maximo: 17.25,
            minimo: 16.8,
            cierre: 16.85,
          },
          {
            semana: "27 ene",
            apertura: 16.85,
            maximo: 17.0,
            minimo: 16.5,
            cierre: 16.6,
          },
          {
            semana: "3 feb",
            apertura: 16.6,
            maximo: 16.95,
            minimo: 16.45,
            cierre: 16.9,
          },
          {
            semana: "10 feb",
            apertura: 16.9,
            maximo: 17.55,
            minimo: 16.85,
            cierre: 17.45,
          },
        ]}
        labelKey="semana"
        openKey="apertura"
        highKey="maximo"
        lowKey="minimo"
        closeKey="cierre"
        formatY={(v: number) =>
          new Intl.NumberFormat("es-MX", {
            style: "currency",
            currency: "MXN",
          }).format(v)
        }
      />
    </ChartTooltipPortal>
  );
}

Props#

23 props · 7 requeridas

Prop	Tipo	Descripción
data req	Array<Record<string, string \| number>>	Filas de datos (records). Valores no-finitos se tratan como 0, nunca NaN en SVG.
labelKey req	string	Clave de la etiqueta de cada parte.
openKey req	string	Sin descripción aún — pide docs.
highKey req	string	Sin descripción aún — pide docs.
lowKey req	string	Sin descripción aún — pide docs.
closeKey req	string	Sin descripción aún — pide docs.
ariaLabel req	string	Etiqueta descriptiva del SVG (role=img). Describe la conclusión, no solo el tipo.
height opc	number	Alto del SVG en px (ancho siempre fluido por viewBox).
formatY opc	ValueFormatter	Formateador del eje Y (por defecto es-MX).
locale opc	string	Locale de formato (por defecto es-MX).
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).
annotations opc	ValueAnnotation[]	Líneas de referencia SSR (valor + etiqueta + color opcional).
yMin opc	number	Mínimo fijo del dominio Y (indefinido = automático con cero).
yMax opc	number	Máximo fijo del dominio Y (indefinido = automático).
gridTicks opc	number	Ticks del grid horizontal (por defecto GRID_TICKS).
showValues opc	boolean	Muestra el valor de cierre sobre cada vela.
sortGroups opc	CandleSort	Orden de las velas por precio de cierre.
barRadius opc	number	Radio del cuerpo de la vela (por defecto BAR_RADIUS).
emptyTitle opc	string	Título del estado vacío (por defecto EMPTY_TITLE).
emptyDescription opc	string	Descripción del estado vacío.

Tipo completo: CandlestickChartProps en candlestick-chart.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: candlestick-chart.tsx
Guías: SSR-first · Tema · Tooltip

Vista previa#

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

AlcistaBajista

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.

AlcistaBajista

Cinco sesiones con leyenda

Tipo de cambio con resistencia anotada y sin leyenda

AlcistaBajista

Precio del aguacate por kilo en central de abastos

Uso#

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

import { CandlestickChart, ChartTooltipPortal } from "@carlos-burelo/klin";
import "@carlos-burelo/klin/styles.css";
 
<ChartTooltipPortal>
<CandlestickChart
  data={/* … */}
  labelKey={/* … */}
  openKey={/* … */}
  highKey={/* … */}
  lowKey={/* … */}
  closeKey={/* … */}
  ariaLabel="Candlestick Chart"
/>
</ChartTooltipPortal>

SSR-first

Código de esta demo#

Ver fuente (src/demos/candlestick-chart.tsx)

/**
 * Demo Velas OHLC del site (no se publica en el bundle de la lib).
 */
import { CandlestickChart, ChartTooltipPortal } from "@carlos-burelo/klin";
 
export default function CandlestickChartDemo() {
  return (
    <ChartTooltipPortal>
      <CandlestickChart
        ariaLabel="Velas semanales de América Móvil en la BMV de enero a febrero, con cierre al alza en 17.45 pesos"
        data={[
          {
            semana: "6 ene",
            apertura: 16.8,
            maximo: 17.05,
            minimo: 16.6,
            cierre: 16.95,
          },
          {
            semana: "13 ene",
            apertura: 16.95,
            maximo: 17.2,
            minimo: 16.75,
            cierre: 17.1,
          },
          {
            semana: "20 ene",
            apertura: 17.1,
            maximo: 17.25,
            minimo: 16.8,
            cierre: 16.85,
          },
          {
            semana: "27 ene",
            apertura: 16.85,
            maximo: 17.0,
            minimo: 16.5,
            cierre: 16.6,
          },
          {
            semana: "3 feb",
            apertura: 16.6,
            maximo: 16.95,
            minimo: 16.45,
            cierre: 16.9,
          },
          {
            semana: "10 feb",
            apertura: 16.9,
            maximo: 17.55,
            minimo: 16.85,
            cierre: 17.45,
          },
        ]}
        labelKey="semana"
        openKey="apertura"
        highKey="maximo"
        lowKey="minimo"
        closeKey="cierre"
        formatY={(v: number) =>
          new Intl.NumberFormat("es-MX", {
            style: "currency",
            currency: "MXN",
          }).format(v)
        }
      />
    </ChartTooltipPortal>
  );
}

Props#

23 props · 7 requeridas

Prop	Tipo	Descripción
data req	Array<Record<string, string \| number>>	Filas de datos (records). Valores no-finitos se tratan como 0, nunca NaN en SVG.
labelKey req	string	Clave de la etiqueta de cada parte.
openKey req	string	Sin descripción aún — pide docs.
highKey req	string	Sin descripción aún — pide docs.
lowKey req	string	Sin descripción aún — pide docs.
closeKey req	string	Sin descripción aún — pide docs.
ariaLabel req	string	Etiqueta descriptiva del SVG (role=img). Describe la conclusión, no solo el tipo.
height opc	number	Alto del SVG en px (ancho siempre fluido por viewBox).
formatY opc	ValueFormatter	Formateador del eje Y (por defecto es-MX).
locale opc	string	Locale de formato (por defecto es-MX).
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).
annotations opc	ValueAnnotation[]	Líneas de referencia SSR (valor + etiqueta + color opcional).
yMin opc	number	Mínimo fijo del dominio Y (indefinido = automático con cero).
yMax opc	number	Máximo fijo del dominio Y (indefinido = automático).
gridTicks opc	number	Ticks del grid horizontal (por defecto GRID_TICKS).
showValues opc	boolean	Muestra el valor de cierre sobre cada vela.
sortGroups opc	CandleSort	Orden de las velas por precio de cierre.
barRadius opc	number	Radio del cuerpo de la vela (por defecto BAR_RADIUS).
emptyTitle opc	string	Título del estado vacío (por defecto EMPTY_TITLE).
emptyDescription opc	string	Descripción del estado vacío.

Tipo completo: CandlestickChartProps en candlestick-chart.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: candlestick-chart.tsx
Guías: SSR-first · Tema · Tooltip