slickgrid-react 4.0.2 → 4.1.0

package/src/slickgrid-react/models/slickgridReactInstance.interface.ts

@@ -0,0 +1,71 @@
+import {
+  BackendService,
+  ExtensionService,
+  FilterService,
+  GridEventService,
+  GridService,
+  GridStateService,
+  GroupingAndColspanService,
+  PaginationService,
+  ResizerService,
+  SlickDataView,
+  SortService,
+  TreeDataService
+} from '@slickgrid-universal/common';
+import { EventPubSubService } from '@slickgrid-universal/event-pub-sub';
+
+import { SlickGrid } from '../models/index';
+
+export interface SlickgridReactInstance {
+  element: HTMLDivElement;
+
+  /** Slick DataView object */
+  dataView: SlickDataView;
+
+  /** Slick Grid object */
+  slickGrid: SlickGrid;
+
+  // --
+  // Methods
+  /** Dispose of the grid and optionally empty the DOM element grid container as well */
+  dispose: (emptyDomElementContainer?: boolean) => void;
+
+  // --
+  // Services
+
+  /** Backend Service, when available */
+  backendService?: BackendService;
+
+  /** EventPubSub Service instance that is used internal by the lib and could be used externally to subscribe to Slickgrid-React events */
+  eventPubSubService?: EventPubSubService;
+
+  /** Extension (Plugins & Controls) Service */
+  extensionService: ExtensionService;
+
+  /** Filter Service */
+  filterService: FilterService;
+
+  /** Grid Service (grid extra functionalities) */
+  gridService: GridService;
+
+  /** Grid Events Service */
+  gridEventService: GridEventService;
+
+  /** Grid State Service */
+  gridStateService: GridStateService;
+
+  /** Grouping (and colspan) Service */
+  groupingService: GroupingAndColspanService;
+
+  /** Pagination Service (allows you to programmatically go to first/last page, etc...) */
+  paginationService?: PaginationService;
+
+  /** Resizer Service (including auto-resize) */
+  resizerService: ResizerService;
+
+  /** Sort Service */
+  sortService: SortService;
+
+  /** Tree Data View Service */
+  treeDataService: TreeDataService;
+}

package/src/slickgrid-react/services/container.service.ts

@@ -0,0 +1,13 @@
+import { ContainerService as UniversalContainerService } from '@slickgrid-universal/common';
+
+export class ContainerService implements UniversalContainerService {
+  private readonly container: { [key: string]: any } = {};
+
+  get<T = any>(key: string): T | null {
+    return this.container[key];
+  }
+
+  registerInstance(key: string, instance: any) {
+    this.container[key] = instance;
+  }
+}

package/src/slickgrid-react/services/index.ts

@@ -0,0 +1,4 @@
+export * from './reactUtil.service';
+export * from './container.service';
+export * from './translater.service';
+export * from './utilities';

package/src/slickgrid-react/services/reactUtil.service.ts

@@ -0,0 +1,26 @@
+import React, { ReactNode } from 'react';
+import ReactDOM from 'react-dom';
+import { SlickgridReactComponentOutput } from '../models/reactComponentOutput.interface';
+
+export class ReactUtilService {
+  createReactComponentAppendToDom(component: any, targetElement?: HTMLElement | Element, clearTargetContent = false, props: any = undefined, children: ReactNode[] = []): SlickgridReactComponentOutput {
+    const componentElement = React.createElement(component, props, children);
+    let componentInstance: any;
+
+    // Append DOM element to the HTML element specified
+    if (targetElement) {
+      if (clearTargetContent && targetElement.innerHTML) {
+        targetElement.innerHTML = '';
+      }
+      // @ts-ignore
+      componentInstance = ReactDOM.render(componentElement, targetElement);
+    } else {
+      // @ts-ignore
+      componentInstance = ReactDOM.render(componentElement, document.body);
+    }
+
+    const domElement = ReactDOM.findDOMNode(componentInstance);
+
+    return { componentInstance, componentElement, domElement };
+  }
+}

package/src/slickgrid-react/services/singletons.ts

@@ -0,0 +1,7 @@
+import { SharedService } from '@slickgrid-universal/common';
+import { EventPubSubService } from '@slickgrid-universal/event-pub-sub';
+import { ContainerService } from './container.service';
+
+export const GlobalEventPubSubService = new EventPubSubService();
+export const GlobalEventSharedService = new SharedService();
+export const GlobalContainerService = new ContainerService();

package/src/slickgrid-react/services/translater.service.ts

@@ -0,0 +1,36 @@
+import { TranslaterService as UniversalTranslateService } from '@slickgrid-universal/common';
+import i18next, { i18n } from 'i18next';
+
+/**
+ * This is a Translate Service Wrapper for Slickgrid-Universal monorepo lib to work properly,
+ * it must implement Slickgrid-Universal TranslaterService interface to work properly
+ */
+export class TranslaterService implements UniversalTranslateService {
+  private readonly i18n: i18n = i18next;
+
+  /**
+   * Method to return the current language used by the App
+   * @return {string} current language
+   */
+  getCurrentLanguage(): string {
+    return this.i18n.language;
+  }
+
+  /**
+   * Method to set the language to use in the App and Translate Service
+   * @param {string} language
+   * @return {Promise} output
+   */
+  async use(newLang: string): Promise<any> {
+    return this.i18n.changeLanguage(newLang);
+  }
+
+  /**
+   * Method which receives a translation key and returns the translated value assigned to that key
+   * @param {string} translation key
+   * @return {string} translated value
+   */
+  translate(translationKey: string): string {
+    return this.i18n.t(translationKey);
+  }
+}

package/src/slickgrid-react/services/utilities.ts

@@ -0,0 +1,18 @@
+import { EventSubscription } from '@slickgrid-universal/common';
+
+/**
+ * Loop through and dispose of all subscriptions when they are disposable
+ * @param subscriptions
+ * @return empty array
+ */
+export function disposeAllSubscriptions(subscriptions: Array<EventSubscription>): Array<EventSubscription> {
+  if (Array.isArray(subscriptions)) {
+    while (subscriptions.length > 0) {
+      const subscription = subscriptions.pop() as EventSubscription;
+      if ((subscription as EventSubscription)?.unsubscribe) {
+        (subscription as EventSubscription).unsubscribe!();
+      }
+    }
+  }
+  return subscriptions;
+}

package/src/slickgrid-react/slickgrid-config.ts

@@ -0,0 +1,10 @@
+import { GridOption } from './models/gridOption.interface';
+import { GlobalGridOptions } from './global-grid-options';
+
+export class SlickgridConfig {
+  options: Partial<GridOption>;
+
+  constructor() {
+    this.options = GlobalGridOptions;
+  }
+}

package/.gitbook.yaml

@@ -1,5 +0,0 @@
-root: ./docs/
-
-structure:
-  readme: README.md
-  summary: TOC.md

package/global.d.ts

@@ -1,2 +0,0 @@
-import 'jest-extended';
-import 'jsdom-global/register';

package/tsconfig.json

@@ -1,44 +0,0 @@
-{
-  "compileOnSave": false,
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "sourceMap": true,
-    "allowSyntheticDefaultImports": true,
-    "downlevelIteration": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "allowJs": true,
-    "baseUrl": "src",
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "jsx": "react",
-    "lib": [
-      "es2018",
-      "dom"
-    ],
-    "typeRoots": [
-      "node_modules/@types",
-      "src/typings"
-    ]
-  },
-  "exclude": [
-    "react_project",
-    "dist",
-    "node_modules",
-    "**/*.spec.ts"
-  ],
-  "filesGlob": [
-    "./src/**/*.ts",
-    "./test/**/*.ts",
-    "./custom_typings/**/*.d.ts"
-  ],
-  "include": [
-    "src/**/*.ts",
-    "src/typings/**/*.ts"
-  ],
-  "typeAcquisition": { "include": ["jest"] }
-}