overgrid-vue 1.9.2 → 1.9.4

package/dist/index.d.ts

@@ -343,7 +343,11 @@ export declare interface OverGridConfig {
      * @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, config: OverGridConfig, fields: OverGridFields, searchQuery?: string) => URLSearchParams;
+    serverTransformation?: (orders: any, pagination: any, filters: any, config: any, fields: any, searchQuery?: string) => URLSearchParams;
+    /**
+     * If true, the grid will skip the initial data fetch when the grid is mounted. You can use this option if you want to fetch the data manually or if you want to wait for some other operations before fetching the data.
+     */
+    skipAutoFetch?: boolean;
     /**
      * 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.
@@ -557,6 +561,49 @@ export declare class OverGridField {
     setMiddleware(middleware: (data: any, record: any) => any): OverGridField;
     setExportMiddleware(exportMiddleware: (data: any, record: any, format?: string) => any): OverGridField;
     commit(): OverGridFields;
+    getFieldSnapshot(): {
+        key: string;
+        title: string;
+        visible: boolean | undefined;
+        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;
+        } | undefined;
+        middleware: ((data: any, record: any) => any) | undefined;
+        exportMiddleware: ((data: any, record: any, format?: string) => any) | undefined;
+        selectable: boolean | undefined;
+        orderable: boolean | undefined;
+        orderKey: string | undefined;
+        exportable: boolean | undefined;
+        width: string | undefined;
+        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;
+        } | undefined;
+    };
 }
 
 declare class OverGridFields {
@@ -570,6 +617,28 @@ declare class OverGridFields {
     addEnumField(key: string, title: string, enumMapping: OverGridEnumMapping, extraConfig?: any): OverGridField;
     addBooleanField(key: string, title: string, extraConfig?: any): OverGridField;
     addActionButtonField(title: string, buttons: OverGridActionButton[] | ((record: any) => OverGridActionButton[])): OverGridField;
+    getFieldsSnapshot(): {
+        key: string;
+        title: string;
+        visible: boolean | undefined;
+        columnFilter: {
+            active: boolean;
+            type?: string;
+            filterKey?: string;
+            config?: any;
+        } | undefined;
+        middleware: ((data: any, record: any) => any) | undefined;
+        exportMiddleware: ((data: any, record: any, format?: string) => any) | undefined;
+        selectable: boolean | undefined;
+        orderable: boolean | undefined;
+        orderKey: string | undefined;
+        exportable: boolean | undefined;
+        width: string | undefined;
+        formatter: {
+            type: string;
+            config?: any;
+        } | undefined;
+    }[];
 }
 
 export declare interface OverGridOrderConfig {