Premium Widgets
Custom Calendar Timeline
CalendarTimeline en React
Muestra periodos de tiempo por recurso u objeto en un eje de tiempo compartido.
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 ArcWidgetCalendarTimelineData. 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>.
onEntryClick
Fila de recurso y cita de la barra pulsada. rowIndex cuenta las filas de la lista items aplanada (los padres antes que sus hijos); entryIndex es de base 0 en los timeEntries de esa fila.
onEntryClick?: (rowIndex: number, entryIndex: number) => void;
onEntryDragSave
Fin del arrastre: startData (antes) y endData (destino) — persiste endData; la fila destino es rowChange.row_index. El modo día envía dateFrom / dateTo, el modo hora timeFrom / timeTo.
onEntryDragSave?: (
rowIndex: number,
entryIndex: number,
startData: ArcWidgetCalendarTimelineEntryDragSavePayload,
rowChange: ArcWidgetCalendarTimelineRowChangePayload,
endData: ArcWidgetCalendarTimelineEntryDragSavePayload
) => void;
onLabelClick
Fila de recurso y columna de etiqueta (base 0) de la celda pulsada. Solo se dispara para celdas con clickable: true.
onLabelClick?: (rowIndex: number, columnIndex: number) => void;
onGhostClick
Fila de recurso e inicio de columna del botón más pulsado: milisegundos epoch en modo día, milisegundos desde medianoche en modo hora.
onGhostClick?: (rowIndex: number, columnValue: 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.
mode
Tipo de columna: "day" muestra días, "time" muestra las horas de un día. Valor por defecto: "time" si timeSettings está establecido; si no, "day".
Tipo: 'day' | 'time'.
width
Ancho del widget, p. ej. "100%".
Tipo: string.
height
Altura del widget, p. ej. "320px". "auto" crece con las filas; los valores porcentuales necesitan un contenedor padre con altura definida.
Tipo: string.
minHeight / maxHeight
Límites para height: "auto", p. ej. "600px"; por encima de maxHeight el eje de tiempo se desplaza.
Tipo: string.
timeZoneBalance
Desplazamiento en horas que se suma a las etiquetas de hora de las barras, p. ej. -1. Valor por defecto: 0.
Tipo: number.
weekStart
Primer día de la semana por defecto cuando dateSettings.startDate no está establecido: 1 = lunes … 7 = domingo. Valor por defecto: 1.
Tipo: number.
dateSettings
Rango visible, filas de cabecera y marcados. startDate (milisegundos epoch) es el primer día visible; las fechas de las entradas se colocan en relación con él. endDate (exclusivo) o duration (días, por defecto 7) define la longitud.
Tipo: ArcWidgetCalendarTimelineDateSettings.
timeSettings
Horas visibles en modo hora, en horas: startTime (por defecto 0), amount por columna (por defecto 1) y duration (por defecto 12).
Tipo: ArcWidgetCalendarTimelineTimeSettings.
columns
Columnas de etiqueta izquierdas de los recursos. Sin columnas se muestra una columna de labelWidth.
Tipo: ArcWidgetCalendarTimelineColumn[].
labelWidth
Ancho de las columnas de etiqueta sin width propio. Valor por defecto: "120px".
Tipo: string.
items
Filas de recurso con sus celdas de etiqueta, timeEntries, marcados, botón más (ghost) y filas hijas (items).
Tipo: ArcWidgetCalendarTimelineItem[].
maxItemDepth
Profundidad máxima de anidación de items; 0 muestra solo las filas de primer nivel. Sin límite por defecto.
Tipo: number.
collapsible
Permite plegar las filas padre mediante su primera celda de etiqueta. Por defecto: desactivado.
Tipo: ArcWidgetCalendarTimelineCollapsible.
dayWidth
Ancho mínimo de una columna de día, p. ej. "120px".
Tipo: string.
columnWidth
Ancho mínimo de una columna de día o de hora; tiene prioridad sobre dayWidth.
Tipo: string.
rowHeight
Altura mínima de una fila de recurso. Valor por defecto: "80px".
Tipo: string.
currentTime
true muestra una línea de la hora actual; un string de color define además su color. Valor por defecto: false.
Tipo: boolean | string.
zoomSettings
Zoom del ancho de día: límites, paso, persistencia y los botones de más/menos. El zoom está activado por defecto.
Tipo: ArcWidgetCalendarTimelineZoomSettings.
lang
Locale para las etiquetas de fecha. Valor por defecto: "de".
Tipo: string.
styles
Marco, líneas de la cuadrícula, superficies, tonos de texto y franjas de día.
Tipo: ArcWidgetCalendarTimelineStyles.
Comportamiento y límites
- Para JSX en citas usa
customLayoutotooltip.value. Los campos estándartitle,subtitleyvaluese procesan como texto o HTML. Las celdas de etiqueta y el título de la cabecera admiten strings HTML o descriptores de widget, no JSX.
- Los valores de fecha son milisegundos epoch en la misma base de tiempo que
dateSettings.startDate; las horas son milisegundos desde el inicio del día (9 * 3600000= 09:00). Consulta <a href="/docs/react/patterns/react-dates">Fecha y hora</a>.
clickable: trueactiva la selección. Un índice de callback no es un ID de registro; resuélvelo mediante tu lista actual de entradas.
- Arrastre: establece
draggable: trueen la entrada. CallbackonEntryDragSave(rowIndex, entryIndex, startData, rowChange, endData)— persisteendDatay la fila destino derowChange.row_index. Sindraggable: truela entrada no se puede arrastrar.
itemscontiene filas de recurso, dentro de las cuales están lostimeEntries.columnsdefine las columnas de etiqueta izquierdas.
onEntryClick(rowIndex, entryIndex)usa dos índices.dayWidthyzoomSettingscontrolan la escala.
Los campos ArcWidgetSlot admitidos permiten elementos JSX individuales, texto o descriptores de widget. Pasa texto externo como texto JSX; los strings HTML se interpretan como HTML. <a href="/docs/react/patterns/nested-widget-descriptors">Combinar contenidos</a>.
Tipos de datos
Estos tipos relacionados con el widget se exportan desde el paquete. También están disponibles tipos comunes como ArcWidgetSlot, ArcWidgetCssStyles, ArcNestedWidgetDescriptor 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 type ArcWidgetCalendarTimelineBorderLine =
| boolean
| {
enabled?: boolean;
color?: string;
width?: string;
};
export interface ArcWidgetCalendarTimelineBorders { color?: string; width?: string; outer?: ArcWidgetCalendarTimelineBorderLine; columns?: ArcWidgetCalendarTimelineBorderLine; rows?: ArcWidgetCalendarTimelineBorderLine; }
export interface ArcWidgetCalendarTimelineDayStripes { enabled?: boolean; odd?: string; even?: string; }
export interface ArcWidgetCalendarTimelineStyles { borders?: ArcWidgetCalendarTimelineBorders; borderColor?: string; borderSize?: string; borderRadius?: string; backgroundColor?: string; headerBackgroundColor?: string; groupBackgroundColor?: string; rowBackgroundColor?: string; fontColor?: string; mutedColor?: string; subtleColor?: string; fontSize?: string; dayStripes?: boolean | ArcWidgetCalendarTimelineDayStripes; }
export interface ArcWidgetCalendarTimelineTitleSlot { value?: string | ArcNestedWidgetDescriptor; customLayout?: string | ArcNestedWidgetDescriptor; alignX?: 'left' | 'center' | 'right'; fontSize?: string; fontColor?: string; fontWeight?: string | number; backgroundColor?: string; }
export interface ArcWidgetCalendarTimelineLabelBreakpoint { below: number; label: string; }
export interface ArcWidgetCalendarTimelineDaysHeader { visible?: boolean; label?: string; labelBreakpoints?: ArcWidgetCalendarTimelineLabelBreakpoint[]; hideBelow?: number; compactRanges?: boolean; monthCompactBelow?: number; backgroundColor?: string; fontColor?: string; fontSize?: string; fontWeight?: string | number; alignX?: 'left' | 'center' | 'right'; sticky?: 'left'; stickyPadding?: number | string; }
export interface ArcWidgetCalendarTimelineGroupHighlight { month?: number; week?: number; color?: string; }
export interface ArcWidgetCalendarTimelineGroupHeader { visible?: boolean; label?: string; hideBelow?: number; backgroundColor?: string; fontColor?: string; fontSize?: string; fontWeight?: string | number; alignX?: 'left' | 'center' | 'right'; sticky?: 'left'; stickyPadding?: number | string; highlights?: ArcWidgetCalendarTimelineGroupHighlight[]; }
export interface ArcWidgetCalendarTimelineHeader { backgroundColor?: string; fontColor?: string; title?: string | ArcNestedWidgetDescriptor | ArcWidgetCalendarTimelineTitleSlot; days?: ArcWidgetCalendarTimelineDaysHeader; months?: ArcWidgetCalendarTimelineGroupHeader; weeks?: ArcWidgetCalendarTimelineGroupHeader; }
export interface ArcWidgetCalendarTimelineHighlightStyles { backgroundColor?: string; borderColor?: string; borderSize?: string; borders?: Pick<ArcWidgetCalendarTimelineBorders, 'color' | 'width' | 'columns' | 'rows'>; }
export interface ArcWidgetCalendarTimelineHighlight { date?: number | string; weekday?: number; dateFrom?: number; dateTo?: number; timeFrom?: number; timeTo?: number; hour?: number; color?: string; styles?: ArcWidgetCalendarTimelineHighlightStyles; }
export interface ArcWidgetCalendarTimelineDateHighlight extends ArcWidgetCalendarTimelineHighlight { applyToRows?: boolean; title?: { label?: string; }; }
export interface ArcWidgetCalendarTimelineDateSettings { startDate?: number; endDate?: number; duration?: number; header?: ArcWidgetCalendarTimelineHeader; highlights?: ArcWidgetCalendarTimelineDateHighlight[]; }
export interface ArcWidgetCalendarTimelineTimeSettings { startTime?: number; amount?: number; duration?: number; }
export interface ArcWidgetCalendarTimelineColumn { title?: string; subtitle?: string; width?: string; alignX?: 'left' | 'center' | 'right'; alignY?: 'top' | 'center' | 'bottom'; fontSize?: string; fontWeight?: string | number; backgroundColor?: string; fontColor?: string; }
export interface ArcWidgetCalendarTimelineItemColumn { title?: string; subtitle?: string; customLayout?: string | ArcNestedWidgetDescriptor; clickable?: boolean; alignX?: 'left' | 'center' | 'right'; alignY?: 'top' | 'center' | 'bottom'; fontSize?: string; fontWeight?: string | number; }
export interface ArcWidgetCalendarTimelineItemStyles { backgroundColor?: string; fontSize?: string; fontWeight?: string | number; }
export interface ArcWidgetCalendarTimelineGhost { title?: string; clickable?: boolean; position?: 'bottomRight' | 'bottomLeft' | 'topRight' | 'topLeft' | 'timeEntry'; styles?: ArcWidgetCssStyles; }
export interface ArcWidgetCalendarTimelineEntryLabel { value?: string | number; width?: 'fraction' | 'auto' | (string & {}); }
export interface ArcWidgetCalendarTimelineTooltipStyles { backgroundColor?: string; color?: string; borderRadius?: string; borderSize?: string; borderColor?: string; padding?: string; fontSize?: string; boxShadow?: string; }
export interface ArcWidgetCalendarTimelineTooltip { value?: ArcWidgetSlot; position?: 'top' | 'bottom' | 'left' | 'right' | 'auto'; width?: string; maxWidth?: string; maxHeight?: string; styles?: ArcWidgetCalendarTimelineTooltipStyles; }
export type ArcWidgetCalendarTimelineEntryStyles = ArcWidgetCssProperties;
export interface ArcWidgetCalendarTimelineTimeEntry { id?: string | number; title?: string | ArcWidgetCalendarTimelineEntryLabel; subtitle?: string | ArcWidgetCalendarTimelineEntryLabel; direction?: 'vertical' | 'horizontal'; value?: string; customLayout?: ArcWidgetSlot; dateFrom?: number; dateTo?: number; timeFrom?: number; timeTo?: number; styles?: ArcWidgetCalendarTimelineEntryStyles; clickable?: boolean; draggable?: boolean; tooltip?: ArcWidgetCalendarTimelineTooltip; }
export interface ArcWidgetCalendarTimelineItem { id?: string | number; title?: string; subtitle?: string; styles?: ArcWidgetCalendarTimelineItemStyles; fontSize?: string; fontWeight?: string | number; columns?: ArcWidgetCalendarTimelineItemColumn[]; timeEntries?: ArcWidgetCalendarTimelineTimeEntry[]; highlights?: ArcWidgetCalendarTimelineHighlight[]; ghost?: ArcWidgetCalendarTimelineGhost; items?: ArcWidgetCalendarTimelineItem[]; }
export interface ArcWidgetCalendarTimelineCollapsible { enabled?: boolean; iconCollapse?: string; iconExpand?: string; iconPosition?: 'left' | 'right'; }
export interface ArcWidgetCalendarTimelineZoomControls { enabled?: boolean; position?: 'bottomRight'; }
export interface ArcWidgetCalendarTimelineZoomSettings { enabled?: boolean; defaultDayWidth?: number | string; minDayWidth?: number | string; maxDayWidth?: number | string; step?: number | string; persist?: boolean; controls?: ArcWidgetCalendarTimelineZoomControls; }
export interface ArcWidgetCalendarTimelineData { mode?: 'day' | 'time'; width?: string; height?: string; minHeight?: string; maxHeight?: string; lang?: string; timeZoneBalance?: number; weekStart?: number; dateSettings?: ArcWidgetCalendarTimelineDateSettings; timeSettings?: ArcWidgetCalendarTimelineTimeSettings; columns?: ArcWidgetCalendarTimelineColumn[]; labelWidth?: string; items?: ArcWidgetCalendarTimelineItem[]; maxItemDepth?: number; collapsible?: ArcWidgetCalendarTimelineCollapsible; dayWidth?: string; columnWidth?: string; rowHeight?: string; currentTime?: boolean | string; zoomSettings?: ArcWidgetCalendarTimelineZoomSettings; styles?: ArcWidgetCalendarTimelineStyles; }
export interface ArcWidgetCalendarTimelineEntryDragSavePayload { dateFrom?: number; dateTo?: number; timeFrom?: number; timeTo?: number; }
export interface ArcWidgetCalendarTimelineRowChangePayload { start_row_index: number; row_index: number; }
export interface ArcWidgetCalendarTimelineProps extends ArcReactWidgetProps<ArcWidgetCalendarTimelineData> { onEntryClick?: (rowIndex: number, entryIndex: number) => void; onEntryDragSave?: ( rowIndex: number, entryIndex: number, startData: ArcWidgetCalendarTimelineEntryDragSavePayload, rowChange: ArcWidgetCalendarTimelineRowChangePayload, endData: ArcWidgetCalendarTimelineEntryDragSavePayload ) => void; onLabelClick?: (rowIndex: number, columnIndex: number) => void; onGhostClick?: (rowIndex: number, columnValue: number) => void; }</code></pre>