@gorilla-engine-sdk/ge-dialogs-lib 0.5.7

package/dist/tooltips/ToolTipRoot.d.ts

@@ -0,0 +1,30 @@
+import * as React from 'react';
+import { ToolTipType } from './ToolTipContext';
+/**
+ * ToolTip Root Props
+ */
+interface ToolTipRootProps {
+    /**
+     * Map of ToolTip instances associated by unique ids
+     */
+    ToolTips: Record<string, ToolTipType>;
+    /**
+     * Container component for ToolTips
+     *
+     * ToolTips will be rendered as children of this component. React.Fragment is
+     * used by defualt, specifying a different component can change the way ToolTips
+     * are rendered across the whole application.
+     */
+    component?: React.ComponentType<any>;
+    /**
+     * Specifies the root element to render ToolTips into
+     */
+    container?: Element;
+}
+/**
+ * ToolTip Root
+ *
+ * Renders ToolTips using react portal.
+ */
+export declare const ToolTipRoot: React.MemoExoticComponent<({ ToolTips, container, component: RootComponent }: ToolTipRootProps) => React.JSX.Element>;
+export {};

package/dist/tooltips/ToolTipRoot.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolTipRoot = void 0;
+const react_1 = require("react");
+const React = __importStar(require("react"));
+const DialogsStyleState_1 = require("../DialogsStyleState");
+/**
+ * Component responsible for rendering the ToolTip.
+ *
+ * The identity of `Component` may change dependeing on the inputs passed to
+ * `useToolTip`. If we simply rendered `<Component />` then the ToolTip would be
+ * susceptible to rerenders whenever one of the inputs change.
+ */
+const ToolTipRenderer = (0, react_1.memo)(({ component, width, height, ...rest }) => {
+    const rendered = component(rest);
+    return React.createElement(React.Fragment, null, rendered);
+});
+/**
+ * ToolTip Root
+ *
+ * Renders ToolTips using react portal.
+ */
+exports.ToolTipRoot = (0, react_1.memo)(({ ToolTips, container, component: RootComponent = React.Fragment }) => {
+    //const [mountNode, setMountNode] = useState<Element | undefined>(undefined);
+    const stylesState = (0, DialogsStyleState_1.useDialogsStylesState)();
+    return (React.createElement(RootComponent, null, Object.keys(ToolTips).map((key) => (React.createElement(ToolTipRenderer, { key: key, component: ToolTips[key], width: stylesState.pluginWidth, height: stylesState.pluginHeight })))));
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVG9vbFRpcFJvb3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdG9vbHRpcHMvVG9vbFRpcFJvb3QudHN4Il0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlDQUFrRDtBQUNsRCw2Q0FBK0I7QUFFL0IsNERBQWdGO0FBdUNoRjs7Ozs7O0dBTUc7QUFDSCxNQUFNLGVBQWUsR0FBRyxJQUFBLFlBQUksRUFBQyxDQUFDLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsR0FBRyxJQUFJLEVBQXdCLEVBQUUsRUFBRTtJQUMzRixNQUFNLFFBQVEsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFvQixDQUFDO0lBQ3BELE9BQU8sMENBQUcsUUFBUSxDQUFJLENBQUM7QUFDekIsQ0FBQyxDQUFDLENBQUM7QUFFSDs7OztHQUlHO0FBQ1UsUUFBQSxXQUFXLEdBQUcsSUFBQSxZQUFJLEVBQzdCLENBQUMsRUFBRSxRQUFRLEVBQUUsU0FBUyxFQUFFLFNBQVMsRUFBRSxhQUFhLEdBQUcsS0FBSyxDQUFDLFFBQVEsRUFBb0IsRUFBRSxFQUFFO0lBQ3ZGLDZFQUE2RTtJQUM3RSxNQUFNLFdBQVcsR0FBc0IsSUFBQSx5Q0FBcUIsR0FBRSxDQUFDO0lBRS9ELE9BQU8sQ0FDTCxvQkFBQyxhQUFhLFFBQ1gsTUFBTSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLENBQ2xDLG9CQUFDLGVBQWUsSUFDZCxHQUFHLEVBQUUsR0FBRyxFQUNSLFNBQVMsRUFBRSxRQUFRLENBQUMsR0FBRyxDQUFDLEVBQ3hCLEtBQUssRUFBRSxXQUFXLENBQUMsV0FBVyxFQUM5QixNQUFNLEVBQUUsV0FBVyxDQUFDLFlBQVksR0FDaEMsQ0FDSCxDQUFDLENBQ1ksQ0FDakIsQ0FBQztBQUNKLENBQUMsQ0FDRixDQUFDIn0=

package/dist/tooltips/useToolTip.d.ts

@@ -0,0 +1,14 @@
+import { ToolTipsStyle } from '../DialogsStyleState';
+/**
+ * Callback types provided for descriptive type-hints
+ */
+type ShowToolTip = (compnent: any, id: string, style?: ToolTipsStyle) => void;
+type HideToolTip = () => void;
+/**
+ * React hook for showing ToolTip windows
+ */
+type UseToolTipProps = {
+    toolTipStyle: ToolTipsStyle;
+};
+export declare const useToolTip: (props?: UseToolTipProps) => [ShowToolTip, HideToolTip];
+export {};

package/dist/tooltips/useToolTip.js

@@ -0,0 +1,102 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useToolTip = void 0;
+const React = __importStar(require("react"));
+const react_1 = require("react");
+const ToolTipContext_1 = require("./ToolTipContext");
+const DefaultToolTip_1 = __importDefault(require("./DefaultToolTip"));
+const DialogsStyleState_1 = require("../DialogsStyleState");
+const dialogsDefaultStyle_1 = require("../dialogsDefaultStyle");
+/**
+ * Utility function to generate unique number per component instance
+ */
+const generateToolTipKey = (() => {
+    let count = 0;
+    return () => `${++count}`;
+})();
+/**
+ * Check whether the argument is a stateless component.
+ *
+ * We take advantage of the stateless nature of functional components to be
+ * inline the rendering of the ToolTip component as part of another immutable
+ * component.
+ *
+ * This is necessary for allowing the ToolTip to update based on the inputs passed
+ * as the second argument to useToolTip without unmounting the previous version of
+ * the ToolTip component.
+ */
+const isFunctionalComponent = (Component) => {
+    const prototype = Component.prototype;
+    return !prototype || !prototype.isReactComponent;
+};
+let showToolTipInterval;
+const useToolTip = (props) => {
+    const stylesState = (0, DialogsStyleState_1.useDialogsStylesState)();
+    const context = (0, react_1.useContext)(ToolTipContext_1.ToolTipContext);
+    const key = (0, react_1.useMemo)(generateToolTipKey, []);
+    const [isShown, setShown] = (0, react_1.useState)(false);
+    const duration = (0, react_1.useMemo)(() => {
+        const toolTipStyle = stylesState.toolTip ?? dialogsDefaultStyle_1.dialogsDefaultStyle.toolTip;
+        return toolTipStyle.showDelay ? toolTipStyle.showDelay : 0;
+    }, [stylesState.toolTip]);
+    const showToolTip = (component, id, toolTipStyle) => {
+        const showTT = () => {
+            const c = () => (React.createElement(DefaultToolTip_1.default, { component: component, id: id, toolTipStyle: toolTipStyle ? toolTipStyle : props?.toolTipStyle }));
+            context.showToolTip(key, c);
+        };
+        if (showToolTipInterval) {
+            clearInterval(showToolTipInterval);
+        }
+        if (duration) {
+            showToolTipInterval = setInterval(showTT, duration);
+        }
+        else {
+            showTT();
+        }
+    };
+    const hideToolTip = () => {
+        if (showToolTipInterval) {
+            clearInterval(showToolTipInterval);
+        }
+        context.hideToolTip(key);
+    };
+    return [showToolTip, hideToolTip];
+};
+exports.useToolTip = useToolTip;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlVG9vbFRpcC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90b29sdGlwcy91c2VUb29sVGlwLnRzeCJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSw2Q0FBK0I7QUFFL0IsaUNBQXNEO0FBQ3RELHFEQUErRDtBQUMvRCxzRUFBOEM7QUFDOUMsNERBQStGO0FBQy9GLGdFQUE2RDtBQVE3RDs7R0FFRztBQUNILE1BQU0sa0JBQWtCLEdBQUcsQ0FBQyxHQUFHLEVBQUU7SUFDL0IsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDO0lBRWQsT0FBTyxHQUFHLEVBQUUsQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLENBQUM7QUFDNUIsQ0FBQyxDQUFDLEVBQUUsQ0FBQztBQUVMOzs7Ozs7Ozs7O0dBVUc7QUFDSCxNQUFNLHFCQUFxQixHQUFHLENBQUMsU0FBbUIsRUFBRSxFQUFFO0lBQ3BELE1BQU0sU0FBUyxHQUFHLFNBQVMsQ0FBQyxTQUFTLENBQUM7SUFFdEMsT0FBTyxDQUFDLFNBQVMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQztBQUNuRCxDQUFDLENBQUM7QUFhRixJQUFJLG1CQUErQyxDQUFDO0FBRTdDLE1BQU0sVUFBVSxHQUFHLENBQUMsS0FBdUIsRUFBOEIsRUFBRTtJQUNoRixNQUFNLFdBQVcsR0FBc0IsSUFBQSx5Q0FBcUIsR0FBRSxDQUFDO0lBQy9ELE1BQU0sT0FBTyxHQUFHLElBQUEsa0JBQVUsRUFBQywrQkFBYyxDQUFDLENBQUM7SUFFM0MsTUFBTSxHQUFHLEdBQUcsSUFBQSxlQUFPLEVBQUMsa0JBQWtCLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFFNUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxRQUFRLENBQUMsR0FBRyxJQUFBLGdCQUFRLEVBQVUsS0FBSyxDQUFDLENBQUM7SUFFckQsTUFBTSxRQUFRLEdBQUcsSUFBQSxlQUFPLEVBQUMsR0FBRyxFQUFFO1FBQzVCLE1BQU0sWUFBWSxHQUFHLFdBQVcsQ0FBQyxPQUFPLElBQUkseUNBQW1CLENBQUMsT0FBUSxDQUFDO1FBQ3pFLE9BQU8sWUFBWSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzdELENBQUMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBRTFCLE1BQU0sV0FBVyxHQUFHLENBQUMsU0FBYyxFQUFFLEVBQVUsRUFBRSxZQUE0QixFQUFFLEVBQUU7UUFDL0UsTUFBTSxNQUFNLEdBQUcsR0FBRyxFQUFFO1lBQ2xCLE1BQU0sQ0FBQyxHQUFnQixHQUFHLEVBQUUsQ0FBQyxDQUMzQixvQkFBQyx3QkFBYyxJQUNiLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLEVBQUUsRUFBRSxFQUFFLEVBQ04sWUFBWSxFQUFFLFlBQVksQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsWUFBWSxHQUMvRCxDQUNILENBQUM7WUFDRixPQUFPLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUM5QixDQUFDLENBQUM7UUFDRixJQUFJLG1CQUFtQixFQUFFLENBQUM7WUFDeEIsYUFBYSxDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFDckMsQ0FBQztRQUNELElBQUksUUFBUSxFQUFFLENBQUM7WUFDYixtQkFBbUIsR0FBRyxXQUFXLENBQUMsTUFBTSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3RELENBQUM7YUFBTSxDQUFDO1lBQ04sTUFBTSxFQUFFLENBQUM7UUFDWCxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBRUYsTUFBTSxXQUFXLEdBQUcsR0FBRyxFQUFFO1FBQ3ZCLElBQUksbUJBQW1CLEVBQUUsQ0FBQztZQUN4QixhQUFhLENBQUMsbUJBQW1CLENBQUMsQ0FBQztRQUNyQyxDQUFDO1FBQ0QsT0FBTyxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUMzQixDQUFDLENBQUM7SUFFRixPQUFPLENBQUMsV0FBVyxFQUFFLFdBQVcsQ0FBQyxDQUFDO0FBQ3BDLENBQUMsQ0FBQztBQTFDVyxRQUFBLFVBQVUsY0EwQ3JCIn0=

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@gorilla-engine-sdk/ge-dialogs-lib",
+  "version": "0.5.7",
+  "description": "React dialogs library for Gorilla Engine plugins (modals, tooltips, notifications)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"No tests specified for ge-dialogs-lib\"",
+    "prepack": "npx tsc",
+    "start": "tsc -w",
+    "build": "npx tsc --declaration",
+    "ci:publish": "node ../../scripts/ci-publish.js"
+  },
+  "author": "UJAM Inc.",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "files": [
+    "dist",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@gorilla-engine-sdk/gorilla-engine-react": "^1.6.1",
+    "react": "^19.0.0"
+  },
+  "devDependencies": {
+    "@gorilla-engine-sdk/gorilla-engine-react": "^1.6.1",
+    "@types/gorilla-engine": "^1.1.33",
+    "@types/node": "^18.11.9",
+    "@types/react": "^19.2.16",
+    "@types/react-reconciler": "^0.33.0",
+    "react": "^19.0.0",
+    "typescript": "^6.0.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {},
+  "homepage": "https://www.gorilla-engine.com/",
+  "keywords": [
+    "gorilla-engine",
+    "UJAM"
+  ]
+}