slickgrid-vue 1.2.0 → 9.0.0

package/README.md

@@ -5,9 +5,9 @@
 [![NPM downloads](https://img.shields.io/npm/dy/slickgrid-vue)](https://npmjs.org/package/slickgrid-vue)
 [![npm](https://img.shields.io/npm/v/slickgrid-vue.svg?logo=npm&logoColor=fff&label=npm)](https://www.npmjs.com/package/slickgrid-vue)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/slickgrid-vue?color=success&label=gzip)](https://bundlephobia.com/result?p=slickgrid-vue)
-[![Actions Status](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/vue-cypress.yml/badge.svg)](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/vue-cypress.yml)
+[![Actions Status](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/test-vue.yml/badge.svg)](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/test-vue.yml)
 
-## Description 
+## Description
 SlickGrid-Vue is a custom component created specifically for [VueJS](https://vuejs.org/) framework, it is a wrapper on top of Slickgrid-Universal library which contains the core functionalities. Slickgrid-Universal is written with TypeScript in browser native code, it is framework agnostic and is a monorepo that includes all Editors, Filters, Extensions and Services related to SlickGrid usage with also a few optional packages (like GraphQL, OData, Export to Excel, ...).
 
 ## Documentation
@@ -15,9 +15,26 @@ SlickGrid-Vue is a custom component created specifically for [VueJS](https://vue
 
 ## Installation
 
+You can also play with the live Stackbliz [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos).
+Stackblitz is also the recommended way to provide a repro when opening a new bug or feature request.
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/ghiscoding/slickgrid-vue-demos)
+
+Visit the **[Docs - Quick Start](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start)** and/or clone the [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository for a fully working local demo. Please make sure to read the documentation before opening any new issue and also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=slickgrid) unless you think there's a bug with the library.
+
 ```sh
 npm install slickgrid-vue
 ```
+Install any optional Slickgrid-Universal dependencies, for example Excel Export
+```sh
+npm install @slickgrid-universal/excel-export
+```
+
+### Requirements
+- Vue >=3.5
+
+## License
+[MIT License](../../LICENSE)
 
 #### Basic Usage
 
@@ -42,50 +59,18 @@ const gridOptions = ref<GridOption>({ /*...*/ }); // optional grid options
     grid-id="grid1"
     v-model:columns="columnDefinitions"
     v-model:data="dataset"
-    v-model:options="gridOptions"    
+    v-model:options="gridOptions"
   ></slickgrid-vue>
 </template>
 ```
 
-#### Requirements 
-- Vue >=3.4
-  
-### Stackblitz
-
-You can also play with the live Stackbliz [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos). 
-Stackblitz is also the recommended way to provide a repro when opening a new bug or feature request.
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/ghiscoding/slickgrid-vue-demos)
-
-Visit the **[Docs - Quick Start](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start)** and/or clone the [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository for a fully working local demo. Please make sure to read the documentation before opening any new issue and also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=slickgrid) unless you think there's a bug with the library.
-
-### Styling Themes
-
-Multiple styling themes are available
-- Default (UI agnostic)
-- Bootstrap (see all Slickgrid-Vue [live demos](https://ghiscoding.github.io/slickgrid-vue-demos/))
-- Material (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example07))
-- Salesforce (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example16))
-
-Also note that all of these themes also include a **Dark Theme** equivalent and even though Bootstrap is often used in the live demos, it also works well with any other UI framework like Bulma, Material, Quasar...
-
-### Live Demo page
-`Slickgrid-Vue` works with Bootstrap or any other UI frameworks like Material, Bulma, Quasar... and there are also extra styling themes based on Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/slickgrid-vue/styling/svg-icons)
-- [Bootstrap 5 demo](https://ghiscoding.github.io/slickgrid-vue-demos) / [examples repo](https://github.com/ghiscoding/slickgrid-vue-demos)
-
-#### Working Demos
-For a complete set of working demos (45+ examples), we strongly suggest you to clone the [Slickgrid-Vue Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository (instructions are provided in it). The repo comes with multiple examples and are updated frequently (basically every time a new version is out) and it is also used as the GitHub [live demo]([https://github.com/ghiscoding/slickgrid-vue-demos](https://ghiscoding.github.io/slickgrid-vue-demos/) page.
+### Like it? ⭐ it
+You like **Slickgrid-Vue**? Be sure to upvote ⭐ the project, and perhaps support me with caffeine [☕](https://ko-fi.com/ghiscoding) or sponsor me on GitHub. Any contributions are also very welcome. Thanks
 
-## License
-[MIT License](LICENSE)
+<a href='https://ko-fi.com/ghiscoding' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
 
 ## Latest News & Releases
 Check out the [Releases](https://github.com/ghiscoding/slickgrid-universal/releases) section for all latest News & Releases.
 
 ### Tested with [Cypress](https://www.cypress.io/) (E2E Tests)
 Slickgrid-Universal has **100%** Unit Test Coverage and all Slickgrid-Vue Examples are tested with [Cypress](https://www.cypress.io/) for E2E testing and they are running on every new PR.
-
-### Like it? ⭐ it
-You like **Slickgrid-Vue**? Be sure to upvote ⭐ the project, and perhaps support me with caffeine [☕](https://ko-fi.com/ghiscoding) or sponsor me on GitHub. Any contributions are also very welcome. Thanks
-
-<a href='https://ko-fi.com/ghiscoding' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

package/dist/index.d.ts

@@ -64,7 +64,7 @@ import { OnHeaderMouseEventArgs } from '@slickgrid-universal/common';
 import { OnHeaderRowCellRenderedEventArgs } from '@slickgrid-universal/common';
 import { OnKeyDownEventArgs } from '@slickgrid-universal/common';
 import { OnRenderedEventArgs } from '@slickgrid-universal/common';
-import { OnRowBackToViewportRangeArgs } from '@slickgrid-universal/common';
+import { OnRowBackOrOutOfViewportRangeArgs } from '@slickgrid-universal/common';
 import { OnRowCountChangedEventArgs } from '@slickgrid-universal/common';
 import { OnRowsChangedEventArgs } from '@slickgrid-universal/common';
 import { OnRowsOrCountChangedEventArgs } from '@slickgrid-universal/common';
@@ -219,7 +219,7 @@ export declare interface RowDetailView extends RowDetailView_2 {
      * Optionally pass your Parent Component reference to your Child Component (row detail component).
      * note:: If anyone finds a better way of passing the parent to the row detail extension, please reach out and/or create a PR
      */
-    parent?: any;
+    parentRef?: any;
     /** View Model of the preload template which shows after opening row detail & before row detail data shows up */
     preloadComponent?: DefineComponent<any, any, any>;
     /** View Model template that will be loaded once the async function finishes */
@@ -255,8 +255,6 @@ export declare interface SlickgridVueInstance {
     gridEventService: GridEventService;
     /** Grid State Service */
     gridStateService: GridStateService;
-    /** @deprecated @use `headerGroupingService` */
-    groupingService: HeaderGroupingService;
     /** Grouping (and colspan) Service */
     headerGroupingService: HeaderGroupingService;
     /** Pagination Component */
@@ -634,7 +632,7 @@ export declare interface SlickgridVueProps {
             value: any;
         };
     }>) => void;
-    onOnHeaderMenuHideColumns?: (e: CustomEvent<{
+    onOnHideColumns?: (e: CustomEvent<{
         eventData: any;
         args: {
             columns: Column[];
@@ -659,10 +657,10 @@ export declare interface SlickgridVueProps {
         eventData: any;
         args: HeaderMenuCommandItemCallbackArgs;
     }>) => void;
-    onOnItemAdded?: (e: CustomEvent<any>) => void;
-    onOnItemDeleted?: (e: CustomEvent<any>) => void;
-    onOnItemUpdated?: (e: CustomEvent<any>) => void;
-    onOnItemUpserted?: (e: CustomEvent<any>) => void;
+    onOnItemsAdded?: (e: CustomEvent<any>) => void;
+    onOnItemsDeleted?: (e: CustomEvent<any>) => void;
+    onOnItemsUpdated?: (e: CustomEvent<any>) => void;
+    onOnItemsUpserted?: (e: CustomEvent<any>) => void;
     onOnFullResizeByContentRequested?: (e: CustomEvent<any>) => void;
     onOnFilterChanged?: (e: CustomEvent<any>) => void;
     onOnFilterCleared?: (e: CustomEvent<any>) => void;
@@ -742,7 +740,7 @@ export declare class SlickRowDetailView extends SlickRowDetailView_2 {
         item: any;
     }): void;
     /** When Row comes back to Viewport Range, we need to redraw the View */
-    protected handleOnRowBackToViewportRange(_e: SlickEventData<OnRowBackToViewportRangeArgs>, args: {
+    protected handleOnRowBackToViewportRange(_e: SlickEventData<OnRowBackOrOutOfViewportRangeArgs>, args: {
         item: any;
         rowId: string | number;
         rowIndex: number;
@@ -799,7 +797,7 @@ export declare interface ViewModelBindableInputData {
     addon: any;
     grid: SlickGrid;
     dataView: SlickDataView;
-    parent?: any;
+    parentRef?: any;
 }