@slickgrid-universal/custom-tooltip-plugin 2.4.1 → 2.6.0

package/dist/types/slickCustomTooltip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slickCustomTooltip.d.ts","sourceRoot":"","sources":["../../src/slickCustomTooltip.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,yBAAyB,EAGzB,MAAM,EACN,gBAAgB,EAEhB,mBAAmB,EAEnB,SAAS,EAET,UAAU,EAEV,UAAU,EAEV,aAAa,EACb,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,SAAS,EAET,YAAY,EACb,MAAM,6BAA6B,CAAC;AAKrC,KAAK,QAAQ,GAAG,YAAY,GAAG,qBAAqB,GAAG,wBAAwB,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,kBAAkB;IAC7B,SAAS,CAAC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAC9C,SAAS,CAAC,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;IAClD,SAAS,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;IACxC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAgB;IAC7C,SAAS,CAAC,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAC1D,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACtC,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,IAAI,CAAQ;IAC3C,SAAS,CAAC,cAAc,CAAC,EAAE,aAAa,GAAG,IAAI,CAAQ;IACvD,SAAS,CAAC,WAAW,CAAC,EAAE,cAAc,CAAC;IACvC,SAAS,CAAC,eAAe,2BAQA;IACzB,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAC5B,SAAS,CAAC,aAAa,EAAE,iBAAiB,CAAC;IAC3C,IAAI,EAAE,eAAe,CAA4B;;IAMjD,IAAI,YAAY,IAAI,mBAAmB,GAAG,SAAS,CAElD;IAED,IAAI,kBAAkB,+CAErB;IAED,IAAI,gBAAgB,IAAI,mBAAmB,GAAG,SAAS,CAEtD;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IACD,IAAI,QAAQ,IAAI,aAAa,CAE5B;IAED,iEAAiE;IACjE,IAAI,WAAW,IAAI,UAAU,CAE5B;IAED,8BAA8B;IAC9B,IAAI,OAAO,IAAI,MAAM,CAEpB;IACD,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,UAAU,IAAI,cAAc,GAAG,SAAS,CAE3C;IAED,eAAe,CAAC,IAAI,EAAE,UAAU;IAIhC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB;IAcxD,OAAO;IAOP;;;OAGG;IACH,WAAW;IAOX,UAAU,IAAI,mBAAmB,GAAG,SAAS;IAI7C,UAAU,CAAC,UAAU,EAAE,mBAAmB;IAQ1C;;;OAGG;IACH,SAAS,CAAC,oBAAoB,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAUrI,yEAAyE;IACzE,SAAS,CAAC,8BAA8B,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ;cAyC7E,kBAAkB,CAAC,KAAK,EAAE,cAAc;IA0ExD;;;OAGG;IACH,SAAS,CAAC,yBAAyB,CAAC,eAAe,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;KAAE,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM;IAWhL;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,eAAe,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;KAAE,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAoC9J,SAAS,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;KAAE,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI;IAsDpN;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;KAAE;IAmDzD;;;OAGG;IACH,SAAS,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM;CAa1F"}

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@slickgrid-universal/custom-tooltip-plugin",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "A plugin to add Custom Tooltip when hovering a cell, it subscribes to the cell",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "browser": "./dist/esm/index.js",
-      "import": "./dist/esm/index.d.ts",
-      "require": "./dist/commonjs/index.js"
+      "import": "./dist/esm/index.js",
+      "require": "./dist/commonjs/index.js",
+      "default": "./dist/esm/index.js"
     },
     "./*": "./*"
   },
   "typesVersions": {
     "*": {
       "*": [
-        "./dist/esm/index.d.ts"
+        "./dist/types/index.d.ts"
       ]
     }
   },
-  "types": "dist/esm/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -43,8 +43,8 @@
     "not dead"
   ],
   "dependencies": {
-    "@slickgrid-universal/common": "~2.4.1",
-    "dompurify": "^2.4.3"
+    "@slickgrid-universal/common": "~2.6.0",
+    "dompurify": "^3.0.0"
   },
-  "gitHead": "e62c2da0d9d1c8e97462f4125bfdf735d4e4782d"
+  "gitHead": "9cddf3ee91a91ca829d0ced99c1f20f6d0e9941f"
 }

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export * from './slickCustomTooltip';

package/dist/esm/slickCustomTooltip.d.ts

@@ -1,109 +0,0 @@
-import { CancellablePromiseWrapper, Column, ContainerService, CustomTooltipOption, Formatter, GridOption, RxJsFacade, SharedService, SlickDataView, SlickEventData, SlickEventHandler, SlickGrid, Subscription } from '@slickgrid-universal/common';
-/**
- * A plugin to add Custom Tooltip when hovering a cell, it subscribes to the cell "onMouseEnter" and "onMouseLeave" events.
- * The "customTooltip" is defined in the Column Definition OR Grid Options (the first found will have priority over the second)
- * To specify a tooltip when hovering a cell, extend the column definition like so:
- *
- * Available plugin options (same options are available in both column definition and/or grid options)
- * Example 1  - via Column Definition
- *  this.columnDefinitions = [
- *    {
- *      id: "action", name: "Action", field: "action", formatter: fakeButtonFormatter,
- *      customTooltip: {
- *        formatter: tooltipTaskFormatter,
- *        usabilityOverride: (args) => !!(args.dataContext.id % 2) // show it only every second row
- *      }
- *    }
- *  ];
- *
- *  OR Example 2 - via Grid Options (for all columns), NOTE: the column definition tooltip options will win over the options defined in the grid options
- *  this.gridOptions = {
- *    enableCellNavigation: true,
- *    customTooltip: {
- *    },
- *  };
- */
-export declare class SlickCustomTooltip {
-    protected _addonOptions?: CustomTooltipOption;
-    protected _cellAddonOptions?: CustomTooltipOption;
-    protected _cellNodeElm?: HTMLDivElement;
-    protected _cancellablePromise?: CancellablePromiseWrapper;
-    protected _observable$?: Subscription;
-    protected _rxjs?: RxJsFacade | null;
-    protected _sharedService?: SharedService | null;
-    protected _tooltipElm?: HTMLDivElement;
-    protected _defaultOptions: CustomTooltipOption<any>;
-    protected _grid: SlickGrid;
-    protected _eventHandler: SlickEventHandler;
-    name: 'CustomTooltip';
-    constructor();
-    get addonOptions(): CustomTooltipOption | undefined;
-    get cancellablePromise(): CancellablePromiseWrapper<any> | undefined;
-    get cellAddonOptions(): CustomTooltipOption | undefined;
-    get className(): string;
-    get dataView(): SlickDataView;
-    /** Getter for the Grid Options pulled through the Grid Object */
-    get gridOptions(): GridOption;
-    /** Getter for the grid uid */
-    get gridUid(): string;
-    get gridUidSelector(): string;
-    get tooltipElm(): HTMLDivElement | undefined;
-    addRxJsResource(rxjs: RxJsFacade): void;
-    init(grid: SlickGrid, containerService: ContainerService): void;
-    dispose(): void;
-    /**
-     * hide (remove) tooltip from the DOM, it will also remove it from the DOM and also cancel any pending requests (as mentioned below).
-     * When using async process, it will also cancel any opened Promise/Observable that might still be pending.
-     */
-    hideTooltip(): void;
-    getOptions(): CustomTooltipOption | undefined;
-    setOptions(newOptions: CustomTooltipOption): void;
-    /**
-     * Async process callback will hide any prior tooltip & then merge the new result with the item `dataContext` under a `__params` property
-     * (unless a new prop name is provided) to provice as dataContext object to the asyncPostFormatter.
-     */
-    protected asyncProcessCallback(asyncResult: any, cell: {
-        row: number;
-        cell: number;
-    }, value: any, columnDef: Column, dataContext: any): void;
-    /** depending on the selector type, execute the necessary handler code */
-    protected handleOnHeaderMouseEnterByType(event: SlickEventData, args: any, selector: string): void;
-    protected handleOnMouseEnter(event: SlickEventData): Promise<void>;
-    /**
-     * Parse the Custom Formatter (when provided) or return directly the text when it is already a string.
-     * We will also sanitize the text in both cases before returning it so that it can be used safely.
-     */
-    protected parseFormatterAndSanitize(formatterOrText: Formatter | string | undefined, cell: {
-        row: number;
-        cell: number;
-    }, value: any, columnDef: Column, item: unknown): string;
-    /**
-     * Parse the cell formatter and assume it might be html
-     * then create a temporary html element to easily retrieve the first [title=""] attribute text content
-     * also clear the "title" attribute from the grid div text content so that it won't show also as a 2nd browser tooltip
-     */
-    protected renderRegularTooltip(formatterOrText: Formatter | string | undefined, cell: {
-        row: number;
-        cell: number;
-    }, value: any, columnDef: Column, item: any): void;
-    protected renderTooltipFormatter(formatter: Formatter | string | undefined, cell: {
-        row: number;
-        cell: number;
-    }, value: any, columnDef: Column, item: unknown, tooltipText?: string, inputTitleElm?: Element | null): void;
-    /**
-     * Reposition the Tooltip to be top-left position over the cell.
-     * By default we use an "auto" mode which will allow to position the Tooltip to the best logical position in the window, also when we mention position, we are talking about the relative position against the grid cell.
-     * We can assume that in 80% of the time the default position is top-right, the default is "auto" but we can also override it and use a specific position.
-     * Most of the time positioning of the tooltip will be to the "top-right" of the cell is ok but if our column is completely on the right side then we'll want to change the position to "left" align.
-     * Same goes for the top/bottom position, Most of the time positioning the tooltip to the "top" but if we are hovering a cell at the top of the grid and there's no room to display it then we might need to reposition to "bottom" instead.
-     */
-    protected reposition(cell: {
-        row: number;
-        cell: number;
-    }): void;
-    /**
-     * swap and copy the "title" attribute into a new custom attribute then clear the "title" attribute
-     * from the grid div text content so that it won't show also as a 2nd browser tooltip
-     */
-    protected swapAndClearTitleAttribute(inputTitleElm?: Element | null, tooltipText?: string): void;
-}