ods-component-lib 1.18.128 → 1.18.133

package/dist/components/devextreme/OdsInlineEditDataGrid/OdsInlineEditDataGrid.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { IVirtualDataGridProps } from "./types";
+/**
+ * OdsInlineEditDataGrid component.
+ * @param {IVirtualDataGridProps} props - The component props.
+ * @returns {React.FC} - The rendered component.
+ */
+declare const OdsInlineEditDataGrid: React.FC<IVirtualDataGridProps>;
+export default OdsInlineEditDataGrid;
+export type { IVirtualDataGridProps };

package/dist/components/devextreme/OdsInlineEditDataGrid/handlers/ContentHandlers.d.ts

@@ -0,0 +1,14 @@
+import { ContentReadyEvent } from "devextreme/ui/data_grid";
+import { IColumnConfig } from "../types";
+/**
+ * Custom hook to handle content ready events for the data grid.
+ * @param {React.MutableRefObject<any>} lastPageIndexRef - Reference to the last page index.
+ * @param {boolean} contentReady - Boolean indicating if the content is ready.
+ * @param {Function} setRowCount - Function to set the row count state
+ * @param {Function} setContentReady - Function to set the content ready state.
+ * @param {Function} setCurrentPage - Function to set the current page state.
+ * @param {Function} setCurrentPageSize - Function to set the current page size state.
+ * @param {Function} [callback] - Optional callback function.
+ * @returns {(e: ContentReadyEvent<any, any>) => void} handleContentReady - Handler for content ready event.
+ */
+export declare const useContentHandlers: (lastPageIndexRef: React.MutableRefObject<any>, contentReady: boolean, columns: IColumnConfig[], setRowCount: Function, setContentReady: Function, setCurrentPage: Function, setCurrentPageSize: Function, setHeaderFilterData: Function, callback?: Function) => (e: ContentReadyEvent<any, any>) => void;

package/dist/components/devextreme/OdsInlineEditDataGrid/handlers/EditorPreparedHandlers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Custom hook that returns a callback function to handle the "editorPrepared" event of a DevExtreme component.
+ * This callback function is responsible for customizing the editor's behavior based on specific conditions.
+ *
+ * @returns {Function} The callback function to handle the "editorPrepared" event.
+ */
+export declare const useEditorPreparedHandlers: () => (e: any) => void;

package/dist/components/devextreme/OdsInlineEditDataGrid/handlers/OnExportingHandlers.d.ts

@@ -0,0 +1,19 @@
+interface IOnExportingProps {
+    gridComponent: any;
+    baseFileName?: string;
+    selectedText?: string;
+    getSummary: () => string;
+    selectedRowsOnly: boolean;
+}
+/**
+ * Handles the exporting of data from the grid component.
+ *
+ * @param {IOnExportingProps} params - The parameters for exporting the data.
+ * @param {React.RefObject<Grid>} params.gridComponent - The reference to the grid component.
+ * @param {string} params.baseFileName - The base file name for the exported file.
+ * @param {string} params.selectedText - The text to be displayed for selected rows.
+ * @param {Function} params.getSummary - The function to get the summary of the exported data.
+ * @param {boolean} params.selectedRowsOnly - Indicates whether to export only selected rows.
+ */
+export declare const onExporting: ({ gridComponent, baseFileName, selectedText, getSummary, selectedRowsOnly, }: IOnExportingProps) => void;
+export {};

package/dist/components/devextreme/OdsInlineEditDataGrid/handlers/OptionHandlers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Custom hook to handle option change events for the data grid.
+ * @param {Object} dataGridRef - The dataGridRef property passed to the hook.
+ * @param {Function} setFilterApplied - Function to set the filter applied state.
+ * @returns {Function} - Handler function for option changed event.
+ */
+export declare const useOptionHandlers: (dataGridRef: any, setFilterApplied: any) => (e: any) => void;

package/dist/components/devextreme/OdsInlineEditDataGrid/handlers/SummaryHandlers.d.ts

@@ -0,0 +1,21 @@
+import type { ISummaryRowOptions } from "../types";
+interface IUseSummaryHandlersProps {
+    customSummary?: ISummaryRowOptions;
+    totalRecordCount: number;
+    currentPageSize: number;
+    currentPage: number;
+    filterApplied: boolean;
+    rowCount: number;
+    filteredRowCount: number;
+    isServerSide?: boolean;
+}
+/**
+ * Custom hook that provides summary handlers for a data grid.
+ *
+ * @param {IUseSummaryHandlersProps} props - The props object containing necessary parameters.
+ * @returns {Object} - An object containing the renderTotal function.
+ */
+export declare const useSummaryHandlers: ({ customSummary, totalRecordCount, currentPageSize, currentPage, filterApplied, rowCount, filteredRowCount, }: IUseSummaryHandlersProps) => {
+    renderTotal: () => string | null;
+};
+export {};

package/dist/components/devextreme/OdsInlineEditDataGrid/partials/ActionCellRender.d.ts

@@ -0,0 +1,15 @@
+import { FC } from "react";
+import { IVirtualDataGridProps } from "../types";
+interface ActionCellRenderProps {
+    cellData: any;
+    actionButtons: IVirtualDataGridProps["actionButtonGroup"];
+    edit?: IVirtualDataGridProps["edit"];
+    actionButtonGroup?: IVirtualDataGridProps["actionButtonGroup"];
+}
+/**
+ * Renders the action buttons for a cell in the OdsInlineEditDataGrid component.
+ * @param {ActionCellRenderProps} props - The props for the ActionCellRender component.
+ * @returns {ReactNode} - The rendered action buttons.
+ */
+declare const ActionCellRender: FC<ActionCellRenderProps>;
+export default ActionCellRender;

package/dist/components/devextreme/OdsInlineEditDataGrid/partials/EditingPartial.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { IEditingOptions } from "../types";
+/**
+ * Component that handles editing functionalities within the data grid.
+ * @param {IEditingOptions} props - The properties passed to the component.
+ * @returns {JSX.Element} - The JSX element representing the editing handlers.
+ */
+declare const EditingPartial: React.FC<IEditingOptions>;
+export default EditingPartial;

package/dist/components/devextreme/OdsInlineEditDataGrid/partials/PageTitle.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { IToolbarButton } from "../types";
+interface PageTitleAndToolbarProps {
+    pageTitle?: string;
+    toolbarButtonGroup?: IToolbarButton[];
+}
+declare const MemoizedPageTitleAndToolbar: React.NamedExoticComponent<PageTitleAndToolbarProps>;
+export default MemoizedPageTitleAndToolbar;

package/dist/components/devextreme/OdsInlineEditDataGrid/styles.d.ts

@@ -0,0 +1,9 @@
+export declare const useStyles: (props?: unknown) => import("antd-style").ReturnStyles<{
+    grid: import("antd-style").SerializedStyles;
+    gridCustomSummary: import("antd-style").SerializedStyles;
+}>;
+export declare const usePageTitleAndToolbarStyles: (props?: unknown) => import("antd-style").ReturnStyles<{
+    gridPageTitleWrapper: import("antd-style").SerializedStyles;
+    gridToolbarButtonGroupWrapper: import("antd-style").SerializedStyles;
+    gridToolbarButton: import("antd-style").SerializedStyles;
+}>;

package/dist/components/devextreme/OdsInlineEditDataGrid/types.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Represents the types for the OdsInlineEditDataGrid component.
+ * @module OdsInlineEditDataGrid/types
+ */
+/// <reference types="react" />
+import { ButtonType } from "antd/es/button";
+import { IButtonProps, IDataGridOptions, IEditingProps, ISummaryProps } from "devextreme-react/data-grid";
+/**
+ * Represents the configuration for a column in the data grid.
+ */
+export interface IColumnConfig {
+    dataField: string;
+    caption: string;
+    allowSorting?: boolean;
+    allowSearch?: boolean;
+    cellRender?: (data: any) => JSX.Element | string;
+    calculateFilterExpression?: (value: any, operation: string, target: string) => any;
+    format?: string | object;
+}
+/**
+ * Represents the props for the pager component.
+ */
+interface IPagerProps {
+    visible?: boolean;
+    showPageSizeSelector?: boolean;
+    showInfo?: boolean;
+    displayMode?: "full" | "compact";
+    infoText?: string;
+}
+/**
+ * Represents the props for the export functionality.
+ */
+interface IExportProps {
+    enabled: boolean;
+    allowExportSelectedData?: boolean;
+    fileName?: string;
+    selectedText?: string;
+}
+/**
+ * Represents the configuration for a toolbar button.
+ */
+export interface IToolbarButton {
+    type: string;
+    label: string;
+    onClick: () => void;
+    disabled?: boolean;
+}
+/**
+ * Represents the options for editing data in the data grid.
+ */
+export interface IEditingOptions extends Omit<IEditingProps, "mode"> {
+    mode?: "row" | "cell" | "batch";
+    formItems?: any[];
+    title?: string;
+}
+/**
+ * Represents the configuration for a button group.
+ */
+export interface IButtonGroup extends Omit<IButtonProps, "name"> {
+    name?: "cancel" | "delete" | "edit" | "save" | "undelete" | "unmap";
+    type?: ButtonType;
+    label?: string;
+    onclick?: React.MouseEventHandler<HTMLElement>;
+    actionPermission?: boolean;
+    icon: any;
+}
+/**
+ * Represents the options for summary rows in the data grid.
+ */
+export interface ISummaryRowOptions {
+    summaryLoadedDataLabel?: string;
+    summaryTotalDataLabel?: string;
+    summaryFilteredDataLabel?: string;
+    summaryItems?: ISummaryProps[];
+    summaryTotalCount?: number;
+    summaryTotalPageCountLabel?: string;
+    showSumInSummary?: boolean;
+    showAvgInSummary?: boolean;
+    showCountInSummary?: boolean;
+    showMaxInSummary?: boolean;
+    showMinInSummary?: boolean;
+    summarySumLabel?: string;
+    summaryAvgLabel?: string;
+    summaryMinLabel?: string;
+    summaryMaxLabel?: string;
+    summaryCountLabel?: string;
+}
+/**
+ * Represents the props for a virtual data grid component.
+ */
+export interface IVirtualDataGridProps extends IDataGridOptions {
+    columns: IColumnConfig[];
+    sortingProps?: any;
+    pagerProps?: IPagerProps;
+    exportProps?: IExportProps;
+    customSummary?: ISummaryRowOptions;
+    actionButtonGroup?: IButtonGroup[];
+    actionColumnEnable?: boolean;
+    pageTitle?: string;
+    language?: string;
+    isFilterPanel?: boolean;
+    isFilterRow?: boolean;
+    pageSize?: number;
+    toolbarButtonGroup?: IToolbarButton[];
+    edit?: IEditingOptions;
+    columnChooserPositionDisabled?: boolean;
+    dataGridPageName?: string;
+    totalRecordCount: number;
+    columnResizingMode?: "nextColumn" | "widget";
+    dataGridRef: any;
+    isServerSide?: boolean;
+}
+export {};

package/dist/components/devextreme/OdsInlineEditDataGrid/utils.d.ts

@@ -0,0 +1,19 @@
+interface IConcatFilteredLabelProps {
+    result: string;
+    totalLoaded: number;
+    filteredRowCount: number;
+    filterApplied: boolean;
+    summaryFilteredDataLabel: string;
+}
+/**
+ * Concatenates the filtered label with the result string.
+ *
+ * @param {IConcatFilteredLabelProps} props - The object containing the necessary properties.
+ * @returns {string} - The concatenated result string.
+ */
+export declare const concatFilteredLabel: ({ result, totalLoaded, filteredRowCount, filterApplied, summaryFilteredDataLabel, }: IConcatFilteredLabelProps) => string;
+export {};
+/**
+ * This file contains utility functions related to the OdsInlineEditDataGrid component.
+ * These utility functions are used for handling filtering and data manipulation.
+ */

package/dist/index.d.ts

@@ -53,6 +53,7 @@ import OdsFileUpload from "./components/antd/fileUpload/OdsFileUpload";
 import OdsBasicDataGrid from "./components/devextreme/OdsBasicDataGrid/OdsBasicDataGrid";
 import OdsTransfer from "./components/devextreme/OdsTransfer";
 import OdsServerSideDatagrid from "./components/devextreme/OdsServerSideDatagrid/OdsServerSideDatagrid";
+import OdsInlineEditDataGrid from "./components/devextreme/OdsInlineEditDataGrid/OdsInlineEditDataGrid";
 export { OdsButton };
 export { OdsInput };
 export { OdsDropdownButton };
@@ -109,3 +110,4 @@ export { OdsRemoteDataGrid } from "./components/devextreme/index";
 export { OdsBasicDataGrid };
 export { OdsTransfer };
 export { OdsServerSideDatagrid };
+export { OdsInlineEditDataGrid };