@freegridjs/core 0.1.0 → 0.7.1

package/dist/types-vxZQWo_S.d.ts

@@ -1,226 +0,0 @@
-type Row = Record<string, any>;
-type Region = 'left' | 'center' | 'right';
-type ColumnType = 'text' | 'number' | 'date' | 'boolean';
-type FilterType = 'text' | 'number' | 'date' | 'set';
-type SortDir = 'asc' | 'desc';
-type TextOp = 'contains' | 'equals' | 'notEquals' | 'startsWith' | 'endsWith' | 'blank' | 'notBlank';
-type NumberOp = 'eq' | 'ne' | 'lt' | 'lte' | 'gt' | 'gte' | 'between' | 'blank' | 'notBlank';
-type DateOp = 'equals' | 'before' | 'after' | 'between' | 'blank' | 'notBlank';
-type FilterOp = TextOp | NumberOp | DateOp;
-interface TextFilterModel {
-    type: 'text';
-    op: TextOp;
-    value?: string;
-}
-interface NumberFilterModel {
-    type: 'number';
-    op: NumberOp;
-    value?: number;
-    valueTo?: number;
-}
-/** Dates are compared as local `YYYY-MM-DD` keys. */
-interface DateFilterModel {
-    type: 'date';
-    op: DateOp;
-    value?: string;
-    valueTo?: string;
-}
-/** Rows pass when their value is one of `values`. */
-interface SetFilterModel {
-    type: 'set';
-    values: unknown[];
-}
-type FilterModel = TextFilterModel | NumberFilterModel | DateFilterModel | SetFilterModel;
-interface SortItem {
-    colId: string;
-    dir: SortDir;
-}
-interface CellParams {
-    value: unknown;
-    formatted: string;
-    row: Row;
-    rowIndex: number;
-    column: ColumnDef;
-}
-interface ColumnDef {
-    /** Column id; defaults to `field`. Required when `field` is absent. */
-    id?: string;
-    field?: string;
-    header?: string;
-    width?: number;
-    minWidth?: number;
-    maxWidth?: number;
-    /** Share leftover width proportionally. A user resize turns it into a fixed width. */
-    flex?: number;
-    pinned?: 'left' | 'right';
-    hide?: boolean;
-    type?: ColumnType;
-    /** number: '#,##0.00' | 'integer' | 'percent' | 'currency:USD' | Intl options; date: 'date' | 'datetime' | 'time' | 'short' | 'medium' | 'long' | Intl options */
-    format?: string | Intl.NumberFormatOptions | Intl.DateTimeFormatOptions;
-    align?: 'left' | 'center' | 'right';
-    sortable?: boolean;
-    resizable?: boolean;
-    filter?: FilterType | false;
-    comparator?: (a: unknown, b: unknown, rowA: Row, rowB: Row) => number;
-    valueGetter?: (row: Row) => unknown;
-    /** Return a string (inserted as HTML — escape untrusted data) or an element. */
-    renderer?: (params: CellParams) => string | HTMLElement;
-    cellClass?: string | ((params: CellParams) => string | undefined);
-    children?: ColumnDef[];
-    /** Set false to keep this column out of the column chooser / side bar. */
-    chooser?: boolean;
-    /** Users cannot hide this column from the UI (API still can). */
-    lockVisible?: boolean;
-}
-interface ColumnState {
-    colId: string;
-    width: number;
-    hide: boolean;
-    pinned: 'left' | 'right' | null;
-}
-interface Messages {
-    noRows: string;
-    filter: string;
-    apply: string;
-    reset: string;
-    selectAll: string;
-    search: string;
-    blanks: string;
-    value: string;
-    valueTo: string;
-    sortAsc: string;
-    sortDesc: string;
-    clearSort: string;
-    pinLeft: string;
-    pinRight: string;
-    unpin: string;
-    columnMenu: string;
-    selectRow: string;
-    selectAllRows: string;
-    chooseColumns: string;
-    columns: string;
-    autosizeThis: string;
-    autosizeAll: string;
-    resetColumns: string;
-    hideColumn: string;
-    close: string;
-    ops: Record<FilterOp, string>;
-}
-interface LocalePack extends Messages {
-    /** BCP 47 tag, also used for Intl formatting and collation. */
-    code: string;
-}
-type Aggregator = 'sum' | 'avg' | 'min' | 'max' | 'count' | ((values: unknown[], rows: Row[]) => unknown);
-interface SummaryCell {
-    agg: Aggregator;
-    /** Text shown before the value, e.g. "Avg". */
-    prefix?: string;
-    /** Overrides the column format for this cell. */
-    format?: ColumnDef['format'];
-}
-interface SummaryRowDef {
-    /** Shown in the first displayed column that has no aggregator in this row. */
-    label?: string;
-    columns: Record<string, Aggregator | SummaryCell>;
-}
-interface SummaryOptions {
-    /** Default 'bottom'. */
-    position?: 'top' | 'bottom';
-    /** true (default): fixed outside the scroll area. false: scrolls with the rows. */
-    pinned?: boolean;
-    /** Rows to aggregate. Default 'filtered'. */
-    scope?: 'filtered' | 'all' | 'selected';
-    rows: SummaryRowDef[];
-}
-interface GridOptions {
-    columns: ColumnDef[];
-    data?: Row[];
-    rowHeight?: number;
-    headerHeight?: number;
-    rowSelection?: 'single' | 'multiple';
-    getRowId?: (row: Row) => string;
-    theme?: string;
-    locale?: string | Partial<LocalePack>;
-    /** Font size in px (default 13). Row/header heights follow it unless set explicitly. */
-    fontSize?: number;
-    /** CSS font-family list (default: the theme's system font stack). */
-    fontFamily?: string;
-    /** Dock a Columns panel on the right. `{ open: true }` starts expanded. */
-    sideBar?: boolean | {
-        open?: boolean;
-    };
-    /** Summary rows (totals, averages, …). */
-    summary?: SummaryOptions;
-}
-interface CellEvent {
-    row: Row;
-    rowIndex: number;
-    colId: string;
-    value: unknown;
-    event: MouseEvent;
-}
-interface GridEvents {
-    cellClick: CellEvent;
-    cellDoubleClick: CellEvent;
-    selectionChange: {
-        selected: Row[];
-    };
-    sortChange: {
-        sort: SortItem[];
-    };
-    filterChange: {
-        filters: Record<string, FilterModel>;
-    };
-    columnResize: {
-        colId: string;
-        width: number;
-    };
-    columnMove: {
-        colId: string;
-        toIndex: number;
-    };
-    focusChange: {
-        rowIndex: number;
-        colId: string;
-    };
-    columnVisible: {
-        colId: string;
-        visible: boolean;
-    };
-}
-interface GridApi {
-    setData(rows: Row[]): void;
-    getData(): Row[];
-    setColumns(columns: ColumnDef[]): void;
-    getColumnState(): ColumnState[];
-    applyColumnState(state: ColumnState[]): void;
-    setSort(sort: SortItem[]): void;
-    getSort(): SortItem[];
-    setFilter(colId: string, model: FilterModel | null): void;
-    getFilterModel(): Record<string, FilterModel>;
-    setQuickFilter(text: string): void;
-    getSelectedRows(): Row[];
-    selectAll(): void;
-    deselectAll(): void;
-    getDisplayedRowCount(): number;
-    scrollToRow(index: number): void;
-    setTheme(theme: string): void;
-    setLocale(locale: string | Partial<LocalePack>): void;
-    setFont(font: {
-        size?: number;
-        family?: string | null;
-    }): void;
-    setColumnVisible(colId: string, visible: boolean): void;
-    autoSizeColumns(colIds?: string[]): void;
-    resetColumnState(): void;
-    openColumnChooser(): void;
-    closeColumnChooser(): void;
-    toggleSideBar(open?: boolean): void;
-    setSummary(summary: SummaryOptions | null): void;
-    /** Raw aggregate values per summary row, keyed by column id. */
-    getSummaryValues(): Record<string, unknown>[];
-    on<K extends keyof GridEvents>(type: K, fn: (payload: GridEvents[K]) => void): () => void;
-    destroy(): void;
-}
-
-export type { Aggregator as A, CellEvent as C, DateFilterModel as D, FilterModel as F, GridOptions as G, LocalePack as L, Messages as M, NumberFilterModel as N, Region as R, SetFilterModel as S, TextFilterModel as T, GridApi as a, CellParams as b, ColumnDef as c, ColumnState as d, ColumnType as e, DateOp as f, FilterOp as g, FilterType as h, GridEvents as i, NumberOp as j, Row as k, SortDir as l, SortItem as m, SummaryCell as n, SummaryOptions as o, SummaryRowDef as p, TextOp as q };