Arc Rider Docs · Markdown

Mini Widgets

Custom KPI Bar

KpiBar en React

Muestra varias métricas con etiqueta y acción de clic opcional, unas junto a otras.

Referencia para @arcrider/arcwidgets-react@0.1.0-alpha.5. <a href="/docs/react/intro/setup-react">Instalación</a> · <a href="/docs/react/intro/react-components">Todos los componentes</a>.

Ejemplo completo

Props del componente

id

ID de DOM opcional. No es necesario en el uso normal; se genera automáticamente si se omite.

data

Configuración de tipo ArcWidgetKpiBarData. Pasa los cambios como objetos nuevos; gestiona los datos de negocio y la selección en el estado de React.

onAction

Fallback opcional (type: string, ...args: unknown[]) => unknown. El callback concreto tiene prioridad. Detalles: <a href="/docs/react/patterns/react-state-events">Estado y eventos</a>.

onClick

Se ha pulsado una tarjeta con clickable: true. Recibe el evento de clic del DOM y el índice (base 0) de la tarjeta en cards.

onClick?: (event: MouseEvent, cardIndex: number) => void;

Configuración

Los siguientes campos pertenecen a data. Los tamaños se indican como strings, los números y valores de tiempo según su tipo respectivo.

settings

Altura de la barra y aspecto por defecto de todas las tarjetas: height (por defecto auto), gap (separa las tarjetas), border.radius (redondea la barra o cada tarjeta separada, por defecto 8px), colorLabel (#566eb1), fontSizeLabel (13px), colorValue (#3e6fff), fontSizeValue (35px), backgroundColor (#f7f8fc), borderColor (#e5e5e5).

Tipo: ArcWidgetKpiBarSettings.

cards

Tarjetas de métricas en orden de visualización: title, value, subtitle, clickable y settings por tarjeta. Los settings de una tarjeta sobrescriben los colores y tamaños de fuente de la barra y admiten un width fijo.

Tipo: ArcWidgetKpiBarCard[].

Comportamiento y límites

  • cards contiene valores y etiquetas; settings, los ajustes de visualización comunes.
  • Activa clickable por tarjeta. onClick(event, cardIndex) puede cambiar un filtro o navegar en tu aplicación.
  • title, value y subtitle se renderizan como strings HTML; aquí no se admiten elementos JSX ni descriptores de widget. Escapa el texto no fiable antes de pasarlo.

Tipos de datos

Estos tipos relacionados con el widget se exportan desde el paquete. También están disponibles tipos comunes como ArcWidgetSlot, ArcWidgetStyles y ArcReactWidgetProps. Los objetos de configuración son cerrados, por lo que una clave mal escrita o no admitida se notifica como error de tipo.

export interface ArcWidgetKpiBarCardSettings {
	colorLabel?: string;
	fontSizeLabel?: string;
	colorValue?: string;
	fontSizeValue?: string;
	backgroundColor?: string;
	borderColor?: string;
	width?: string;
}

export interface ArcWidgetKpiBarSettings { height?: string; gap?: string | number; border?: { radius?: string | number }; colorLabel?: string; fontSizeLabel?: string; colorValue?: string; fontSizeValue?: string; backgroundColor?: string; borderColor?: string; }

export interface ArcWidgetKpiBarCard { title?: string | number; value?: string | number; subtitle?: string | number; settings?: ArcWidgetKpiBarCardSettings; clickable?: boolean; }

export interface ArcWidgetKpiBarData { settings?: ArcWidgetKpiBarSettings; cards?: ArcWidgetKpiBarCard[]; }

export interface ArcWidgetKpiBarProps extends ArcReactWidgetProps&lt;ArcWidgetKpiBarData&gt; { onClick?: (event: MouseEvent, cardIndex: number) =&gt; void; }</code></pre>