@vuu-ui/vuu-table 0.6.14-debug

package/types/useTableModel.d.ts

@@ -0,0 +1,71 @@
+import { ColumnDescriptor, GridConfig, KeyedColumnDescriptor, PinLocation } from "@vuu-ui/vuu-datagrid-types";
+import { Reducer } from "react";
+import { VuuColumnDataType } from "@vuu-ui/vuu-protocol-types";
+import { DataSourceConfig } from "@vuu-ui/vuu-data";
+export interface GridModel extends Omit<GridConfig, "columns"> {
+    columns: KeyedColumnDescriptor[];
+}
+export interface ColumnActionInit {
+    type: "init";
+    tableConfig: Omit<GridConfig, "headings">;
+    dataSourceConfig?: DataSourceConfig;
+}
+export interface ColumnActionHide {
+    type: "hideColumns";
+    columns: KeyedColumnDescriptor[];
+}
+export interface ColumnActionShow {
+    type: "showColumns";
+    columns: KeyedColumnDescriptor[];
+}
+export interface ColumnActionMove {
+    type: "moveColumn";
+    column: KeyedColumnDescriptor;
+    moveBy?: 1 | -1;
+    moveTo?: number;
+}
+export interface ColumnActionPin {
+    type: "pinColumn";
+    column: ColumnDescriptor;
+    pin?: PinLocation;
+}
+export interface ColumnActionResize {
+    type: "resizeColumn";
+    column: KeyedColumnDescriptor;
+    phase: "begin" | "resize" | "end";
+    width?: number;
+}
+export interface ColumnActionSetTypes {
+    type: "setTypes";
+    columnNames: string[];
+    serverDataTypes: VuuColumnDataType[];
+}
+export interface ColumnActionUpdate {
+    type: "updateColumn";
+    column: ColumnDescriptor;
+}
+export interface ColumnActionUpdateProp {
+    align?: ColumnDescriptor["align"];
+    column: KeyedColumnDescriptor;
+    hidden?: ColumnDescriptor["hidden"];
+    label?: ColumnDescriptor["label"];
+    resizing?: KeyedColumnDescriptor["resizing"];
+    type: "updateColumnProp";
+    width?: ColumnDescriptor["width"];
+}
+export interface ColumnActionTableConfig extends DataSourceConfig {
+    confirmed?: boolean;
+    type: "tableConfig";
+}
+/**
+ * PersistentColumnActions are those actions that require us to persist user changes across sessions
+ */
+export type PersistentColumnAction = ColumnActionPin | ColumnActionHide;
+export type GridModelAction = ColumnActionHide | ColumnActionInit | ColumnActionMove | ColumnActionPin | ColumnActionResize | ColumnActionSetTypes | ColumnActionShow | ColumnActionUpdate | ColumnActionUpdateProp | ColumnActionTableConfig;
+export type GridModelReducer = Reducer<GridModel, GridModelAction>;
+export type ColumnActionDispatch = (action: GridModelAction) => void;
+export declare const useTableModel: (tableConfig: Omit<GridConfig, "headings">, dataSourceConfig?: DataSourceConfig) => {
+    columns: KeyedColumnDescriptor[];
+    dispatchColumnAction: import("react").Dispatch<GridModelAction>;
+    headings: import("@vuu-ui/vuu-datagrid-types").TableHeadings;
+};

package/types/useTableScroll.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="react" />
+import { Viewport } from "./dataTableTypes";
+export interface ScrollRequestEnd {
+    type: "scroll-end";
+    direction: "home" | "end";
+}
+export interface ScrollRequestPage {
+    type: "scroll-page";
+    direction: "up" | "down";
+}
+export interface ScrollRequestDistance {
+    type: "scroll-distance";
+    distance: number;
+}
+export type ScrollRequest = ScrollRequestPage | ScrollRequestDistance | ScrollRequestEnd;
+export type ScrollRequestHandler = (request: ScrollRequest) => void;
+export interface TableScrollHookProps {
+    onHorizontalScroll?: (scrollLeft: number) => void;
+    onVerticalScroll?: (scrollTop: number) => void;
+    viewportHeight: number;
+    viewport: Viewport;
+}
+export declare const useTableScroll: ({ onHorizontalScroll, onVerticalScroll, viewport, }: TableScrollHookProps) => {
+    /** Ref to be assigned to ScrollbarContainer */
+    scrollbarContainerRef: import("react").RefObject<HTMLDivElement>;
+    /** Scroll handler to be attached to ScrollbarContainer */
+    onScrollbarContainerScroll: () => void;
+    /** Ref to be assigned to ContentContainer */
+    contentContainerRef: import("react").RefObject<HTMLDivElement>;
+    /** Scroll handler to be attached to ContentContainer */
+    onContentContainerScroll: () => void;
+    /** Ref to be assigned to TableContainer */
+    tableContainerRef: import("react").RefObject<HTMLDivElement>;
+    /** Scroll handler to be attached to TableContainer */
+    onTableContainerScroll: () => void;
+    /** Scroll the table  */
+    requestScroll: ScrollRequestHandler;
+};

package/types/useTableViewport.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This hook measures and calculates the values needed to manage layout
+ * and virtualisation of the table. This includes measurements required
+ * to support pinned columns.
+ */
+import { KeyedColumnDescriptor, TableHeadings } from "@vuu-ui/vuu-datagrid-types";
+import { MeasuredSize } from "./useMeasuredContainer";
+export interface TableViewportHookProps {
+    columns: KeyedColumnDescriptor[];
+    headerHeight: number;
+    headings: TableHeadings;
+    rowCount: number;
+    rowHeight: number;
+    size?: MeasuredSize;
+}
+export interface ViewportMeasurements {
+    fillerHeight: number;
+    maxScrollContainerScrollHorizontal: number;
+    maxScrollContainerScrollVertical: number;
+    pinnedWidthLeft: number;
+    pinnedWidthRight: number;
+    rowCount: number;
+    scrollContentHeight: number;
+    scrollbarSize: number;
+    scrollContentWidth: number;
+    totalHeaderHeight: number;
+}
+export declare const useTableViewport: ({ columns, headerHeight, headings, rowCount, rowHeight, size, }: TableViewportHookProps) => ViewportMeasurements;

package/types/useVirtualViewport.d.ts

@@ -0,0 +1,16 @@
+import { KeyedColumnDescriptor } from "@vuu-ui/vuu-datagrid-types";
+import { VuuRange } from "@vuu-ui/vuu-protocol-types";
+import { ViewportMeasurements } from "./useTableViewport";
+export interface VirtualViewportHookProps {
+    columns: KeyedColumnDescriptor[];
+    rowHeight: number;
+    setRange: (range: VuuRange) => void;
+    viewportMeasurements: ViewportMeasurements;
+}
+export interface VirtualViewportHookResult {
+    onHorizontalScroll: (scrollLeft: number) => void;
+    onVerticalScroll: (scrollTop: number) => void;
+    columnsWithinViewport: KeyedColumnDescriptor[];
+    virtualColSpan: number;
+}
+export declare const useVirtualViewport: ({ columns, rowHeight, setRange, viewportMeasurements, }: VirtualViewportHookProps) => VirtualViewportHookResult;