@zeedhi/common 1.112.0 → 3.0.0

package/types/components/zd-grid/grid-column-editable.d.ts

@@ -1,13 +0,0 @@
-import { IGridColumnEditable } from './interfaces';
-import { GridColumn } from './grid-column';
-/**
- * Base class for Grid column
- */
-export declare class GridColumnEditable extends GridColumn implements IGridColumnEditable {
-    editable: boolean;
-    /**
-     * Creates a new Grid Column.
-     * @param props Grid column properties
-     */
-    constructor(props: IGridColumnEditable);
-}

package/types/components/zd-grid/grid-column.d.ts

@@ -1,46 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { Column } from '../zd-iterable/column';
-import { IChildrenActionColumn, IGridColumn } from './interfaces';
-/**
- * Base class for Grid column
- */
-export declare class GridColumn extends Column implements IGridColumn {
-    children: IChildrenActionColumn[];
-    /**
-     * Creates a new Grid Column.
-     * @param props Grid column properties
-     */
-    constructor(props: IGridColumn);
-    /**
-     * Children props without grid system.
-     */
-    get childrenProps(): {
-        [key: string]: any;
-        children?: import("..").IComponentRender[] | undefined;
-        component: string;
-        allowDuplicate?: boolean | undefined;
-        autofocus?: boolean | undefined;
-        componentId?: number | undefined;
-        cssClass?: string | undefined;
-        cssStyle?: string | object | undefined;
-        events?: import("..").IComponentEvents<import("@zeedhi/core").IEventParam<any>> | undefined;
-        directives?: import("..").IComponentDirectives | undefined;
-        isVisible?: string | boolean | undefined;
-        dark?: boolean | undefined;
-        light?: boolean | undefined;
-        keyMap?: import("@zeedhi/core").IKeyMap<import("@zeedhi/core").IEventParam<any>> | undefined;
-        name: string;
-        parent?: import("..").Component | undefined;
-        tabStop?: boolean | undefined;
-        userProperties?: IDictionary<any> | undefined;
-    }[];
-    /**
-     * Get the Column without the conditions object
-     * @param component Column component
-     */
-    getColumnWithoutConditions(component: any): any;
-    /**
-     * checkOutValues
-     */
-    checkOutValues(component: any, row: IDictionary<any>, newRow: IDictionary<any>): void;
-}

package/types/components/zd-grid/grid-editable-controller.d.ts

@@ -1,8 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { GridEditable } from './grid-editable';
-export declare class GridEditableController {
-    private grid;
-    constructor(grid: GridEditable);
-    get hasAddedRows(): boolean;
-    isAddedRow({ row }: IDictionary): boolean;
-}

package/types/components/zd-grid/grid-editable.d.ts

@@ -1,272 +0,0 @@
-import { IDictionary, IKeyMap } from '@zeedhi/core';
-import { IGridColumnEditable, IGridEditable } from './interfaces';
-import { Input } from '../zd-input/input';
-import { Grid } from '..';
-import { GridColumnEditable } from './grid-column-editable';
-/**
- * Base class for Grid component
- */
-export declare class GridEditable extends Grid implements IGridEditable {
-    /**
-     * Editable columns
-     */
-    columns: GridColumnEditable[];
-    currentColumn: GridColumnEditable;
-    /**
-     * Editing rows
-     */
-    editing: boolean;
-    /**
-     * Enter edit mode on double click
-     */
-    doubleClickEdit: boolean;
-    /**
-     * Function to check if row can be edited
-     */
-    canEditRow?: (args: {
-        row: IDictionary<any>;
-        component: GridEditable;
-    }) => boolean;
-    singleEdit: boolean;
-    /**
-     * Edited rows
-     * @private
-     */
-    private editedRows;
-    /**
-     * Rows with newRowIdentifier
-     * @private
-     */
-    private addedRows;
-    /**
-     * Invalid inline components
-     * @private
-     */
-    private invalidComponents;
-    editingNewRows: boolean;
-    protected cancelEditedRowsKeyMapping: IKeyMap;
-    protected viewEnterEdit: ((rowKey: string, columnName: string) => void) | null;
-    setViewEnterEdit(viewEnterEdit: (rowKey: string, columnName: string) => void): void;
-    showCancelColumn: boolean;
-    /**
-     * Define se o evento rowClick deve ser chamado ao clicar em uma célula editável
-     */
-    preventRowClickOnEditing: boolean;
-    constructor(props: IGridEditable);
-    onMounted(element: any): void;
-    onBeforeDestroy(): void;
-    /**
-     * Get Grid columns objects
-     * @param columns Grid columns parameter
-     */
-    protected getColumns(columns: IGridColumnEditable[]): GridColumnEditable[];
-    protected addCancelColumn(): void;
-    protected getCancelColumnProps(): IGridColumnEditable;
-    protected instantiateCancelColumn(): GridColumnEditable;
-    protected registerDatasourceCallback(): void;
-    protected createGridController(): void;
-    /**
-     * Changes column order
-     * @async
-     * @param field Grid column
-     */
-    changeColumnOrder(column: IGridColumnEditable): Promise<void>;
-    /**
-     * Dispatches row click event
-     * @param row Grid row
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    rowClick(row: IDictionary<any>, event: Event, element: any): void;
-    /**
-     * Dispatches cellClick event
-     * @param row Grid row
-     * @param column Grid column
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    cellClick(row: IDictionary<any>, column: GridColumnEditable, event: Event, element: any, canEdit?: boolean): void;
-    /**
-     * Dispatches cellDoubleClick event
-     * @param row Grid row
-     * @param column Grid column
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    cellDoubleClick(row: IDictionary<any>, column: GridColumnEditable, event: Event, element: any, canEdit?: boolean): void;
-    /**
-     * Enables editing mode
-     * @param row Grid row
-     * @param column Grid column
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    inlineEdit(row: IDictionary, column: GridColumnEditable, event: Event, element: any): void;
-    cellClickEvent(row: IDictionary<any>, column: GridColumnEditable, event: Event, element: any): void;
-    cellDoubleClickEvent(row: IDictionary<any>, column: GridColumnEditable, event: Event, element: any): void;
-    /**
-     * Dispatches select/unselect event
-     * @param row Grid row
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectClick(row: IDictionary<any>, isSelected: boolean, event: Event, element: any): void;
-    /**
-     * Dispatches select/unselect all rows event
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectAllClick(isSelected: boolean, event: Event, element: any): void;
-    getVisibleValue(row: IDictionary, column: GridColumnEditable): any;
-    /**
-     * Returns editable component properties based on the column definition
-     * @param column Column definition
-     * @param row Datasource row
-     * @param cellProps Column conditional props
-     * @param events Component events
-     */
-    getEditableComponent(column: GridColumnEditable, row: IDictionary<any>, cellProps: IDictionary<any> | null, events: any): {
-        name: string;
-        parent: GridEditable;
-        align: import("..").ColumnAlign;
-        showLabel: boolean;
-        showHelper: boolean;
-        dense: boolean;
-        value: any;
-        events: any;
-        autofill: boolean;
-        allowDuplicate: boolean;
-        autoRegister: boolean;
-    };
-    /**
-     * Pushes lookup values into the column's datasource
-     * If the row[column.name] has a selected value, pushes it
-     */
-    private checkLookupData;
-    private pushLookupRow;
-    private checkCompValidity;
-    /**
-     * change event of editable components
-     */
-    protected changeEditableComponent(column: GridColumnEditable, row: IDictionary<any>, value: any, component?: Input): void;
-    private updateOriginalRow;
-    /**
-     * Checks if column is edited
-     * @param column Column
-     * @param row Row
-     */
-    isEdited(column: GridColumnEditable, row: IDictionary): boolean;
-    /**
-     * Checks if row is an added row
-     * @param row Row
-     */
-    isAdded(row: IDictionary): boolean;
-    /**
-     * Checks if column is valid
-     * @param column Column
-     * @param row Row
-     */
-    isValid(column: IGridColumnEditable, row: IDictionary, revalidate?: boolean): string | boolean;
-    private newRowIdentifier;
-    private positionIdentifier;
-    private pageIdentifier;
-    /**
-     * Cancels all edited rows and enable grid components
-     */
-    cancelEditedRows(): Promise<void>;
-    /**
-     * cancelAddedRow
-     */
-    cancelAddedRow(key: string | number): Promise<any>;
-    private cancelAddedRows;
-    private addDataRow;
-    /**
-     * Saves all edited rows if they are valid
-     * @param revalidate Defines if the fields should be revalidated
-     * @throws Will throw when it finds an invalid row
-     */
-    saveEditedRows(revalidate?: boolean): Promise<void[]>;
-    /**
-     * Retrieves all edited rows if they are valid
-     * @param revalidate Defines if the fields should be revalidated
-     * @throws Will throw when it finds an invalid row
-     */
-    getEditedRows(revalidate?: boolean, silent?: boolean): IDictionary<any>[];
-    /**
-     * getAddedRows
-     */
-    getAddedRows(): IDictionary<any>[];
-    /**
-     * Checks whether the grid is valid or not
-     * @param revalidate Defines if the fields should be revalidated
-     */
-    isGridValid(revalidate?: boolean): boolean;
-    /**
-     * Checks whether the grid is valid while not in editing mode
-     */
-    private isViewGridValid;
-    /**
-     * Adds new row to the datasource data and pushes it to the editedRows
-     * @param row Row
-     * @param position whether the new Row will be inserted at the beginning or end of the data array
-     */
-    addNewRow(row: IDictionary, position?: 'end' | 'start'): Promise<void>;
-    /**
-     * Saves a row reference in editedRows and addedRows
-     * @param row Row to be saved
-     */
-    protected saveRowReference(row: IDictionary<any>): void;
-    /**
-     * Inserts a row in datasource depending on the position
-     * @param row Row to be inserted
-     * @param position Position, 'end' or 'start'
-     * @returns the data containing the newly added row
-     */
-    protected insertRowInDatasource(row: IDictionary<any>, position: 'end' | 'start'): IDictionary<any>[];
-    /**
-     * Gets the editable component name
-     * @param key Row unique key
-     * @param columnName Column name
-     */
-    private getCompName;
-    /**
-     * Gets the component in specified position
-     * @param key Row unique key
-     * @param columnName Column name
-     */
-    getComponent<T>(key: string, columnName: string): T;
-    /**
-     * Updates a row, adding it to editedRows
-     * @param newRow Row being updated
-     * @throws NotEditingError If grid is not in edit mode
-     * @throws RowNotFoundError If the row is not present in datasource
-     */
-    updateRow(newRow: IDictionary): void;
-    /**
-     * Updates a cell, adding it's row to editedRows
-     * @param rowKey Cell's row key
-     * @param columnName Cell's column name
-     * @param value Value to be set in the cell
-     * @throws NotEditingError If grid is not in edit mode
-     * @throws RowNotFoundError If the row is not present in datasource
-     */
-    updateCell(rowKey: string, columnName: string, value: any): void;
-    private isColumnEditable;
-    /**
-     * Changes a cell value in editedRows
-     * @param rowKey Cell's row key
-     * @param rowIdx Cell's row index in datasource.data
-     * @param column Cell's column
-     * @param value Value to be set in the cell
-     */
-    private changeCell;
-    callCanEditRow(row: IDictionary<any>): any;
-    changeData(data?: IDictionary<any>[]): void;
-    /**
-     * Makes the cell enter edit mode
-     */
-    enterEdit(rowKey: string, columnName: string): void;
-    getColumn(name: string): GridColumnEditable;
-}

package/types/components/zd-grid/grid.d.ts

@@ -1,260 +0,0 @@
-import { IDictionary, IEventParam, IKeyMap } from '@zeedhi/core';
-import { Component } from '../zd-component/component';
-import { IComponent, IComponentRender } from '../zd-component/interfaces';
-import { Iterable } from '../zd-iterable/iterable';
-import { GridColumn } from './grid-column';
-import { IGrid, IGridColumn, IGridEvents } from './interfaces';
-import { Column } from '../zd-iterable/column';
-/**
- * Base class for Grid component
- */
-export declare class Grid extends Iterable implements IGrid {
-    /**
-     * Components that will be rendered on toolbar slot
-     */
-    toolbarSlot: IComponentRender[];
-    loadingText: string;
-    noDataText: string;
-    noResultsText: string;
-    /**
-     * Components that will be rendered in no-data case
-     */
-    noDataSlot: IComponentRender[];
-    /**
-     * Components that will be rendered in no-result case
-     */
-    noResultSlot: IComponentRender[];
-    /**
-     * Components that will be rendered in error case
-     */
-    errorSlot: IComponentRender[];
-    /**
-     * Components that will be rendered on footer slot
-     */
-    footerSlot: IComponentRender[];
-    /**
-     * Toggle checkbox column
-     */
-    selectable: boolean;
-    /**
-     * Define row height
-     */
-    dense: boolean;
-    /**
-     * Defines the component height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    height: string | number;
-    /**
-     * Defines the component min height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minHeight: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxHeight: string | number;
-    /**
-     * Set component height to fill all space available
-     */
-    fillHeight: boolean;
-    /**
-     * Defines the component width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    width: string | number;
-    /**
-     * Defines the component min width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minWidth: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxWidth: string | number;
-    /**
-     * Controls footer visibility
-     */
-    showFooter: boolean;
-    /**
-     * Controls header visibility
-     */
-    showHeader: boolean;
-    /**
-     * Selected rows
-     */
-    selectedRows: any[];
-    /**
-     * Defines grid events.
-     */
-    events: IGridEvents;
-    /**
-     * Color of the header background
-     */
-    headerBackground: string;
-    /**
-     * Color of the header cell text color
-     */
-    headerCellTextColor: string;
-    /**
-     * Available order types
-     * @public
-     */
-    orderTypes: {
-        asc: string;
-        desc: string;
-    };
-    /**
-     * Flag to prevent row click
-     * @public
-     */
-    preventRowClick: boolean;
-    preventRowDoubleClick: boolean;
-    /**
-     * Enables column dragging
-     * @public
-     */
-    dragColumns: boolean;
-    /**
-     * Enables column resizing
-     * @public
-     */
-    resizeColumns: boolean;
-    /**
-     * Enables column resizing
-     * @public
-     */
-    rowStyleConditions?: (row: IDictionary) => IDictionary;
-    viewUpdateFixedColumns?: () => void;
-    /**
-     * Disable selection of specific rows using controller
-     * @public
-     */
-    disableSelection?: (args: {
-        row: IDictionary<any>;
-        component: Grid;
-    }) => boolean;
-    showSelectAll: boolean;
-    selectAllPages: boolean;
-    selectionState: {
-        allSelected: boolean;
-        except: IDictionary<any>[];
-    };
-    cellSelection: boolean;
-    currentColumn: Column | null;
-    protected viewNavigate: ((direction: 'up' | 'down' | 'left' | 'right', event?: Event) => void) | null;
-    setViewNavigate(viewNavigate: (up: 'up' | 'down' | 'left' | 'right', event?: Event) => void): void;
-    backgroundColor: string;
-    /**
-     * Creates a new Grid.
-     * @param props Grid properties
-     */
-    constructor(props: IGrid);
-    protected navigationKeyMapping: IKeyMap;
-    /**
-     * Filters keyMap to allow user to overwrite the default navigation keyMapping
-     */
-    private filterKeyMapping;
-    onMounted(element: any): void;
-    onBeforeDestroy(): void;
-    /**
-     * Get Grid columns objects
-     * @param columns Grid columns parameter
-     */
-    protected getColumns(columns: IGridColumn[]): GridColumn[];
-    /**
-     * Changes column order
-     * @async
-     * @param field Grid column
-     */
-    changeColumnOrder(column: IGridColumn): Promise<void>;
-    /**
-     * Sorts grid column
-     * @param name Column name
-     * @public
-     */
-    sortColumn(name: string): Promise<any>;
-    /**
-     * Dispatches row click event
-     * @param row Grid row
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    rowClick(row: IDictionary<any>, event: Event, element: any): void;
-    /**
-     * Dispatches cell click Event
-     * @param row Grid row
-     * @param column Grid column
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    cellClick(row: IDictionary<any>, column: GridColumn, event: Event, element: any): void;
-    selectCell(row: IDictionary, column: GridColumn): void;
-    /**
-     * Dispatches select/unselect event
-     * @param row Grid row
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectClick(row: IDictionary<any>, isSelected: boolean, event: Event, element: any): void;
-    /**
-     * Dispatches select/unselect all rows event
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectAllClick(isSelected: boolean, event: Event, element: any): void;
-    /**
-     * Retorna a quantidade total de linhas selecionadas caso exista
-     */
-    get pageText(): string;
-    /**
-     * Solicita uma confirmação se os registros nas outras páginas devem ser selecionados também.
-     * @private
-     * @returns {Promise<boolean>} Objeto Promise quando a confirmação for feita
-     *                             com parametro true se confirmado a seleção de todas páginas.
-     */
-    private askToSelectAll;
-    /**
-     * Solicita uma confirmação se os registros nas outras páginas precisam ser removidos também.
-     * @private
-     * @returns {Promise<void>} Objeto Promise quando a confirmação for feita.
-     */
-    private askToUnselectAll;
-    /**
-     * Efetua a seleção/desseleção de todas as linhas do grid
-     * @param {boolean} isSelected Indica se as linhas foram selecionadas ou não
-     * @returns {Promise<void>} Objeto Promise quando a seleção/desseleção acabar de ser realizada
-     */
-    selectAll(isSelected: boolean, mustAsk?: boolean): Promise<void>;
-    toggleRow(row: IDictionary): void;
-    selectRow(row: IDictionary, select: boolean): void;
-    navigateLeft({ event }: IEventParam<any>): void;
-    navigateRight({ event }: IEventParam<any>): void;
-    navigateUp(): void;
-    navigateDown(): void;
-    navigateDatasource(up: boolean): void;
-    navigateCurrentRow(up: boolean, rowIndex: number): void;
-    navigateInitial(up: boolean): void;
-    navigateFirst(): void;
-    navigateLast(): void;
-    navigatePageUp(): void;
-    navigatePageDown(): void;
-    deleteRows(): Promise<any[]>;
-    protected getActionProps(actionComponent: IComponent, column: GridColumn, row: IDictionary, parentPath: string): {
-        props: IComponent;
-        instance: Component | null;
-    };
-    private filterObject;
-    private deleteAccessorProps;
-    protected updateActionInstance(instanceName: string, newComponent: IComponent): Component;
-    getActionComponent(actionComponent: IComponent, column: GridColumn, row: IDictionary, parentPath?: string): IComponent;
-    protected changeDefaultSlotNames(slot: IComponentRender[]): any;
-    callDisableSelection(row: IDictionary<any>): boolean;
-    getRowStyleConditions(row: IDictionary<any>): IDictionary<any>;
-    private setGridRowsInEvents;
-    getColumn(name: string): GridColumn;
-}

package/types/components/zd-grid/interfaces.d.ts

@@ -1,75 +0,0 @@
-import { IEventParam, IDictionary, IEvent } from '@zeedhi/core';
-import { Grid } from './grid';
-import { IIterable, IColumn, IIterableEvents } from '../zd-iterable/interfaces';
-import { IComponentRender } from '../zd-component/interfaces';
-import { GridEditable } from './grid-editable';
-export interface IGridEvent extends IEventParam<Grid> {
-    row: IDictionary;
-    column: IColumn;
-}
-export interface IGridEvents<T = IGridEvent | IEventParam<any>> extends IIterableEvents<T> {
-    cellClick?: IEvent<T> | string;
-    rowClick?: IEvent<T> | string;
-    selected?: IEvent<T> | string;
-    selectedAll?: IEvent<T> | string;
-    unselected?: IEvent<T> | string;
-    unselectedAll?: IEvent<T> | string;
-}
-export interface IGridEditableEvents<T = IGridEvent | IEventParam<any>> extends IGridEvents<T> {
-    inlineEdit?: IEvent<T> | string;
-}
-export interface IGrid extends IIterable {
-    dense?: boolean;
-    errorSlot?: IComponentRender[];
-    events?: IGridEvents;
-    footerSlot?: IComponentRender[];
-    headerBackground?: string;
-    headerCellTextColor?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    noDataSlot?: IComponentRender[];
-    noResultSlot?: IComponentRender[];
-    selectable?: boolean;
-    showFooter?: boolean;
-    showHeader?: boolean;
-    toolbarSlot?: IComponentRender[];
-    dragColumns?: boolean;
-    resizeColumns?: boolean;
-    loadingText?: string;
-    noDataText?: string;
-    noResultsText?: string;
-    rowStyleConditions?: (row: IDictionary) => IDictionary;
-    disableSelection?: (args: {
-        row: IDictionary<any>;
-        component: Grid;
-    }) => boolean;
-    showSelectAll?: boolean;
-    selectAllPages?: boolean;
-    cellSelection?: boolean;
-    backgroundColor?: string;
-}
-export interface IGridColumn extends IColumn {
-    children?: IChildrenActionColumn[];
-}
-export interface IChildrenActionColumn extends IComponentRender {
-    conditions?: IDictionary;
-}
-export interface IGridColumnEditable extends IGridColumn {
-    editable?: boolean;
-}
-export interface IGridEditable extends IGrid {
-    columns?: IGridColumnEditable[];
-    doubleClickEdit?: boolean;
-    events?: IGridEditableEvents;
-    singleEdit?: boolean;
-    canEditRow?: (args: {
-        row: IDictionary<any>;
-        component: GridEditable;
-    }) => boolean;
-    showCancelColumn?: boolean;
-}