typescript-overlay-essentials 2.1.1 → 2.1.2

package/dist/TutorialOverlay.js

@@ -56,6 +56,8 @@ export function TutorialOverlay({ state, setState }) {
     const [highlightElementRect, setHighlightElementRect] = useState(null);
     // Wird verwendet um zu tracken bei welchem Schritt des Tutorials der Nutzer ist
     const [tutorialStep, setTutorialStep] = useState(0);
+    // Wird verwendet um ggf. die TutorialBox wenn sie oben aus dem Bildschirm ragt nach unten zu verschieben
+    const tutorialBoxRef = useRef(null);
     const proceedButtonRef = useRef(null);
     // Sobald der State von außen aktualisiert wird triggert diese Funktion
     // Die setzt showTutorial auf true
@@ -88,6 +90,27 @@ export function TutorialOverlay({ state, setState }) {
             document.body.style.overflow = "";
         };
     }, [showTutorial]);
+    useEffect(() => {
+        var _a, _b, _c;
+        if (!tutorialPos || !tutorialBoxRef.current || tutorialPos.position !== Positions.TOP)
+            return;
+        const tutorialBoxRect = tutorialBoxRef.current.getBoundingClientRect();
+        if (tutorialBoxRect.top < 0) {
+            const attachElement = (typeof ((_a = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _a === void 0 ? void 0 : _a.attachToObject) === "string"
+                ? document.getElementById((_b = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _b === void 0 ? void 0 : _b.attachToObject)
+                : (_c = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _c === void 0 ? void 0 : _c.attachToObject);
+            if (attachElement instanceof HTMLElement) {
+                var rect = attachElement.getBoundingClientRect();
+                // 25 rem
+                const _1rem = parseFloat(getComputedStyle(document.documentElement).fontSize);
+                setTutorialPos({
+                    position: Positions.BOTTOM,
+                    px_left: null,
+                    px_top: rect.bottom + _1rem
+                });
+            }
+        }
+    }, [tutorialPos, tutorialStep]);
     const showTutorialAtElement = (e, dontHighlightElement) => {
         var rect = e.getBoundingClientRect();
         const viewportHeight = window.innerHeight;
@@ -103,17 +126,15 @@ export function TutorialOverlay({ state, setState }) {
         // 25 rem
         const _1rem = parseFloat(getComputedStyle(document.documentElement).fontSize);
         const tooltipWidth = 32 * _1rem;
-        const tooltipHeight = tooltipWidth;
         const position = rect.right + tooltipWidth <= window.innerWidth ? Positions.RIGHT
             : (rect.left - tooltipWidth >= 0 ? Positions.LEFT
-                : (rect.top - tooltipHeight >= 0 ? Positions.TOP
-                    : Positions.BOTTOM));
+                : Positions.TOP); // Immer Top nehmen und nur wenn tatsächlich rausragt => Nach rendern auf Bottom ändern
         setTutorialPos({
             position,
             px_left: position === Positions.LEFT ? rect.left - tooltipWidth
                 : (position === Positions.RIGHT ? rect.right + _1rem
                     : null),
-            px_top: position === Positions.TOP ? (rect.top - tooltipHeight) : (position !== Positions.BOTTOM ? rect.top : (rect.bottom + _1rem))
+            px_top: position === Positions.TOP ? (rect.top - _1rem) : rect.top
         });
         if (!dontHighlightElement) {
             setHighlightElementRect({
@@ -143,11 +164,11 @@ export function TutorialOverlay({ state, setState }) {
                                 position: "fixed",
                                 left: (_e = tutorialPos.px_left) !== null && _e !== void 0 ? _e : '',
                                 top: tutorialPos.px_top,
-                                transform: 'none'
+                                transform: tutorialPos.position === Positions.TOP ? "translateY(-100%)" : 'none'
                             }
                             : {}),
                         ...((state === null || state === void 0 ? void 0 : state.style) != null ? state.style : {})
-                    }, role: "dialog", "aria-modal": "true", "aria-labelledby": ((_f = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _f === void 0 ? void 0 : _f.headline) != null ? "tutorial-headline" : undefined, "aria-label": ((_g = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _g === void 0 ? void 0 : _g.headline) != null ? undefined : "Tutorial", "aria-describedby": "tutorial-message", onKeyDown: (event) => {
+                    }, ref: tutorialBoxRef, role: "dialog", "aria-modal": "true", "aria-labelledby": ((_f = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _f === void 0 ? void 0 : _f.headline) != null ? "tutorial-headline" : undefined, "aria-label": ((_g = state === null || state === void 0 ? void 0 : state.steps[tutorialStep]) === null || _g === void 0 ? void 0 : _g.headline) != null ? undefined : "Tutorial", "aria-describedby": "tutorial-message", onKeyDown: (event) => {
                         var _a;
                         if (event.key === "Escape") {
                             const nextCommand = (_a = state.cancelCommand) !== null && _a !== void 0 ? _a : null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-overlay-essentials",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Eine kleine Ansammlung an praktischen Tools, die out of the Box genutzt werden können. Alle enthaltenen Overlays können als Reaktion auf etwas geöffnet werden und schließen sich danach automatisch. Es beinhaltet: \\n - [ConfirmationBox]: Ein Overlay mit einer ConfirmationBox (Fortfahren / Abbrechen), \\n - [InfoOverlay]: ein simples Overlay mit einer Informationsbox die man bestätigen kann, \\n - [InfoOverlayWithInput]: Ein Overlay bei dem ein User zusätzlich ein Freitext-Feld zur Eingabe hat, \\n - [LoadingOverlay]: Ein simples Overlay mit einer Lade-animation und optionalem Ladetext, \\n - [MultipleChoiceOverlay]: Ein simples Overlay bei dem ein Nutzer aus mehreren gegebenen Aktionen auswählen kann, \\n - [MultipleRadioOverlay]: Ein simples Overlay bei dem ein Nutzer genau eine aus mehreren gegebenen Aktionen auswählen kann, \\n - [Toast]: Ein simpler Toast der für kurze Zeit grün hinterlegt in der oberen rechten Ecke des Bildschirms angezeigt wird, \\n - [ToggleSwitch]: Eine Auswahl aus zwei Optionen aus denen ein Nutzer wählen kann in der Darstellung (Option 1 | Option 2), \\n - [Dropdown]: Ein simples Dropdown-Menü (auf Basis von react-select), welches einfacherer zu Konfigurieren ist und einige default-Einstellungen hat, \\n - [InputFilter]: Ein Tool was genutzt werden kann um auf einem Inputfeld einen Regex-Filter anzuwenden und dem User so nur Eingaben erlaubt die dem Filter entsprechen.",
   "keywords": [
     "typescript",