@mcurros2/microm 1.1.9-0 → 1.1.10-0

package/dist/index.d.ts

@@ -1875,11 +1875,684 @@ export declare namespace w2locale {
         'Your remote data source record count has changed, reloading from the first record.': string;
     };
 }
+declare class w2base {
+    /**
+     * Initializes base object for w2ui, registers it with w2ui object
+     *
+     * @param {string} name  - name of the object
+     * @returns
+     */
+    constructor(name: string);
+    activeEvents: any[];
+    listeners: any[];
+    debug: boolean | undefined;
+    /**
+     * Adds event listener, supports event phase and event scoping
+     *
+     * @param {*} edata - an object or string, if string "eventName:phase.scope"
+     * @param {*} handler
+     * @returns itself
+     */
+    on(events: any, handler: any): this;
+    /**
+     * Removes event listener, supports event phase and event scoping
+     *
+     * @param {*} edata - an object or string, if string "eventName:phase.scope"
+     * @param {*} handler
+     * @returns itself
+     */
+    off(events: any, handler: any): this;
+    /**
+     * Triggers even listeners for a specific event, loops through this.listeners
+     *
+     * @param {Object} edata - Object
+     * @returns modified edata
+     */
+    trigger(eventName: any, edata: Object, ...args: any[]): Object | undefined;
+    /**
+     * This method renders component into the box. It is overwritten in descendents and in this base
+     * component it is empty.
+     */
+    render(box: any): void;
+    /**
+     * Removes all classes that start with w2ui-* and sets box to null. It is needed so that control will
+     * release the box to be used for other widgets
+     */
+    unmount(): void;
+    box: any;
+}
+/**
+ * Part of w2ui 2.0 library
+ *  - Dependencies: jQuery, w2utils, w2base, w2toolbar, w2field
+ *
+ * == TODO ==
+ *  - problem with .set() and arrays, array get extended too, but should be replaced
+ *  - allow functions in routeData (also add routeData to list/enum)
+ *  - send parsed URL to the event if there is routeData
+ *  - add selectType: 'none' so that no selection can be make but with mouse
+ *  - focus/blur for selectType = cell not display grayed out selection
+ *  - allow enum in inline edit (see https://github.com/vitmalina/w2ui/issues/911#issuecomment-107341193)
+ *  - remote source, but localSort/localSearch
+ *  - promise for request, load, save, etc.
+ *  - onloadmore event (so it will be easy to implement remote data source with local sort)
+ *  - queryStatus() - clears on next select, etc. Should not if it is off
+ *
+ * == DEMOS To create ==
+ *  - batch for denied buttons
+ *  - natural sort
+ *
+ * == 2.0 changes
+ *  - toolbarInput - deprecated, toolbarSearch stays
+ *  - searchSuggest
+ *  - searchSave, searchSelected, savedSearches, defaultSearches, useLocalStorage, searchFieldTooltip
+ *  - cache, cacheSave
+ *  - onSearchSave, onSearchRemove, onSearchSelect
+ *  - show.searchLogic
+ *  - show.searchSave
+ *  - refreshSearch
+ *  - initAllFields -> searchInitInput
+ *  - textSearch - deprecated in favor of defaultOperator
+ *  - grid.confirm - refactored
+ *  - grid.message - refactored
+ *  - search.type == 'text' can have 'in' and 'not in' operators, then it will switch to enum
+ *  - grid.find(..., displayedOnly)
+ *  - column.render(..., this) - added
+ *  - observeResize for the box
+ *  - remove edit.type == 'select'
+ *  - editDone(...)
+ *  - liveSearch
+ *  - deprecated onUnselect event
+ *  - requestComplete(data, action, callBack, resolve, reject) - new argument list
+ *  - msgAJAXError -> msgHTTPError
+ *  - aded msgServerError
+ *  - deleted grid.method
+ *  - added mouseEnter/mouseLeave
+ *  - grid.show.columnReorder -> grid.reorderRows
+ *  - updagte docs search.label (not search.text)
+ *  - added columnAutoSize - which resizes column based on text in it
+ *  - added grid.replace()
+ */
+declare class w2grid extends w2base {
+    constructor(options: any);
+    name: any;
+    columns: any[];
+    columnGroups: any[];
+    records: any[];
+    summary: any[];
+    searches: any[];
+    toolbar: {};
+    ranges: any[];
+    contextMenu: any[];
+    searchMap: {};
+    searchData: any[];
+    sortMap: {};
+    sortData: any[];
+    savedSearches: any[];
+    defaultSearches: any[];
+    total: number;
+    recid: any;
+    last: {
+        field: string;
+        label: string;
+        logic: string;
+        search: string;
+        searchIds: never[];
+        selection: {
+            indexes: never[];
+            columns: {};
+        };
+        saved_sel: null;
+        multi: boolean;
+        fetch: {
+            action: string;
+            offset: null;
+            start: number;
+            response: number;
+            options: null;
+            controller: null;
+            loaded: boolean;
+            hasMore: boolean;
+        };
+        vscroll: {
+            scrollTop: number;
+            scrollLeft: number;
+            recIndStart: null;
+            recIndEnd: null;
+            colIndStart: number;
+            colIndEnd: number;
+            pull_more: boolean;
+            pull_refresh: boolean;
+            show_extra: number;
+        };
+        sel_ind: null;
+        sel_col: null;
+        sel_type: null;
+        sel_recid: null;
+        idCache: {};
+        move: null;
+        cancelClick: null;
+        inEditMode: boolean;
+        _edit: null;
+        kbd_timer: null;
+        marker_timer: null;
+        click_time: null;
+        click_recid: null;
+        bubbleEl: null;
+        colResizing: boolean;
+        tmp: null;
+        copy_event: null;
+        userSelect: string;
+        columnDrag: boolean;
+        state: null;
+        toolbar_height: number;
+    };
+    header: string;
+    url: string;
+    limit: number;
+    offset: number;
+    postData: {};
+    routeData: {};
+    httpHeaders: {};
+    show: {
+        header: boolean;
+        toolbar: boolean;
+        footer: boolean;
+        columnMenu: boolean;
+        columnHeaders: boolean;
+        lineNumbers: boolean;
+        expandColumn: boolean;
+        selectColumn: boolean;
+        emptyRecords: boolean;
+        toolbarReload: boolean;
+        toolbarColumns: boolean;
+        toolbarSearch: boolean;
+        toolbarAdd: boolean;
+        toolbarEdit: boolean;
+        toolbarDelete: boolean;
+        toolbarSave: boolean;
+        searchAll: boolean;
+        searchLogic: boolean;
+        searchHiddenMsg: boolean;
+        searchSave: boolean;
+        statusRange: boolean;
+        statusBuffered: boolean;
+        statusRecordID: boolean;
+        statusSelection: boolean;
+        statusResponse: boolean;
+        statusSort: boolean;
+        statusSearch: boolean;
+        recordTitles: boolean;
+        selectionBorder: boolean;
+        selectionResizer: boolean;
+        skipRecords: boolean;
+        saveRestoreState: boolean;
+    };
+    stateId: any;
+    hasFocus: boolean;
+    autoLoad: boolean;
+    fixedBody: boolean;
+    recordHeight: number;
+    lineNumberWidth: number;
+    keyboard: boolean;
+    selectType: string;
+    liveSearch: boolean;
+    multiSearch: boolean;
+    multiSelect: boolean;
+    multiSort: boolean;
+    reorderColumns: boolean;
+    reorderRows: boolean;
+    showExtraOnSearch: number;
+    markSearch: boolean;
+    columnTooltip: string;
+    disableCVS: boolean;
+    nestedFields: boolean;
+    vs_start: number;
+    vs_extra: number;
+    style: string;
+    tabIndex: any;
+    dataType: any;
+    parser: any;
+    advanceOnEdit: boolean;
+    useLocalStorage: boolean;
+    colTemplate: {
+        text: string;
+        field: string;
+        size: null;
+        min: number;
+        max: null;
+        gridMinWidth: null;
+        sizeCorrected: null;
+        sizeCalculated: null;
+        sizeOriginal: null;
+        sizeType: null;
+        hidden: boolean;
+        sortable: boolean;
+        sortMode: null;
+        searchable: boolean;
+        resizable: boolean;
+        hideable: boolean;
+        autoResize: null;
+        attr: string;
+        style: string;
+        render: null;
+        title: null;
+        tooltip: null;
+        editable: {};
+        frozen: boolean;
+        info: null;
+        clipboardCopy: boolean;
+    };
+    stateColProps: {
+        text: boolean;
+        field: boolean;
+        size: boolean;
+        min: boolean;
+        max: boolean;
+        gridMinWidth: boolean;
+        sizeCorrected: boolean;
+        sizeCalculated: boolean;
+        sizeOriginal: boolean;
+        sizeType: boolean;
+        hidden: boolean;
+        sortable: boolean;
+        sortMode: boolean;
+        searchable: boolean;
+        resizable: boolean;
+        hideable: boolean;
+        autoResize: boolean;
+        attr: boolean;
+        style: boolean;
+        render: boolean;
+        title: boolean;
+        tooltip: boolean;
+        editable: boolean;
+        frozen: boolean;
+        info: boolean;
+        clipboardCopy: boolean;
+    };
+    msgDelete: string;
+    msgNotJSON: string;
+    msgHTTPError: string;
+    msgServerError: string;
+    msgRefresh: string;
+    msgNeedReload: string;
+    msgEmpty: string;
+    buttons: {
+        reload: {
+            type: string;
+            id: string;
+            icon: string;
+            tooltip: string;
+        };
+        columns: {
+            type: string;
+            id: string;
+            icon: string;
+            tooltip: string;
+            overlay: {
+                align: string;
+            };
+        };
+        search: {
+            type: string;
+            id: string;
+            html: string;
+        };
+        add: {
+            type: string;
+            id: string;
+            text: string;
+            tooltip: string;
+            icon: string;
+        };
+        edit: {
+            type: string;
+            id: string;
+            text: string;
+            tooltip: string;
+            icon: string;
+            batch: number;
+            disabled: boolean;
+        };
+        delete: {
+            type: string;
+            id: string;
+            text: string;
+            tooltip: string;
+            icon: string;
+            batch: boolean;
+            disabled: boolean;
+        };
+        save: {
+            type: string;
+            id: string;
+            text: string;
+            tooltip: string;
+            icon: string;
+        };
+    };
+    operators: {
+        text: string[];
+        number: string[];
+        date: (string | {
+            oper: string;
+            text: string;
+        })[];
+        list: string[];
+        hex: string[];
+        color: string[];
+        enum: string[];
+    };
+    defaultOperator: {
+        text: string;
+        number: string;
+        date: string;
+        list: string;
+        enum: string;
+        hex: string;
+        color: string;
+    };
+    operatorsMap: {
+        text: string;
+        int: string;
+        float: string;
+        money: string;
+        currency: string;
+        percent: string;
+        hex: string;
+        alphanumeric: string;
+        color: string;
+        date: string;
+        time: string;
+        datetime: string;
+        list: string;
+        combo: string;
+        enum: string;
+        file: string;
+        select: string;
+        radio: string;
+        checkbox: string;
+        toggle: string;
+    };
+    onAdd: any;
+    onEdit: any;
+    onRequest: any;
+    onLoad: any;
+    onDelete: any;
+    onSave: any;
+    onSelect: any;
+    onClick: any;
+    onDblClick: any;
+    onContextMenu: any;
+    onContextMenuClick: any;
+    onColumnClick: any;
+    onColumnDblClick: any;
+    onColumnContextMenu: any;
+    onColumnResize: any;
+    onColumnAutoResize: any;
+    onSort: any;
+    onSearch: any;
+    onSearchOpen: any;
+    onChange: any;
+    onRestore: any;
+    onExpand: any;
+    onCollapse: any;
+    onError: any;
+    onKeydown: any;
+    onToolbar: any;
+    onColumnOnOff: any;
+    onCopy: any;
+    onPaste: any;
+    onSelectionExtend: any;
+    onEditField: any;
+    onRender: any;
+    onRefresh: any;
+    onReload: any;
+    onResize: any;
+    onDestroy: any;
+    onStateSave: any;
+    onStateRestore: any;
+    onFocus: any;
+    onBlur: any;
+    onReorderRow: any;
+    onSearchSave: any;
+    onSearchRemove: any;
+    onSearchSelect: any;
+    onColumnSelect: any;
+    onColumnDragStart: any;
+    onColumnDragEnd: any;
+    onResizerDblClick: any;
+    onMouseEnter: any;
+    onMouseLeave: any;
+    add(record: any, first: any): number;
+    find(obj: any, returnIndex: any, displayedOnly: any): any[];
+    set(recid: any, record: any, noRefresh: any): boolean;
+    replace(recid: any, record: any, noRefresh: any): boolean;
+    get(recid: any, returnIndex: any): any;
+    getFirst(offset: any): any;
+    remove(...args: any[]): number;
+    addColumn(before: any, columns: any, ...args: any[]): number;
+    removeColumn(...args: any[]): number;
+    getColumn(field: any, returnIndex: any, ...args: any[]): any;
+    updateColumn(fields: any, updates: any): number;
+    toggleColumn(...args: any[]): number;
+    showColumn(...args: any[]): number;
+    hideColumn(...args: any[]): number;
+    addSearch(before: any, search: any, ...args: any[]): number;
+    removeSearch(...args: any[]): number;
+    getSearch(field: any, returnIndex: any, ...args: any[]): any;
+    toggleSearch(...args: any[]): number;
+    showSearch(...args: any[]): number;
+    hideSearch(...args: any[]): number;
+    getSearchData(field: any): any;
+    localSort(silent: any, noResetRefresh: any): number | undefined;
+    localSearch(silent: any): number | undefined;
+    getRangeData(range: any, extra: any): any[];
+    addRange(ranges: any): number;
+    removeRange(...args: any[]): number;
+    refreshRanges(): number | undefined;
+    select(...args: any[]): number;
+    unselect(...args: any[]): any;
+    selectAll(): number | undefined;
+    selectNone(skipEvent: any): number | undefined;
+    updateToolbar(sel: any): void;
+    getSelection(returnIndex: any): any[];
+    search(field: any, value: any, ...args: any[]): void;
+    searchOpen(): void;
+    searchClose(): void;
+    searchFieldTooltip(ind: any, sd_ind: any, el: any): void;
+    searchSuggest(imediate: any, forceHide: any, input: any): void;
+    searchSelected: any;
+    searchSave(): void;
+    cache(type: any): any;
+    cacheSave(type: any, value: any): boolean;
+    searchReset(noReload: any): void;
+    searchShowFields(forceHide: any): void;
+    searchInitInput(field: any, value: any): void;
+    clear(noRefresh: any): void;
+    reset(noRefresh: any): void;
+    skip(offset: any, callBack: any): void;
+    load(url: any, callBack: any): Promise<any>;
+    reload(callBack: any): Promise<any>;
+    request(action: any, postData: any, url: any, callBack: any): Promise<any>;
+    requestComplete(data: any, action: any, callBack: any, resolve: any, reject: any): Promise<any> | undefined;
+    error(msg: any): void;
+    getChanges(recordsBase: any): any;
+    mergeChanges(): void;
+    save(callBack: any): void;
+    editField(recid: any, column: any, value: any, event: any): void;
+    editChange(input: any, index: any, column: any, event: any): void;
+    editDone(index: any, column: any, event: any): void;
+    delete(force: any): void;
+    click(recid: any, event: any): void;
+    columnClick(field: any, event: any): void;
+    columnDblClick(field: any, event: any): void;
+    columnContextMenu(field: any, event: any): void;
+    columnAutoSize(colIndex: any, ...args: any[]): true | undefined;
+    columnAutoSizeAll(): void;
+    focus(event: any): false | undefined;
+    blur(event: any): false | undefined;
+    keydown(event: any): void;
+    scrollIntoView(ind: any, column: any, instant: any, recTop: any): void;
+    scrollToColumn(field: any): void;
+    dblClick(recid: any, event: any): void;
+    showContextMenu(recid: any, column: any, event: any): void;
+    contextMenuClick(recid: any, column: any, event: any): void;
+    toggle(recid: any): boolean | undefined;
+    expand(recid: any, noRefresh: any): boolean;
+    collapse(recid: any, noRefresh: any): boolean;
+    sort(field: any, direction: any, multiField: any): void;
+    copy(flag: any, oEvent: any): any;
+    /**
+     * Gets value to be copied to the clipboard
+     * @param ind index of the record
+     * @param col_ind index of the column
+     * @returns the displayed value of the field's record associated with the cell
+     */
+    getCellCopy(ind: any, col_ind: any): any;
+    paste(text: any, event: any): void;
+    resize(): number | undefined;
+    update({ cells, fullCellRefresh, ignoreColumns }?: {}): number;
+    refreshCell(recid: any, field: any): boolean;
+    refreshRow(recid: any, ind?: null): boolean;
+    refresh(): number | undefined;
+    refreshSearch(): void;
+    refreshBody(): void;
+    render(box: any): number | undefined;
+    destroy(): void;
+    initColumnOnOff(): {
+        id: string;
+        text: string;
+        checked: boolean;
+    }[];
+    initColumnDrag(box: any): {
+        remove(): void;
+    };
+    columnOnOff(event: any, field: any): void;
+    initToolbar(): void;
+    initResize(): void;
+    resizeBoxes(): void;
+    resizeRecords(): void;
+    getSearchesHTML(): string;
+    getOperators(type: any, opers: any): string;
+    initOperator(ind: any): void;
+    initSearches(): void;
+    getColumnsHTML(): string[];
+    getColumnCellHTML(i: any): string;
+    columnTooltipShow(ind: any, event: any): void;
+    columnTooltipHide(ind: any, event: any): void;
+    getRecordsHTML(): string[];
+    getSummaryHTML(): string[] | undefined;
+    scroll(event: any): void;
+    getRecordHTML(ind: any, lineNum: any, summary: any): string[] | "";
+    getLineHTML(lineNum: any): string;
+    getCellHTML(ind: any, col_ind: any, summary: any, col_span: any): any;
+    clipboardCopy(ind: any, col_ind: any, summary: any): void;
+    showBubble(ind: any, col_ind: any, summary: any): any;
+    getCellEditable(ind: any, col_ind: any): any;
+    getCellValue(ind: any, col_ind: any, summary: any, extra: any): any;
+    getFooterHTML(): string;
+    status(msg: any): void;
+    lock(msg: any, showSpinner: any, ...args: any[]): void;
+    unlock(speed: any): void;
+    stateSave(returnOnly: any): {
+        columns: never[];
+        show: any;
+        last: {
+            search: string;
+            multi: boolean;
+            logic: string;
+            label: string;
+            field: string;
+            scrollTop: number;
+            scrollLeft: number;
+        };
+        sortData: never[];
+        searchData: never[];
+    } | undefined;
+    stateRestore(newState: any): true | undefined;
+    stateReset(): void;
+    parseField(obj: any, field: any): any;
+    prepareData(): void;
+    nextCell(index: any, col_ind: any, editable: any): any;
+    prevCell(index: any, col_ind: any, editable: any): any;
+    nextRow(ind: any, col_ind: any, numRows: any): any;
+    prevRow(ind: any, col_ind: any, numRows: any): any;
+    selectionSave(): null;
+    selectionRestore(noRefresh: any): number;
+    message(options: any): {
+        self: any;
+        action(callBack: any): any;
+        close(callBack: any): any;
+        open(callBack: any): any;
+        then(callBack: any): any;
+    } | undefined;
+    confirm(options: any): {
+        self: any;
+        action(callBack: any): any;
+        close(callBack: any): any;
+        open(callBack: any): any;
+        then(callBack: any): any;
+    } | undefined;
+}
 type w2record = Record<string, unknown> & {
     recid: number;
 };
 type w2recordId = string | number;
+type w2renderFunction = (this: _w2grid1, w2record: w2record, options: {
+    self: _w2grid1;
+    value: unknown;
+    index: number;
+    colIndex: number;
+    summary: boolean;
+}) => string;
+type w2titleFunction = (this: _w2grid1, w2record: w2record, options: {
+    self: _w2grid1;
+    value: unknown;
+    index: number;
+    colIndex: number;
+    summary: boolean;
+}) => string;
 type w2columnField = string;
+type w2column = {
+    text?: string | (() => string);
+    field?: w2columnField;
+    size?: string;
+    min?: number;
+    max?: number;
+    gridMinWidth?: number;
+    readonly sizeCorrected?: string;
+    readonly sizeCalculated?: string;
+    sizeOriginal?: string;
+    sizeType?: "px" | "%";
+    hidden?: boolean;
+    sortable?: boolean;
+    sortMode?: "default" | "natural" | "i18n" | ((a: string, b: string) => number);
+    searchable?: boolean | string | object;
+    resizable?: boolean;
+    hideable?: boolean;
+    autoResize?: boolean;
+    attr?: string;
+    style?: string;
+    render?: string | w2renderFunction;
+    title?: string | w2titleFunction;
+    tooltip?: string;
+    editable?: object;
+    frozen?: boolean;
+    info?: boolean | object;
+    clipboardCopy?: boolean | string | ((...args: unknown[]) => unknown);
+    _microm_format?: GridColumnFormat;
+    _microm_render?: GridColumnRender;
+    _microm_autoSizeMax?: number;
+    _microm_autoSize_cache?: boolean;
+    _microm_userSize_cache?: boolean;
+};
+declare class _w2grid1 extends w2grid {
+    columns: w2column[];
+    getColumn(field: w2columnField): w2column | undefined;
+    getColumnIndex(field: w2columnField): number | undefined;
+    addColumn(columns: w2column | w2column[], before?: string | number): number;
+}
 export type GridSelectionMode = 'multi' | 'single';
 export type GridColumnFormat = 'url' | 'email' | 'string' | 'check' | 'image' | 'html';
 export type GridColumnRender = (value: unknown, cellElement?: HTMLElement, record?: GridRecord, field?: w2columnField) => ReactNode;
@@ -2012,6 +2685,7 @@ export function DataGridToolbar(props: DataGridToolbarOptions): import("react/js
 export interface DataGridColumnsMenuProps {
     columns?: GridColumn[];
     setOpened: (opened: boolean) => void;
+    grid: _w2grid1 | null;
 }
 export function DataGridColumnsMenu(props: DataGridColumnsMenuProps): import("react/jsx-runtime").JSX.Element;
 export const DataGridDefaultProps: Partial<DataGridProps>;