Steps

El componente Steps proporciona una interfaz para mostrar y navegar entre pasos en un proceso secuencial, permitiendo personalizar el contenido, la navegación y la apariencia de cada paso.

Ejemplo

Importación

Para importar el componente Steps, se puede hacer desde fenextjs

import { Steps } from "fenextjs";

Parámetros

ParámetroTipoRequeridoDefaultDescripcion
itemsStepsItemProps[][]Los elementos que representan cada paso, incluyendo el contenido, etiqueta, ícono y estado del paso.
defaultStepnumberno0El paso mostrado inicialmente.
stepnumbernoundefinedDefine manualmente el paso mostrado.
useArrowKeybooleannotrueIndica si se pueden usar las teclas de flecha para navegar entre los pasos.
btnPrevReactNodeno"Previous"Contenido del botón de retroceso.
btnNextReactNodeno"Next"Contenido del botón de avance.
disabledBtnPrevbooleannofalseDeshabilita el botón de retroceso.
disabledBtnNextbooleannofalseDeshabilita el botón de avance.
onPrev(step: number) => Promise<void> | voidnoundefinedFunción que se ejecuta al hacer click en el botón de retroceso.
onNext(step: number) => Promise<void> | voidnoundefinedFunción que se ejecuta al hacer click en el botón de avance.
onSetStep(step: number) => voidnoundefinedFunción que se ejecuta al establecer un nuevo paso.
stepPos'top' | 'left' | 'right'no'left'Posición de la lista de pasos.
showCurrentStepNStepbooleannofalseMuestra el paso actual junto al total de pasos.
useDogsbooleannofalseIndica si se debe utilizar un comportamiento especial (documentación adicional requerida).
classNamestringno""Clase CSS para el contenedor del componente.
classNameContentStepsstringno""Clase CSS para el contenedor de los pasos.
classNameListStepsstringno""Clase CSS para la lista de pasos.
classNameContentItemsstringno""Clase CSS para los elementos de contenido.
classNameStepstringno""Clase CSS para cada paso.
classNameStepActivestringno""Clase CSS para el paso activo.
classNameItemstringno""Clase CSS para cada ítem.
classNameItemActivestringno""Clase CSS para el ítem activo.
classNameStepCirclestringno""Clase CSS para el círculo del paso.
classNameStepLabelstringno""Clase CSS para la etiqueta del paso.
classNameContentBtnstringno""Clase CSS para el contenedor de los botones de navegación.
classNameBtnstringno""Clase CSS para los botones de navegación.
classNameBtnNextstringno""Clase CSS para el botón de avance.
classNameBtnPrevstringno""Clase CSS para el botón de retroceso.
forceShowBtnPrevbooleannofalseFuerza la visibilidad del botón de retroceso.
forceShowBtnNextbooleannofalseFuerza la visibilidad del botón de avance.

StepsItemProps

Los items de step tienen su propios parametros:

ParametroTipoDescripción
labelReactNodeLabel del elemento.
iconReactNodeIcon del elemento.
contentReactNodeContenido del elemento.
status"none" | "ok" | "error"Estatus del elemento.

Storybook

Para ver el storybook del componente lo puede hacer con este link (opens in a new tab)

Usos

  • Ejemplo básico
<Steps
  items={[{ label: "Paso 1", content: <div>Contenido del Paso 1</div> }]}
/>
  • Ejemplo con pasos personalizados
<Steps
  items={[
    { label: "Inicio", content: <div>Contenido Inicio</div> },
    { label: "Fin", content: <div>Contenido Fin</div> },
  ]}
  stepPos="top"
/>
  • Con botones deshabilitados
<Steps disabledBtnPrev={true} disabledBtnNext={true} />