Premium Widgets
Custom Slideshow
Slideshow en React
Muestra texto o HTML propio como secuencia de diapositivas. Adecuado para galerías de imágenes sencillas o avisos cambiantes.
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 ArcWidgetSlideshowData. 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>.
onSlideChange
Ha cambiado la diapositiva activa. Entrega el index de base cero en items.
onSlideChange?: (payload: ArcWidgetSlideshowSlideChangePayload) => 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.
items
Diapositivas en orden de visualización. value es texto plano, un string HTML o <image src=…> para una imagen a tamaño completo; label es el texto alternativo. Opcional por diapositiva: width, height, backgroundColor.
Tipo: ArcWidgetSlideshowItem[].
width
Ancho del widget. Valor por defecto: 100%.
Tipo: string.
height
Altura del widget, p. ej. "320px". Los valores porcentuales necesitan un contenedor padre con altura definida. Valor por defecto: 300px.
Tipo: string.
backgroundColor
Color de fondo detrás de las diapositivas. Valor por defecto: #f5f5f5.
Tipo: string.
borderRadius
Radio de las esquinas. Valor por defecto: 8px.
Tipo: string.
borderWidth
Grosor del borde, p. ej. "1px". Valor por defecto: 0px.
Tipo: string.
borderColor
Color del borde. Valor por defecto: transparent.
Tipo: string.
direction
Dirección de las diapositivas. Valor por defecto: horizontal.
Tipo: 'horizontal' | 'vertical'.
loop
Pasar de la última diapositiva a la primera y viceversa. Valor por defecto: true.
Tipo: boolean.
autoplay
Avance automático: enabled y speed en milisegundos entre diapositivas. Desactivado por defecto.
Tipo: ArcWidgetSlideshowAutoplay.
pause
Pausa el avance automático con hover o focus. Ambos se aplican si se omite pause; las claves que falten en tu objeto cuentan como false.
Tipo: ArcWidgetSlideshowPause.
transition
Animación de las diapositivas: duration en milisegundos y el easing CSS en transition. Valor por defecto: { duration: 300, transition: 'ease-in-out' }.
Tipo: ArcWidgetSlideshowTransition.
indicators
enabled muestra un punto por diapositiva. Los puntos se muestran si se omite indicators.
Tipo: ArcWidgetSlideshowIndicators.
Comportamiento y límites
items[].valueadmite actualmente strings, incluyendo HTML propio. JSX y los descriptores de widget anidados no se renderizan en este componente.
autoplay.speedytransition.durationse indican en milisegundos.onSlideChangeentrega unindexde base cero.
- El ejemplo de galería usa imágenes SVG generadas por sí mismo. El HTML con contenido dinámico externo debe sanearse 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 ArcWidgetSlideshowItem {
value?: string;
label?: string;
width?: string;
height?: string;
backgroundColor?: string;
}
export interface ArcWidgetSlideshowAutoplay { enabled?: boolean; speed: number; }
export interface ArcWidgetSlideshowPause { hover?: boolean; focus?: boolean; }
export interface ArcWidgetSlideshowTransition { duration: number; transition: 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear' | (string & {}); }
export interface ArcWidgetSlideshowIndicators { enabled?: boolean; }
export interface ArcWidgetSlideshowData { items: ArcWidgetSlideshowItem[]; width?: string; height?: string; backgroundColor?: string; borderRadius?: string; borderWidth?: string; borderColor?: string; direction?: 'horizontal' | 'vertical'; loop?: boolean; autoplay?: ArcWidgetSlideshowAutoplay; pause?: ArcWidgetSlideshowPause; transition?: ArcWidgetSlideshowTransition; indicators?: ArcWidgetSlideshowIndicators; }
export interface ArcWidgetSlideshowSlideChangePayload { index: number; }
export interface ArcWidgetSlideshowProps extends ArcReactWidgetProps<ArcWidgetSlideshowData> { onSlideChange?: (payload: ArcWidgetSlideshowSlideChangePayload) => void; }</code></pre>