overgrid-vue 1.4.1 → 1.6.0

package/dist/index.d.ts

@@ -0,0 +1,758 @@
+import { AllowedComponentProps } from 'vue';
+import { ComponentCustomProperties } from 'vue';
+import { ComponentCustomProps } from 'vue';
+import { ComponentInternalInstance } from 'vue';
+import { ComponentOptionsBase } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComponentPublicInstance } from 'vue';
+import { ComputedRef } from 'vue';
+import { CreateComponentPublicInstanceWithMixins } from 'vue';
+import { DebuggerEvent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { GlobalComponents } from 'vue';
+import { GlobalDirectives } from 'vue';
+import { nextTick } from 'vue';
+import { OnCleanup } from '@vue/reactivity';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { ShallowUnwrapRef } from 'vue';
+import { Slot } from 'vue';
+import { VNodeProps } from 'vue';
+import { WatchOptions } from 'vue';
+import { WatchStopHandle } from 'vue';
+
+export declare const OverGrid: {
+    new (...args: any[]): CreateComponentPublicInstanceWithMixins<Readonly<{
+    config: OverGridConfig;
+    customFormatters?: {
+    name: string;
+    component: any;
+    }[];
+    }> & Readonly<{}>, {
+    fields: OverGridFields;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {
+    operationsDropdown: ({
+    $: ComponentInternalInstance;
+    $data: {};
+    $props: Partial<{
+    orientation: string;
+    extraClass: string;
+    }> & Omit<{
+    readonly orientation: string;
+    readonly extraClass: string;
+    } & VNodeProps & AllowedComponentProps & ComponentCustomProps, "orientation" | "extraClass">;
+    $attrs: {
+    [x: string]: unknown;
+    };
+    $refs: {
+    [x: string]: unknown;
+    };
+    $slots: Readonly<{
+    [name: string]: Slot<any> | undefined;
+    }>;
+    $root: ComponentPublicInstance | null;
+    $parent: ComponentPublicInstance | null;
+    $host: Element | null;
+    $emit: (event: string, ...args: any[]) => void;
+    $el: HTMLDivElement;
+    $options: ComponentOptionsBase<Readonly<ExtractPropTypes<    {
+    orientation: {
+    type: StringConstructor;
+    default: string;
+    };
+    extraClass: {
+    type: StringConstructor;
+    default: string;
+    };
+    }>> & Readonly<{}>, {
+    close: () => void;
+    }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {
+    orientation: string;
+    extraClass: string;
+    }, {}, string, {}, GlobalComponents, GlobalDirectives, string, ComponentProvideOptions> & {
+    beforeCreate?: (() => void) | (() => void)[];
+    created?: (() => void) | (() => void)[];
+    beforeMount?: (() => void) | (() => void)[];
+    mounted?: (() => void) | (() => void)[];
+    beforeUpdate?: (() => void) | (() => void)[];
+    updated?: (() => void) | (() => void)[];
+    activated?: (() => void) | (() => void)[];
+    deactivated?: (() => void) | (() => void)[];
+    beforeDestroy?: (() => void) | (() => void)[];
+    beforeUnmount?: (() => void) | (() => void)[];
+    destroyed?: (() => void) | (() => void)[];
+    unmounted?: (() => void) | (() => void)[];
+    renderTracked?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+    renderTriggered?: ((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[];
+    errorCaptured?: ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void)[];
+    };
+    $forceUpdate: () => void;
+    $nextTick: nextTick;
+    $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, OnCleanup]) => any : (...args: [any, any, OnCleanup]) => any, options?: WatchOptions): WatchStopHandle;
+    } & Readonly<{
+    orientation: string;
+    extraClass: string;
+    }> & Omit<Readonly<ExtractPropTypes<    {
+    orientation: {
+    type: StringConstructor;
+    default: string;
+    };
+    extraClass: {
+    type: StringConstructor;
+    default: string;
+    };
+    }>> & Readonly<{}>, "close" | ("orientation" | "extraClass")> & ShallowUnwrapRef<    {
+    close: () => void;
+    }> & {} & ComponentCustomProperties & {} & {
+    $slots: {
+    iconButton?(_: {}): any;
+    content?(_: {}): any;
+    };
+    }) | null;
+    }, HTMLDivElement, ComponentProvideOptions, {
+    P: {};
+    B: {};
+    D: {};
+    C: {};
+    M: {};
+    Defaults: {};
+    }, Readonly<{
+    config: OverGridConfig;
+    customFormatters?: {
+    name: string;
+    component: any;
+    }[];
+    }> & Readonly<{}>, {
+    fields: OverGridFields;
+    }, {}, {}, {}, {}>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & ComponentOptionsBase<Readonly<{
+config: OverGridConfig;
+customFormatters?: {
+name: string;
+component: any;
+}[];
+}> & Readonly<{}>, {
+fields: OverGridFields;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}, GlobalComponents, GlobalDirectives, string, ComponentProvideOptions> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
+    $slots: {
+        extraRow?(_: {
+            record: any;
+            extraSlotParams: object;
+        }): any;
+    };
+});
+
+export declare interface OverGridActionButton {
+    /**
+     * The title of the button.
+     */
+    title?: string;
+    /**
+     * The icon of the button. You can use any valid FontAwesome icon class here. For example, 'fas fa-edit'.
+     */
+    icon?: string;
+    /**
+     * The test value attribute of the button. If set, the button will have a test value attribute with this value to make e2e testing easier.
+     */
+    testValueAttribute?: string;
+    /**
+     * The class list of the button. You can set multiple classes here. For example, 'btn btn-primary'.
+     */
+    classList?: string;
+    /**
+     * The variant of the button. You can use any of the variants defined in OverGridBtn.vue. For example, 'primary', 'secondary', 'danger', etc.
+     */
+    variant?: string;
+    /**
+     * If true, the button is a dropdown button. If false, the button is a normal button.
+     */
+    dropdowned?: boolean;
+    /**
+     * If true, the button is disabled. If false, the button is enabled.
+     */
+    disabled?: boolean;
+    /**
+     * The function that is called when the button is clicked. You can access the full record object while you define buttons in the OperationsFormatterConfigType.buttons function.
+     */
+    action?: Function;
+}
+
+export declare interface OverGridBulkOperationsConfig {
+    /**
+     * If true, the column selector/bulk operation is active. If false, the column selector/bulk operation is disabled.
+     */
+    active: boolean;
+    /**
+     * The bulk operation methods. You can define multiple methods here. Each method has a title, a key (must be unique) and an action function. The action function gets the checked rows and a function to clear the checked rows.
+     */
+    methods: Array<{
+        title: string;
+        key: string;
+        action: (checkedRows: any[], clearRows: () => void) => void;
+    }>;
+}
+
+export declare interface OverGridColumnFilter {
+    /**
+     * The key of the field that this filter applies to.
+     */
+    key: string;
+    /**
+     * The filter key is used when the DTO key is different from the filter key what the server expects.
+     * This is useful when the server expects a different key for filtering.
+     * For example, if the field key is 'id' but the server expects 'user.id' for filtering,
+     * Most of the time it is the same as the field key.
+     */
+    filterKey: string;
+    /**
+     * The type of the filter.
+     * This can be 'text', 'number', 'date', etc.
+     */
+    type: string;
+    /**
+     * The operator of the filter.
+     * This can be 'cn', 'ncn', 'eq', 'neq', etc.
+     */
+    operation: string;
+    /**
+     * The value of the filter.
+     * This can be a string, number, date, etc. depending on the type of the filter.
+     */
+    value: any;
+}
+
+export declare interface OverGridColumnFiltersConfig {
+    /**
+     * If true, the column filters are active. If false, the column filters are disabled.
+     */
+    active: boolean;
+}
+
+export declare interface OverGridColumnSelectorConfig {
+    /**
+     * If true, the column selector is active. If false, the column selector is disabled.
+     */
+    active: boolean;
+}
+
+/**
+ * The full configuration object for the OverGrid
+ */
+export declare interface OverGridConfig {
+    /**
+     * The unique ID of the grid. This is used for the grid's internal operations. It should be unique for each grid in the same domain.
+     */
+    gridUniqueId: string;
+    /**
+     * The endpoint of the API
+     */
+    endpoint: string;
+    /**
+     * The field that you use as unique ID in records. This field is used internally for row selection, bulk operations and "extra row".
+     * For example, if your server returns an object like this: { data: [{ id: 1, name: 'Jane' }, { id: 2, name: 'Jack' }], count: 2 }, then the idKey is 'id'.
+     * Not set this field leads to unexpected behavior and bugs.
+     */
+    idkey?: string;
+    /**
+     * Theme code for the OverGrid.
+     */
+    theme?: string;
+    /**
+     * The root key of the server's response object. For example, if your server returns an object like this: { data: [{...}, {...}], count: 2 }, then the root key is 'data'. If null, the root key is the root object itself.
+     */
+    rootkey?: string;
+    /**
+     * The possible languages that the grid can use. If not set, the grid will use the default language, which is 'en'.
+     * Currently, the possible languages are 'en' and 'hu'.
+     * If you set the locale to an object, you can pass a custom locale to the grid. See the 'i18n' section for more information.
+     */
+    locale?: string | Record<string, string>;
+    /**
+     * If true, the grid will show the about window. Otherwise the grid will not show the about window.
+     */
+    hideAboutWindow?: boolean;
+    /**
+     * The configuration object for the ordering in grid. If not set, the order is fully disabled.
+     */
+    orderConfiguration?: OverGridOrderConfig;
+    /**
+     * You can modify the server request parameters before sending to the server. This function is called before the request is sent. You can modify the ordering, pagination and filtering parameters in order to your needs. If not set, the grid will send the parameters as is.
+     * @param orders List of ordering objects. Each object has a key and a direction (ASC or DESC).
+     * @param pagination The pagination object.
+     * @param filters List of filters. Each filter has a key, an operator and a value.
+     * @returns The modified URLSearchParams object.
+     */
+    serverTransformation?: (orders: any, pagination: any, filters: any, searchQuery?: string) => URLSearchParams;
+    /**
+     * You can modify the axios instance before sending the request to the server. This function is called before the request is sent. You can modify the axios instance in order to your needs. If not set, the grid will use the default axios instance.
+     * Use this function to set custom headers, base URL, or any other axios configuration.
+     * This function should return the modified axios instance.
+     * @param axios The default axios instance.
+     * @returns The modified axios instance.
+     */
+    axiosConfigurator?: (axios: any) => any;
+    /**
+     * The pagination configuration object for the grid.
+     */
+    pagination?: OverGridPaginationConfig;
+    /**
+     * The row highlighter configuration object for the grid.
+     * If not set, the row highlighter is disabled.
+     */
+    rowHighlighter?: OverGridRowHighlighterConfig;
+    /**
+     * Setup the column filters for the grid.
+     * If not set, the column filters are disabled.
+     * If you want to use the column filters, you can set the active property to true
+     */
+    columnFilters?: OverGridColumnFiltersConfig;
+    /**
+     * The search configuration object for the grid.
+     * If not set, the search is disabled.
+     * If you want to use the search, you can set the active property to true.
+     */
+    search?: OverGridSearchConfig;
+    extraRow?: OverGridExtraRowConfig;
+    bulkOperations?: OverGridBulkOperationsConfig;
+    events?: {
+        /**
+         * The event is fired when the grid is ready. The grid is ready when the first data load is finished.
+         */
+        onDataLoad?: (data: Array<any>) => Array<any>;
+        onDataLoadWithFullResponse?: (response: any) => Array<any>;
+        /**
+         * The event is fired when the grid is ready after a refresh. The grid is ready when the first data load is finished.
+         */
+        readyAfterRefresh?: () => void;
+        /**
+         * The event is fired when the selected records on the current pages are changed. The function gets the selected rows.
+         */
+        onBulkSelectChanges?: (checkedRows: Array<any>) => void;
+    };
+    columnSelector?: OverGridColumnSelectorConfig;
+    currentPageExport?: OverGridCurrentPageExportConfig;
+    refreshable?: OverGridRefreshableConfig;
+    /**
+     * The columns configuration object for the grid. The key of the object is the field name in the server's response. The value is the configuration object for the column. See the MappingRecordType for more information.
+     */
+    mapping?: OverGridField[];
+}
+
+export declare interface OverGridCurrentPageExportConfig {
+    /**
+     * If true, the XLSX/CSV export is active. If false, the XLSX/CSV export is disabled.
+     */
+    active: boolean;
+    /**
+     * If true, the XLSX export is enabled. If false, the XLSX export is disabled.
+     * One of the fields 'xlsxEnabled' or 'csvEnabled' must be true to enable the export functionality.
+     */
+    xlsxEnabled?: boolean;
+    /**
+     * If true, the CSV export is enabled. If false, the CSV export is disabled.
+     * One of the fields 'xlsxEnabled' or 'csvEnabled' must be true to enable the export functionality.
+     */
+    csvEnabled?: boolean;
+    additionalExportFields?: {
+        /**
+         * User-defined function to append additional fields for the export. The function gets the record object and should return an array.
+         */
+        columnsFn?: Function;
+    };
+}
+
+export declare interface OverGridEnumMapping {
+    [key: string]: {
+        title: string;
+        class?: string;
+    };
+}
+
+export declare interface OverGridExtraRowConfig {
+    /**
+     * If true, the extra row is active. If false, the extra row is disabled.
+     */
+    active: boolean;
+    /**
+     * Determines the user can open more than one extra row at the same time. If false, the user can open only one extra row at a time (close the other when open a new one).
+     */
+    multiOpen: boolean;
+    /**
+     * Ths extraRow slot gets the full record object of the "parent". You can define extra fields here that you want to pass to the slot.
+     */
+    extraSlotParams: object;
+}
+
+export declare class OverGridField {
+    constructor(key: string, title: string, fieldsObject: OverGridFields);
+    fieldsObject: OverGridFields;
+    /**
+     * The field name is the key of the field in the record object. It is used to access the value of the field in the record object responded from server.
+     * For example, if the field name is 'id', you can access the value of the field in the record object using record.id.
+     */
+    key: string;
+    /**
+     * The title of the column shown in the thead.
+     */
+    title: string;
+    /**
+     * If true, the column is visible. If false, the column is hidden in grid.
+     */
+    visible?: boolean;
+    /**
+     * If set, the column is filterable. If false, the column is not filterable.
+     */
+    columnFilter?: {
+        /**
+         * If true, the filter is active. If false, the filter is disabled for the field.
+         */
+        active: boolean;
+        /**
+         * The filter type. The filter type is used to determine the filter input field. The possible values are 'text', 'number', 'date', 'enum'.
+         */
+        type?: string;
+        /**
+         * The key to send to the server. If not set, the key is the same as the field name. If set, the key is the value of the key. Useful when the server expects a different key as it serves in the DTO.
+         */
+        filterKey?: string;
+        /**
+         * The configuration object for the filter. The configuration object is specific to the filter type.
+         * For example, a 'enum' filter can have a 'values' field to define the possible statuses.
+         * See the documentation for more information about the filter types.
+         */
+        config?: any;
+    };
+    /**
+     * A function to modify the data after it gets from the server but before showing in the cell. This function is called before the data is shown in the cell. You can modify the data here. For example, you can format a date, or you can show a different value based on the raw data.
+     * @param data The raw data of the cell
+     * @param record The full record object
+     * @returns The modified/formatted/tweaked data to show in the cell
+     */
+    middleware?: (data: any, record: any) => any;
+    /**
+     * A function to transform the data before export to an XLSX (or CSV) cell. This function is called before the data is written to the XLSX (or CSV) file. You can modify the data here. For example, you can format a date, or you can show a different value based on the raw data.
+     * If the exportMiddleware is set, the middleware function will not be called for the export. If the exportMiddleware is not set, the middleware function will be called for the export. If neither are set, the Formatter will be used to format the data for export, if applicable (e.g.: Status formatter, Boolean formatter, etc.).
+     * @param data The raw data of the cell
+     * @param record The full record object
+     * @param format The format of the cell. The format is used to determine the type of the export. Currently, the possible values are 'xlsx', 'csv'.
+     * @returns The modified/formatted/tweaked data to show in the cell
+     */
+    exportMiddleware?: (data: any, record: any, format?: string) => any;
+    /**
+     * If true, the column is selectable in the Column Selector Panel. If false, the column is not selectable.
+     * Default is true.
+     */
+    selectable?: boolean;
+    /**
+     * If true, the column is orderable/sortable. If false, the column is not orderable/sortable.
+     * Default is true.
+     */
+    orderable?: boolean;
+    /**
+     * You can set a custom order key for the column. If not set, the order key is the same as the field name. Useful when the server expects a different key as it serves in the DTO.
+     */
+    orderKey?: string;
+    /**
+     * If its true or not set, the column is exportable and will be added in the export file. If false, the column is not exportable.
+     * Default is true.
+     */
+    exportable?: boolean;
+    /**
+     * Sets the width of the column. If not set, the column width is auto. Example values: '100px', '10%'.
+     */
+    width?: string;
+    /**
+     * The formatter configuration object for the column. The formatter is a special component to format the data in the cell.
+     * There are 9 types of formatters built-in: 'Boolean', 'DateTime', 'Highlighter', 'HTML', 'LongText', 'Operations', 'Status', 'Strong', 'Tailwind'.
+     * You can set the formatter type and the configuration object for the formatter. For example, a 'Strong' type of formatter makes the text bold in cell, and a 'DateTime' type of formatter formats the date.
+     * You can define your own custom formatter as well. Check the documentation 'Custom formatters' section for more information.
+     */
+    formatter?: {
+        /**
+         * The type of the formatter.
+         */
+        type: string;
+        /**
+         * The configuration object for the formatter. The configuration object is specific to the formatter type.
+         * For example, a 'DateTime' formatter can have a 'format' field to define the date format, while a 'Status' formatter can have a 'statuses' field to define the possible statuses.
+         */
+        config?: any;
+    };
+    setTitle(title: string): OverGridField;
+    setVisible(visible: boolean): OverGridField;
+    setColumnFilter(columnFilter: {
+        active: boolean;
+        type?: string;
+        filterKey?: string;
+        config?: any;
+    }): OverGridField;
+    setSelectable(selectable: boolean): OverGridField;
+    setOrerable(orderable: boolean): OverGridField;
+    setOrderKey(orderKey: string): OverGridField;
+    setExportable(exportable: boolean): OverGridField;
+    setWidth(width: string): OverGridField;
+    setFilterKey(filterKey: string): OverGridField;
+    setOrderable(orderable: boolean): OverGridField;
+    setFormatter(type: string, config?: any): OverGridField;
+    setMiddleware(middleware: (data: any, record: any) => any): OverGridField;
+    setExportMiddleware(exportMiddleware: (data: any, record: any, format?: string) => any): OverGridField;
+    commit(): OverGridFields;
+}
+
+declare class OverGridFields {
+    mapping: Ref<OverGridField[]>;
+    actionButtonFieldCounter: number;
+    constructor();
+    mappingVisible: () => OverGridField[];
+    addField(key: string, title: string): OverGridField;
+    addNumberField(key: string, title: string, extraConfig?: any): OverGridField;
+    addTextField(key: string, title: string, extraConfig?: any): OverGridField;
+    addDateField(key: string, title: string, extraConfig?: any): OverGridField;
+    addEnumField(key: string, title: string, enumMapping: OverGridEnumMapping, extraConfig?: any): OverGridField;
+    addBooleanField(key: string, title: string, extraConfig?: any): OverGridField;
+    addActionButtonField(title: string, buttons: OverGridActionButton[]): OverGridField;
+}
+
+export declare interface OverGridOrderConfig {
+    /**
+     * If true, the ordering is active. If false, the ordering is disabled.
+     */
+    active: boolean;
+    /**
+     * Sets the initial order direction when a field is added to the ordering. If not set, the default order direction is 'DESC'.
+     * * Possible values are 'ASC' for ascending order and 'DESC' for descending order.
+     */
+    initialOrderDirection?: string;
+    /**
+     * Sets the default key for ordering in grid. Works only if the defaultOrderDirection is set. If not set, default ordering is disabled.
+     */
+    defaultOrder?: {
+        /**
+         * The key of the field to order by. This should match one of the field keys defined in the grid.
+         */
+        key: string;
+        /**
+         * The key used for ordering. This can be different from the field key if the server expects a different key for ordering. Most of the time it is the same as the field key.
+         */
+        orderKey: string;
+        /**
+         * Sets the default direction for ordering in grid. Works only if the defaultOrderKey is set. If not set, default ordering is disabled.
+         * Possible values are 'ASC' for ascending order and 'DESC' for descending order.
+         */
+        direction: string;
+    };
+    /**
+     * If true, the user can define multiple fields for ordering. If false, the user can define only one field for ordering.
+     */
+    orderMultiple?: boolean;
+    /**
+     * If true, the grid will show the order index in column title. Works only if the orderMultiple is set to true. For example if the user orders by 'name' and 'age', the grid will show '1' on name column title, and '2' in age column title.
+     */
+    showOrderIndex?: boolean;
+}
+
+export declare interface OverGridPaginationConfig {
+    /**
+     * If true, the pagination is active. If false, the pagination is disabled.
+     */
+    active: boolean;
+    /**
+     * The initial page number.
+     */
+    initialPage: number;
+    /**
+     * The initial page size.
+     */
+    initialSize: number;
+    /**
+     * If true, the pagination starts with page 0. If false, it starts with page 1.
+     * This is useful for APIs that use 0-based pagination.
+     * If not set, the default is false (1-based pagination).
+     */
+    startWithZero?: boolean;
+    /**
+     * The possible page sizes that the user can select/change in settins menu. If not set, the grid will not show the page size selector.
+     */
+    possiblePageSizes?: Array<number>;
+    /**
+     * Define the field that you use in the server's response to store the total number of records. This field is used for pagination. For example, if your server returns an object like this: { data: [{...}, {...}], count: 2 }, then the allRecordsCountKey is 'count'.
+     */
+    allRecordsCountKey: string;
+}
+
+export declare interface OverGridPaginationState {
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+
+export declare interface OverGridRefreshableConfig {
+    /**
+     * If true, the refresh button is active. If false, the refresh button is hidden.
+     */
+    manualActive: boolean;
+    /**
+     * If true, the auto refresh is active in the grid's menu. If false, the auto refresh is disabled.
+     */
+    autoActive: boolean;
+    /**
+     * If true, the auto refresh can be disabled in the grid's menu by the user. If false, the auto refresh cannot be disabled.
+     */
+    autoCanBeDisabled: boolean;
+    /**
+     * The auto refresh values. You can set multiple values here. Each value has a key (must be unique), a refresh interval in seconds and a title. The default value is the value that is selected by default in the grid's menu.
+     */
+    autoValues: Array<{
+        /**
+         * The key of the value. This key is used in the grid's menu to identify the value. It must be unique in the array.
+         */
+        key: string;
+        /**
+         * The refresh interval in seconds.
+         */
+        refreshInterval: number;
+        /**
+         * The title of the value. This title is shown in the grid's menu.
+         */
+        title: string;
+        /**
+         * If true, the value is the default value. If false, the value is not the default value.
+         */
+        default?: boolean;
+    }>;
+}
+
+export declare interface OverGridRowHighlighterConfig {
+    /**
+     * Row highlighter: You can highlight any row in the grid (e.g. you can set a slightly darker background color). For example you can set background color based on a priority value in record.
+     * If true, the row highlighter is active. If false, the row highlighter is disabled.
+     */
+    active: boolean;
+    /**
+     * Define the highlighter function. This function should return a boolean value. If the function returns true, the row will be highlighted.
+     * @param record The current record with all fields.
+     */
+    fn: (record: any) => boolean;
+    /**
+     * The class that will be added to the row if the highlighter function returns true.
+     */
+    classList?: string;
+}
+
+export declare interface OverGridSearchConfig {
+    /**
+     * If true, the search is active. If false, the search is disabled.
+     */
+    active: boolean;
+    /**
+     * The placeholder text for the search input.
+     */
+    inputPlaceholder?: string;
+    /**
+     * The initial query to set in the search input when the grid is loaded.
+     * This can be used to pre-populate the search input with a specific value.
+     */
+    initialQuery?: string;
+    /**
+     * The debounce time in milliseconds for the search input.
+     * Default is 300ms.
+     */
+    debounceTime?: number;
+}
+
+export declare interface OverGridUseAboutModalInterface {
+    showModal: () => void;
+    closeModal: () => void;
+    isModalShown: Ref<boolean>;
+}
+
+export declare interface OverGridUseAutoRefreshInterface {
+    changeAutoRefreshValue: (value: string) => void;
+    autoRefresh: Ref<string>;
+}
+
+export declare interface OverGridUseBulkOperationsInterface {
+    checkedRows: Ref<string[]>;
+}
+
+export declare interface OverGridUseColumnFiltersInterface {
+    filters: Ref<OverGridColumnFilter[]>;
+    isFieldActive: (field: OverGridField) => boolean;
+    toggleColumnFilter: (field: OverGridField) => void;
+    fieldUnderAdding: Ref<OverGridField | null>;
+    closeColumnFilterConfigModal: () => void;
+    registerColumnFilter: (filter: OverGridColumnFilter) => void;
+    initiateColumnFilter: (field: OverGridField) => void;
+    removeColumnFilter: (field: OverGridField) => void;
+    editColumnFilter: (field: OverGridField) => void;
+    returnCurrentFilter: (field: OverGridField) => OverGridColumnFilter | undefined;
+}
+
+export declare interface OverGridUseColumnSelectorInterface {
+    showModal: () => void;
+    closeModal: () => void;
+    isModalShown: Ref<boolean>;
+    setColumns: (selectedColumns: string[]) => void;
+    selectedFields: Ref<string[] | null>;
+    filter(fields: OverGridField[]): OverGridField[];
+}
+
+export declare interface OverGridUseCurrentPageExportInterface {
+    showModal: () => void;
+    closeModal: () => void;
+    isModalShown: Ref<boolean>;
+}
+
+export declare interface OverGridUseExtraRowInterface {
+    openedRows: Ref<string[]>;
+    isRowOpened: (id?: string) => boolean;
+    openRow: (id?: string) => void;
+    closeRow: (id?: string) => void;
+    toggleRow: (id?: string) => void;
+}
+
+export declare interface OverGridUseOrderingInterface {
+    isFieldActive: (field: OverGridField) => boolean;
+    addOrder: (field: OverGridField) => void;
+    removeOrder: (field: OverGridField) => void;
+    toggleField: (field: OverGridField) => void;
+    getFieldOrderDirection: (field: OverGridField) => string | undefined;
+    rawState: Ref<{
+        key: string;
+        direction: string;
+    }[]>;
+    state: {
+        key: string;
+        direction: string;
+    }[];
+}
+
+export declare interface OverGridUsePaginationInterface {
+    state: OverGridPaginationState;
+    nextPage: () => void;
+    previousPage: () => void;
+    setPage: (newPage: number) => void;
+    setByResponse: (responseData: any) => void;
+    hasPreviousPage: () => boolean;
+    hasNextPage: () => boolean;
+    lastPage: () => void;
+    firstPage: () => void;
+    currentPageForUI?: ComputedRef<number>;
+    changePageSize: (newPageSize: number) => void;
+    pageSize: ComputedRef<number>;
+}
+
+export declare interface OverGridUseRowHighlighterInterface {
+    getClassList(record: any): string;
+}
+
+export declare interface OverGridUseSearchInterface {
+    query: Ref<string>;
+    debounce: (func: Function) => void;
+}
+
+export { }