Arc Rider Docs · Markdown

Mini Widgets

Custom Steps

Steps en React

Muestra el progreso en un formulario de varios pasos. La navegación y la validación las controlas en React.

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 ArcWidgetStepsData. 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 el valor de un paso con clickable: true. Recibe el evento de clic del DOM y el índice (base 0) del paso en steps.

onClick?: (event: MouseEvent, stepIndex: 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

Disposición y aspecto por defecto de todos los pasos: height (por defecto 100%), colorLabel (#566eb1), fontSizeLabel (13px), colorValue (#3E6FFF), fontSizeValue (35px), backgroundColor para la barra, los valores y la línea (#f7f8fc), borderColor (#e5e5e5), alignX ('left' | 'center' | 'right', por defecto center), stepWidth como ancho mínimo de paso, gapY entre título, valor y subtítulo, stepRadius para el valor y connectionLine con show (por defecto true) y height (por defecto 3px).

Tipo: ArcWidgetStepsSettings.

steps

Pasos en orden de visualización: title, value, subtitle como texto plano, clickable, un width fijo y, por paso, colorLabel, fontSizeLabel, colorValue, fontSizeValue y backgroundColor, que sobrescriben settings.

Tipo: ArcWidgetStepsStep[].

Comportamiento y límites

  • Deriva la etiqueta y los colores de cada paso a partir de tu estado; los pasos clicables necesitan clickable: true.
  • onClick(event, stepIndex) notifica el paso pulsado. Comprueba las entradas del paso actual antes de cambiar.
  • title, value y subtitle se muestran como texto plano; los elementos JSX y el HTML no se renderizan.

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 ArcWidgetStepsConnectionLine {
	show?: boolean;
	height?: string;
}

export interface ArcWidgetStepsSettings { height?: string; colorLabel?: string; fontSizeLabel?: string; colorValue?: string; fontSizeValue?: string; backgroundColor?: string; borderColor?: string; alignX?: 'left' | 'center' | 'right'; stepWidth?: string; gapY?: string; stepRadius?: string; connectionLine?: ArcWidgetStepsConnectionLine; }

export interface ArcWidgetStepsStep { title?: string | number; value?: string | number; subtitle?: string | number; colorLabel?: string; fontSizeLabel?: string; colorValue?: string; fontSizeValue?: string; backgroundColor?: string; width?: string; clickable?: boolean; }

export interface ArcWidgetStepsData { settings?: ArcWidgetStepsSettings; steps?: ArcWidgetStepsStep[]; }

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