overgrid-vue 1.5.0 → 1.6.1

package/dist/index.d.ts

@@ -30,18 +30,7 @@ export declare const OverGrid: {
     component: any;
     }[];
     }> & Readonly<{}>, {
-    fields: {
-    mapping: Ref<OverGridField[]>;
-    actionButtonFieldCounter: number;
-    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;
-    };
+    fields: OverGridFields;
     }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {
     operationsDropdown: ({
     $: ComponentInternalInstance;
@@ -121,6 +110,26 @@ export declare const OverGrid: {
     content?(_: {}): any;
     };
     }) | null;
+    baseOperations: CreateComponentPublicInstanceWithMixins<Readonly<{
+    config: OverGridConfig;
+    columnSelector: OverGridUseColumnSelectorInterface;
+    currentPageExporter: OverGridUseCurrentPageExportInterface;
+    aboutModal: OverGridUseAboutModalInterface;
+    closeDropdown?: () => void;
+    }> & Readonly<{}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {}, HTMLUListElement, ComponentProvideOptions, {
+    P: {};
+    B: {};
+    D: {};
+    C: {};
+    M: {};
+    Defaults: {};
+    }, Readonly<{
+    config: OverGridConfig;
+    columnSelector: OverGridUseColumnSelectorInterface;
+    currentPageExporter: OverGridUseCurrentPageExportInterface;
+    aboutModal: OverGridUseAboutModalInterface;
+    closeDropdown?: () => void;
+    }> & Readonly<{}>, {}, {}, {}, {}, {}> | null;
     }, HTMLDivElement, ComponentProvideOptions, {
     P: {};
     B: {};
@@ -135,18 +144,7 @@ export declare const OverGrid: {
     component: any;
     }[];
     }> & Readonly<{}>, {
-    fields: {
-    mapping: Ref<OverGridField[]>;
-    actionButtonFieldCounter: number;
-    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;
-    };
+    fields: OverGridFields;
     }, {}, {}, {}, {}>;
     __isFragment?: never;
     __isTeleport?: never;
@@ -158,18 +156,7 @@ name: string;
 component: any;
 }[];
 }> & Readonly<{}>, {
-fields: {
-mapping: Ref<OverGridField[]>;
-actionButtonFieldCounter: number;
-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;
-};
+fields: OverGridFields;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}, GlobalComponents, GlobalDirectives, string, ComponentProvideOptions> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
         extraRow?(_: {
@@ -421,8 +408,8 @@ export declare interface OverGridExtraRowConfig {
 }
 
 export declare class OverGridField {
-    constructor(key: string, title: string, fieldsObject: any);
-    fieldsObject: any;
+    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.
@@ -515,25 +502,37 @@ export declare class OverGridField {
          */
         config?: any;
     };
-    setTitle(title: string): this;
-    setVisible(visible: boolean): this;
+    setTitle(title: string): OverGridField;
+    setVisible(visible: boolean): OverGridField;
     setColumnFilter(columnFilter: {
         active: boolean;
         type?: string;
         filterKey?: string;
         config?: any;
-    }): this;
-    setSelectable(selectable: boolean): this;
-    setOrerable(orderable: boolean): this;
-    setOrderKey(orderKey: string): this;
-    setExportable(exportable: boolean): this;
-    setWidth(width: string): this;
-    setFilterKey(filterKey: string): this;
-    setOrderable(orderable: boolean): this;
-    setFormatter(type: string, config?: any): this;
-    setMiddleware(middleware: (data: any, record: any) => any): this;
-    setExportMiddleware(exportMiddleware: (data: any, record: any, format?: string) => any): this;
-    commit(): any;
+    }): OverGridField;
+    setSelectable(selectable: 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;
+    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 {
@@ -582,11 +581,11 @@ export declare interface OverGridPaginationConfig {
     /**
      * The initial page number.
      */
-    initialPage: number;
+    initialPage?: number;
     /**
      * The initial page size.
      */
-    initialSize: number;
+    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.
@@ -687,22 +686,25 @@ export declare interface OverGridUseAboutModalInterface {
     showModal: () => void;
     closeModal: () => void;
     isModalShown: Ref<boolean>;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseAutoRefreshInterface {
     changeAutoRefreshValue: (value: string) => void;
     autoRefresh: Ref<string>;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseBulkOperationsInterface {
     checkedRows: Ref<string[]>;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseColumnFiltersInterface {
     filters: Ref<OverGridColumnFilter[]>;
     isFieldActive: (field: OverGridField) => boolean;
     toggleColumnFilter: (field: OverGridField) => void;
-    fieldUnderAdding: Ref<OverGridField | null>;
+    fieldUnderAdding: any;
     closeColumnFilterConfigModal: () => void;
     registerColumnFilter: (filter: OverGridColumnFilter) => void;
     initiateColumnFilter: (field: OverGridField) => void;
@@ -718,12 +720,14 @@ export declare interface OverGridUseColumnSelectorInterface {
     setColumns: (selectedColumns: string[]) => void;
     selectedFields: Ref<string[] | null>;
     filter(fields: OverGridField[]): OverGridField[];
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseCurrentPageExportInterface {
     showModal: () => void;
     closeModal: () => void;
     isModalShown: Ref<boolean>;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseExtraRowInterface {
@@ -763,6 +767,7 @@ export declare interface OverGridUsePaginationInterface {
     currentPageForUI?: ComputedRef<number>;
     changePageSize: (newPageSize: number) => void;
     pageSize: ComputedRef<number>;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export declare interface OverGridUseRowHighlighterInterface {
@@ -772,6 +777,7 @@ export declare interface OverGridUseRowHighlighterInterface {
 export declare interface OverGridUseSearchInterface {
     query: Ref<string>;
     debounce: (func: Function) => void;
+    isToolbarOptionEnabled: ComputedRef<boolean>;
 }
 
 export { }