@fullcalendar/daygrid 7.0.0-beta.1 → 7.0.0-beta.4

package/internal.d.ts

@@ -1,17 +1,10 @@
-import { Seg, Slicer, DayTableModel, DateRange, DateProfileGenerator, DateEnv, BaseComponent, ViewProps, DateProfile, DateMarker, DateFormatter, Dictionary, DayTableCell, Hit, EventSegUiInteractionState, DateComponent, RefMap } from '@fullcalendar/core/internal';
-import { createElement, Ref, ComponentChild, VNode } from '@fullcalendar/core/preact';
-import '@fullcalendar/core';
+import { Slicer, DayGridRange, DayTableModel, DateRange, DateProfileGenerator, DateEnv, BaseComponent, ViewProps, DateMarker, DateProfile, DateFormatter, ViewContext, DayTableCell, Hit, EventRangeProps, EventSegUiInteractionState, DateComponent, ViewOptionsRefined, RefMap, SlicedCoordRange } from '@fullcalendar/core/internal';
+import { createElement, Ref, VNode } from '@fullcalendar/core/preact';
+import { CustomContentGenerator, ClassNamesGenerator, DidMountHandler, WillUnmountHandler, DayHeaderContentArg, CssDimValue } from '@fullcalendar/core';
 
-interface TableSeg extends Seg {
-    row: number;
-    firstCol: number;
-    lastCol: number;
-    isStandin?: boolean;
-}
-
-declare class DayTableSlicer extends Slicer<TableSeg, [DayTableModel]> {
+declare class DayTableSlicer extends Slicer<DayGridRange, [DayTableModel]> {
     forceDayIfListItem: boolean;
-    sliceRange(dateRange: DateRange, dayTableModel: DayTableModel): TableSeg[];
+    sliceRange(dateRange: DateRange, dayTableModel: DayTableModel): DayGridRange[];
 }
 
 declare class TableDateProfileGenerator extends DateProfileGenerator {
@@ -26,171 +19,110 @@ declare function buildDayTableRenderRange(props: {
 
 declare class DayGridView extends BaseComponent<ViewProps> {
     private buildDayTableModel;
-    private buildHeaderTiers;
+    private buildDateRowConfigs;
     private createDayHeaderFormatter;
     private slicer;
     render(): createElement.JSX.Element;
 }
 
-interface DateHeaderCellProps {
-    dateProfile: DateProfile;
-    todayRange: DateRange;
-    date: DateMarker;
-    navLink: boolean;
-    dayHeaderFormat: DateFormatter;
-    isSticky?: boolean;
+interface CellRenderConfig<RenderProps> {
+    generatorName: string;
+    customGenerator: CustomContentGenerator<RenderProps>;
+    classNameGenerator: ClassNamesGenerator<RenderProps>;
+    didMount: DidMountHandler<RenderProps & {
+        el: HTMLElement;
+    }>;
+    willUnmount: WillUnmountHandler<RenderProps & {
+        el: HTMLElement;
+    }>;
+}
+interface CellDataConfig<RenderProps> {
+    key: string;
+    renderProps: RenderProps;
+    className?: string;
+    attrs?: any;
+    innerAttrs?: any;
     colSpan?: number;
-    extraRenderProps?: Dictionary;
-    extraDataAttrs?: Dictionary;
-    extraClassNames?: string[];
-    colWidth?: number;
-    innerHeightRef?: Ref<number>;
-}
-declare class DateHeaderCell extends BaseComponent<DateHeaderCellProps> {
-    private innerElRef;
-    private disconectInnerHeight?;
-    render(): createElement.JSX.Element;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-}
+    isNavLink?: boolean;
+}
+interface RowConfig<RenderProps> {
+    renderConfig: CellRenderConfig<RenderProps>;
+    dataConfigs: CellDataConfig<RenderProps>[];
+}
+declare function buildDateRowConfigs(...args: Parameters<typeof buildDateRowConfig>): RowConfig<DayHeaderContentArg>[];
+declare function buildDateRowConfig(dates: DateMarker[], datesRepDistinctDays: boolean, dateProfile: DateProfile, todayRange: DateRange, dayHeaderFormat: DateFormatter, // TODO: rename to dateHeaderFormat?
+context: ViewContext, colSpan?: number): RowConfig<DayHeaderContentArg>;
+declare function buildDateRenderConfig(context: ViewContext): CellRenderConfig<DayHeaderContentArg>;
+declare function buildDateDataConfigs(dates: DateMarker[], datesRepDistinctDays: boolean, dateProfile: DateProfile, todayRange: DateRange, dayHeaderFormat: DateFormatter, // TODO: rename to dateHeaderFormat?
+context: ViewContext, colSpan?: number, keyPrefix?: string): CellDataConfig<DayHeaderContentArg>[];
 
-interface DayOfWeekHeaderCellProps {
-    dow: number;
-    dayHeaderFormat: DateFormatter;
+interface DayGridHeaderRowProps<RenderProps> extends RowConfig<RenderProps> {
     isSticky?: boolean;
-    colSpan?: number;
-    extraRenderProps?: Dictionary;
-    extraDataAttrs?: Dictionary;
-    extraClassNames?: string[];
-    colWidth?: number;
-    innerHeightRef?: Ref<number>;
-}
-declare class DayOfWeekHeaderCell extends BaseComponent<DayOfWeekHeaderCellProps> {
-    private innerElRef;
-    private disconectInnerHeight?;
-    render(): createElement.JSX.Element;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-}
-
-interface HeaderRowProps<Model, ModelKey> {
-    tierNum: number;
-    cells: Model[];
-    renderHeaderContent: (model: Model, tier: number, innerHeightRef: Ref<number> | undefined, // unused
-    width: number | undefined) => ComponentChild;
-    getHeaderModelKey: (model: Model) => ModelKey;
-    cellGroup?: boolean;
     className?: string;
+    height?: number;
     colWidth?: number;
-}
-declare class HeaderRow<Model, ModelKey> extends BaseComponent<HeaderRowProps<Model, ModelKey>> {
-    render(): createElement.JSX.Element;
-}
-
-interface HeaderRowAdvancedProps<Model, ModelKey> {
-    tierNum: number;
-    cells: Model[];
-    renderHeaderContent: (// TODO: better name
-    model: Model, tier: number, innerHeightRef: Ref<number> | undefined, width: number | undefined) => ComponentChild;
-    getHeaderModelKey: (model: Model) => ModelKey;
     innerHeightRef?: Ref<number>;
-    height: number | undefined;
-    colWidth?: number;
+    role?: string;
+    rowIndex?: number;
 }
-declare class HeaderRowAdvanced<Model, ModelKey> extends BaseComponent<HeaderRowAdvancedProps<Model, ModelKey>> {
+declare class DayGridHeaderRow<RenderProps extends {
+    text: string;
+    isDisabled: boolean;
+}> extends BaseComponent<DayGridHeaderRowProps<RenderProps>> {
     private innerHeightRefMap;
     private currentInnerHeight?;
     render(): createElement.JSX.Element;
     private handleInnerHeights;
 }
 
+declare function buildDayTableModel(dateProfile: DateProfile, dateProfileGenerator: DateProfileGenerator): DayTableModel;
+declare function computeColWidth(colCnt: number, colMinWidth: number, viewportWidth: number | undefined): [
+    canvasWidth: number | undefined,
+    colWidth: number | undefined
+];
+declare function computeColFromPosition(positionLeft: number, elWidth: number, colWidth: number | undefined, colCnt: number, isRtl: boolean): {
+    col: number;
+    left: number;
+    right: number;
+};
+declare function getRowEl(rootEl: HTMLElement, row: number): HTMLElement;
+declare function getCellEl(rowEl: HTMLElement, col: number): HTMLElement;
 declare function createDayHeaderFormatter(explicitFormat: DateFormatter, datesRepDistinctDays: any, dateCnt: any): DateFormatter;
 
-interface DayGridLayoutProps<HeaderCellModel, HeaderCellKey> {
+interface DayGridLayoutProps {
+    labelId: string | undefined;
+    labelStr: string | undefined;
     dateProfile: DateProfile;
     todayRange: DateRange;
     cellRows: DayTableCell[][];
     forPrint: boolean;
     isHitComboAllowed?: (hit0: Hit, hit1: Hit) => boolean;
     className: string;
-    headerTiers: HeaderCellModel[][];
-    renderHeaderContent: (model: HeaderCellModel, tier: number, innerHeightRef: Ref<number> | undefined, // unused... why do we have it then???
-    width: number | undefined) => ComponentChild;
-    getHeaderModelKey: (model: HeaderCellModel) => HeaderCellKey;
-    fgEventSegs: TableSeg[];
-    bgEventSegs: TableSeg[];
-    businessHourSegs: TableSeg[];
-    dateSelectionSegs: TableSeg[];
-    eventDrag: EventSegUiInteractionState<TableSeg> | null;
-    eventResize: EventSegUiInteractionState<TableSeg> | null;
+    headerTiers: RowConfig<{
+        text: string;
+        isDisabled: boolean;
+    }>[];
+    fgEventSegs: (DayGridRange & EventRangeProps)[];
+    bgEventSegs: (DayGridRange & EventRangeProps)[];
+    businessHourSegs: (DayGridRange & EventRangeProps)[];
+    dateSelectionSegs: (DayGridRange & EventRangeProps)[];
+    eventDrag: EventSegUiInteractionState<DayGridRange> | null;
+    eventResize: EventSegUiInteractionState<DayGridRange> | null;
     eventSelection: string;
 }
-declare class DayGridLayout<HeaderCellModel, HeaderCellKey> extends BaseComponent<DayGridLayoutProps<HeaderCellModel, HeaderCellKey>> {
+declare class DayGridLayout extends BaseComponent<DayGridLayoutProps> {
     private scrollerRef;
     private rowHeightRefMap;
     private scrollDate;
     render(): createElement.JSX.Element;
     componentDidMount(): void;
-    componentDidUpdate(prevProps: DayGridLayoutProps<unknown, unknown>): void;
+    componentDidUpdate(prevProps: DayGridLayoutProps): void;
     componentWillUnmount(): void;
     resetScroll(): void;
     updateScrollY: () => void;
-    clearScroll: () => void;
-}
-
-interface DayGridRowProps {
-    dateProfile: DateProfile;
-    todayRange: DateRange;
-    cells: DayTableCell[];
-    showDayNumbers: boolean;
-    showWeekNumbers?: boolean;
-    forPrint: boolean;
-    cellGroup?: boolean;
-    className?: string;
-    forceVSpacing?: boolean;
-    compact?: boolean;
-    fgEventSegs: TableSeg[];
-    bgEventSegs: TableSeg[];
-    businessHourSegs: TableSeg[];
-    dateSelectionSegs: TableSeg[];
-    eventDrag: EventSegUiInteractionState | null;
-    eventResize: EventSegUiInteractionState | null;
-    eventSelection: string;
-    dayMaxEvents: boolean | number;
-    dayMaxEventRows: boolean | number;
-    colWidth?: number;
-    minHeight?: number | string;
-    rootElRef?: Ref<HTMLElement>;
-    heightRef?: Ref<number>;
-    innerHeightRef?: Ref<number>;
-}
-interface DayGridRowState {
-    innerHeight?: number;
-    headerHeight?: number;
-    segHeightRev?: string;
-}
-declare const COMPACT_CELL_WIDTH = 80;
-declare class DayGridRow extends BaseComponent<DayGridRowProps, DayGridRowState> {
-    private rootEl;
-    private cellInnerHeightRefMap;
-    private cellHeaderHeightRefMap;
-    private segHeightRefMap;
-    private disconnectHeight?;
-    render(): createElement.JSX.Element;
-    renderFgSegs(segs: TableSeg[], segTops: {
-        [segStartId: string]: number;
-    }, todayRange: DateRange, forcedInvisibleMap: {
-        [instanceId: string]: any;
-    }, isDragging?: boolean, isResizing?: boolean, isDateSelecting?: boolean): VNode[];
-    renderFillSegs(segs: TableSeg[], fillType: string): VNode;
-    handleRootEl: (rootEl: HTMLElement) => void;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    private handleHeaderHeights;
-    private handleInnerHeights;
-    private handleSegHeights;
-    getMirrorSegs(): TableSeg[];
-    getHighlightSegs(): TableSeg[];
+    handleScrollEnd: ({ isUser }: {
+        isUser: boolean;
+    }) => void;
 }
 
 interface DayGridRowsProps {
@@ -199,21 +131,22 @@ interface DayGridRowsProps {
     cellRows: DayTableCell[][];
     forPrint: boolean;
     isHitComboAllowed?: (hit0: Hit, hit1: Hit) => boolean;
-    fgEventSegs: TableSeg[];
-    bgEventSegs: TableSeg[];
-    businessHourSegs: TableSeg[];
-    dateSelectionSegs: TableSeg[];
-    eventDrag: EventSegUiInteractionState<TableSeg> | null;
-    eventResize: EventSegUiInteractionState<TableSeg> | null;
+    className?: string;
+    dayMaxEvents?: number | boolean;
+    dayMaxEventRows?: number | boolean;
+    fgEventSegs: (DayGridRange & EventRangeProps)[];
+    bgEventSegs: (DayGridRange & EventRangeProps)[];
+    businessHourSegs: (DayGridRange & EventRangeProps)[];
+    dateSelectionSegs: (DayGridRange & EventRangeProps)[];
+    eventDrag: EventSegUiInteractionState<DayGridRange> | null;
+    eventResize: EventSegUiInteractionState<DayGridRange> | null;
     eventSelection: string;
     colWidth?: number;
     width?: number | string;
+    visibleWidth?: number;
     rowHeightRefMap?: RefMap<string, number>;
 }
-interface DayGridRowsState {
-    width?: number;
-}
-declare class DayGridRows extends DateComponent<DayGridRowsProps, DayGridRowsState> {
+declare class DayGridRows extends DateComponent<DayGridRowsProps> {
     private rootEl;
     private splitBusinessHourSegs;
     private splitBgEventSegs;
@@ -222,34 +155,66 @@ declare class DayGridRows extends DateComponent<DayGridRowsProps, DayGridRowsSta
     private splitEventDrag;
     private splitEventResize;
     private rowHeightRefMap;
-    private detachWidth?;
+    private disconnectWidth?;
     render(): createElement.JSX.Element;
     handleRootEl: (rootEl: HTMLDivElement) => void;
     componentDidMount(): void;
     componentWillUnmount(): void;
     queryHit(positionLeft: number, positionTop: number, elWidth: number): Hit;
 }
+declare function computeRowHeight(visibleWidth: number | undefined, // should INCLUDE any scrollbar width to avoid oscillation
+rowCnt: number, isHeightAuto: boolean, forPrint: boolean, options: ViewOptionsRefined): [minHeight: CssDimValue | undefined, isCompact: boolean];
 
-declare function buildDayTableModel(dateProfile: DateProfile, dateProfileGenerator: DateProfileGenerator): DayTableModel;
-declare function computeColWidth(colCnt: number, colMinWidth: number, viewportWidth: number | undefined): [
-    canvasWidth: number | undefined,
-    colWidth: number | undefined
-];
-type DateHeaderCellObj = {
-    date: DateMarker;
-    colSpan: number;
-};
-type DayOfWeekHeaderCellObj = {
-    dow: number;
-    colSpan: number;
+type DayRowRange = SlicedCoordRange;
+type DayRowEventRange = DayRowRange & EventRangeProps;
+type DayRowEventRangePart = DayRowEventRange & {
+    isSlice?: boolean;
+    standinFor?: DayRowEventRange;
 };
-type HeaderCellObj = DateHeaderCellObj | DayOfWeekHeaderCellObj;
-declare function computeColFromPosition(positionLeft: number, elWidth: number, colWidth: number | undefined, colCnt: number, isRtl: boolean): {
-    col: number;
-    left: number;
-    right: number;
-};
-declare function getRowEl(rootEl: HTMLElement, row: number): HTMLElement;
-declare function getCellEl(rowEl: HTMLElement, col: number): HTMLElement;
 
-export { COMPACT_CELL_WIDTH, DateHeaderCell, DateHeaderCellObj, DayGridLayout, DayGridLayoutProps, DayGridRow, DayGridRowProps, DayGridRows, DayGridView, DayOfWeekHeaderCell, DayOfWeekHeaderCellObj, DayTableSlicer, HeaderCellObj, HeaderRow, HeaderRowAdvanced, TableDateProfileGenerator, TableSeg, buildDayTableModel, buildDayTableRenderRange, computeColFromPosition, computeColWidth, createDayHeaderFormatter, getCellEl, getRowEl };
+interface DayGridRowProps {
+    dateProfile: DateProfile;
+    todayRange: DateRange;
+    cells: DayTableCell[];
+    showDayNumbers: boolean;
+    showWeekNumbers?: boolean;
+    forPrint: boolean;
+    className?: string;
+    isCompact?: boolean;
+    isTall?: boolean;
+    role?: string;
+    fgEventSegs: (SlicedCoordRange & EventRangeProps)[];
+    bgEventSegs: (SlicedCoordRange & EventRangeProps)[];
+    businessHourSegs: (SlicedCoordRange & EventRangeProps)[];
+    dateSelectionSegs: (SlicedCoordRange & EventRangeProps)[];
+    eventDrag: EventSegUiInteractionState<SlicedCoordRange> | null;
+    eventResize: EventSegUiInteractionState<SlicedCoordRange> | null;
+    eventSelection: string;
+    dayMaxEvents: boolean | number;
+    dayMaxEventRows: boolean | number;
+    colWidth?: number;
+    minHeight?: number | string;
+    rootElRef?: Ref<HTMLElement>;
+    heightRef?: Ref<number>;
+}
+declare class DayGridRow extends BaseComponent<DayGridRowProps> {
+    private rootEl;
+    private headerHeightRefMap;
+    private mainHeightRefMap;
+    private segHeightRefMap;
+    private disconnectHeight?;
+    render(): createElement.JSX.Element;
+    renderFgSegs(headerHeight: number | undefined, segs: DayRowEventRangePart[], segTops: Map<string, number>, todayRange: DateRange, forcedInvisibleMap: {
+        [instanceId: string]: any;
+    }, isDragging?: boolean, isResizing?: boolean, isDateSelecting?: boolean): VNode[];
+    renderFillSegs(segs: DayRowEventRangePart[], fillType: string): VNode;
+    handleRootEl: (rootEl: HTMLElement) => void;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    computeFgDims(): [maxMainTop: number | undefined, minMainHeight: number | undefined];
+    private handleSegPositioning;
+    private getMirrorSegs;
+    private getHighlightSegs;
+}
+
+export { CellDataConfig, CellRenderConfig, DayGridHeaderRow, DayGridHeaderRowProps, DayGridLayout, DayGridLayoutProps, DayGridRow, DayGridRowProps, DayGridRows, DayGridView, DayTableSlicer, RowConfig, TableDateProfileGenerator, buildDateDataConfigs, buildDateRenderConfig, buildDateRowConfig, buildDateRowConfigs, buildDayTableModel, buildDayTableRenderRange, computeColFromPosition, computeColWidth, computeRowHeight, createDayHeaderFormatter, getCellEl, getRowEl };