@chayns-components/typewriter 5.0.0-beta.105 → 5.0.0-beta.110

package/lib/components/typewriter/Typewriter.d.ts

@@ -19,6 +19,11 @@ export type TypewriterProps = {
      * be executed if multiple texts are used.
      */
     onFinish?: VoidFunction;
+    /**
+     * Pseudo-element to be rendered invisible during animation to define the size of the element
+     * for the typewriter effect. By default, the "children" is used for this purpose.
+     */
+    pseudoChildren?: ReactElement | string;
     /**
      * Waiting time before the typewriter resets the content if multiple texts are given
      */

package/lib/components/typewriter/Typewriter.js

@@ -29,6 +29,7 @@ const Typewriter = _ref => {
   let {
     children,
     onFinish,
+    pseudoChildren,
     resetDelay = TypewriterResetDelay.Medium,
     shouldSortChildrenRandomly = false,
     shouldUseResetAnimation = false,
@@ -127,7 +128,13 @@ const Typewriter = _ref => {
     }
   }, [isAnimatingText, onFinish]);
   const shownText = (0, _react.useMemo)(() => (0, _utils.getSubTextFromHTML)(textContent, shownCharCount), [shownCharCount, textContent]);
-  return /*#__PURE__*/_react.default.createElement(_Typewriter.StyledTypewriter, {
+  const pseudoTextHTML = (0, _react.useMemo)(() => {
+    if (pseudoChildren) {
+      return /*#__PURE__*/_react.default.isValidElement(pseudoChildren) ? (0, _server.renderToString)(pseudoChildren) : pseudoChildren;
+    }
+    return textContent || '​';
+  }, [pseudoChildren, textContent]);
+  return (0, _react.useMemo)(() => /*#__PURE__*/_react.default.createElement(_Typewriter.StyledTypewriter, {
     onClick: handleClick
   }, isAnimatingText ? /*#__PURE__*/_react.default.createElement(_Typewriter.StyledTypewriterText, {
     dangerouslySetInnerHTML: {
@@ -136,9 +143,9 @@ const Typewriter = _ref => {
     isAnimatingText: true
   }) : /*#__PURE__*/_react.default.createElement(_Typewriter.StyledTypewriterText, null, sortedChildren), isAnimatingText && /*#__PURE__*/_react.default.createElement(_Typewriter.StyledTypewriterPseudoText, {
     dangerouslySetInnerHTML: {
-      __html: textContent || '​'
+      __html: pseudoTextHTML
     }
-  }));
+  })), [handleClick, isAnimatingText, pseudoChildren, shownText, sortedChildren, textContent]);
 };
 Typewriter.displayName = 'Typewriter';
 var _default = Typewriter;

package/lib/components/typewriter/Typewriter.js.map

@@ -1 +1 @@
-{"version":3,"file":"Typewriter.js","names":["_react","_interopRequireWildcard","require","_server","_Typewriter","_utils","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set","TypewriterResetDelay","exports","TypewriterSpeed","Typewriter","_ref","children","onFinish","resetDelay","Medium","shouldSortChildrenRandomly","shouldUseResetAnimation","speed","currentChildrenIndex","setCurrentChildrenIndex","useState","sortedChildren","useMemo","Array","isArray","shuffleArray","areMultipleChildrenGiven","childrenCount","length","textContent","currentChildren","React","isValidElement","renderToString","charactersCount","getCharactersCount","isResetAnimationActive","setIsResetAnimationActive","shownCharCount","setShownCharCount","shouldStopAnimation","setShouldStopAnimation","isAnimatingText","handleClick","useCallback","handleSetNextChildrenIndex","newIndex","useEffect","interval","window","setInterval","prevState","nextState","clearInterval","setTimeout","shownText","getSubTextFromHTML","createElement","StyledTypewriter","onClick","StyledTypewriterText","dangerouslySetInnerHTML","__html","StyledTypewriterPseudoText","displayName","_default"],"sources":["../../../src/components/typewriter/Typewriter.tsx"],"sourcesContent":["import React, { FC, ReactElement, useCallback, useEffect, useMemo, useState } from 'react';\nimport { renderToString } from 'react-dom/server';\nimport {\n    StyledTypewriter,\n    StyledTypewriterPseudoText,\n    StyledTypewriterText,\n} from './Typewriter.styles';\nimport { getCharactersCount, getSubTextFromHTML, shuffleArray } from './utils';\n\n// noinspection JSUnusedGlobalSymbols\nexport enum TypewriterResetDelay {\n    Slow = 4000,\n    Medium = 2000,\n    Fast = 1000,\n}\n\n// noinspection JSUnusedGlobalSymbols\nexport enum TypewriterSpeed {\n    Slow = 40,\n    Medium = 30,\n    Fast = 20,\n}\n\nexport type TypewriterProps = {\n    /**\n     * The text to type\n     */\n    children: ReactElement | ReactElement[] | string | string[];\n    /**\n     * Function that is executed when the typewriter animation has finished. This function will not\n     * be executed if multiple texts are used.\n     */\n    onFinish?: VoidFunction;\n    /**\n     * Waiting time before the typewriter resets the content if multiple texts are given\n     */\n    resetDelay?: TypewriterResetDelay;\n    /**\n     * Specifies whether the children should be sorted randomly if there are multiple texts.\n     * This makes the typewriter start with a different text each time and also changes them\n     * in a random order.\n     */\n    shouldSortChildrenRandomly?: boolean;\n    /**\n     * Specifies whether the reset of the text should be animated with a backspace animation for\n     * multiple texts.\n     */\n    shouldUseResetAnimation?: boolean;\n    /**\n     * The speed of the animation. Use the TypewriterSpeed enum for this prop.\n     */\n    speed?: TypewriterSpeed;\n};\n\nconst Typewriter: FC<TypewriterProps> = ({\n    children,\n    onFinish,\n    resetDelay = TypewriterResetDelay.Medium,\n    shouldSortChildrenRandomly = false,\n    shouldUseResetAnimation = false,\n    speed = TypewriterSpeed.Medium,\n}) => {\n    const [currentChildrenIndex, setCurrentChildrenIndex] = useState(0);\n\n    const sortedChildren = useMemo(\n        () =>\n            Array.isArray(children) && shouldSortChildrenRandomly\n                ? shuffleArray<ReactElement | string>(children)\n                : children,\n        [children, shouldSortChildrenRandomly]\n    );\n\n    const areMultipleChildrenGiven = Array.isArray(sortedChildren);\n    const childrenCount = areMultipleChildrenGiven ? sortedChildren.length : 1;\n\n    const textContent = useMemo(() => {\n        if (areMultipleChildrenGiven) {\n            const currentChildren = sortedChildren[currentChildrenIndex];\n\n            if (currentChildren) {\n                return React.isValidElement(currentChildren)\n                    ? renderToString(currentChildren)\n                    : currentChildren;\n            }\n\n            return '';\n        }\n\n        return React.isValidElement(sortedChildren)\n            ? renderToString(sortedChildren)\n            : sortedChildren;\n    }, [areMultipleChildrenGiven, currentChildrenIndex, sortedChildren]);\n\n    const charactersCount = useMemo(() => getCharactersCount(textContent), [textContent]);\n\n    const [isResetAnimationActive, setIsResetAnimationActive] = useState(false);\n    const [shownCharCount, setShownCharCount] = useState(\n        charactersCount > 0 ? 0 : textContent.length\n    );\n    const [shouldStopAnimation, setShouldStopAnimation] = useState(false);\n\n    const isAnimatingText =\n        shownCharCount !== textContent.length ||\n        areMultipleChildrenGiven ||\n        textContent.length === 0;\n\n    const handleClick = useCallback(() => {\n        setShouldStopAnimation(true);\n    }, []);\n\n    const handleSetNextChildrenIndex = useCallback(\n        () =>\n            setCurrentChildrenIndex(() => {\n                let newIndex = currentChildrenIndex + 1;\n\n                if (newIndex > childrenCount - 1) {\n                    newIndex = 0;\n                }\n\n                return newIndex;\n            }),\n        [childrenCount, currentChildrenIndex]\n    );\n\n    useEffect(() => {\n        let interval: number | undefined;\n\n        if (shouldStopAnimation || charactersCount === 0) {\n            setShownCharCount(textContent.length);\n        } else if (isResetAnimationActive) {\n            interval = window.setInterval(() => {\n                setShownCharCount((prevState) => {\n                    const nextState = prevState - 1;\n\n                    if (nextState === 0) {\n                        window.clearInterval(interval);\n\n                        if (areMultipleChildrenGiven) {\n                            setTimeout(() => {\n                                setIsResetAnimationActive(false);\n                                handleSetNextChildrenIndex();\n                            }, resetDelay);\n                        }\n                    }\n\n                    return nextState;\n                });\n            }, speed);\n        } else {\n            interval = window.setInterval(() => {\n                setShownCharCount((prevState) => {\n                    let nextState = prevState + 1;\n\n                    if (nextState === charactersCount) {\n                        window.clearInterval(interval);\n\n                        /**\n                         * At this point, the next value for \"shownCharCount\" is deliberately set to\n                         * the length of the textContent in order to correctly display HTML elements\n                         * after the last letter.\n                         */\n                        nextState = textContent.length;\n\n                        if (areMultipleChildrenGiven) {\n                            setTimeout(() => {\n                                if (shouldUseResetAnimation) {\n                                    setIsResetAnimationActive(true);\n                                } else {\n                                    setShownCharCount(0);\n                                    setTimeout(handleSetNextChildrenIndex, resetDelay / 2);\n                                }\n                            }, resetDelay);\n                        }\n                    }\n\n                    return nextState;\n                });\n            }, speed);\n        }\n\n        return () => {\n            window.clearInterval(interval);\n        };\n    }, [\n        shouldStopAnimation,\n        speed,\n        textContent.length,\n        charactersCount,\n        isResetAnimationActive,\n        areMultipleChildrenGiven,\n        resetDelay,\n        childrenCount,\n        handleSetNextChildrenIndex,\n        shouldUseResetAnimation,\n    ]);\n\n    useEffect(() => {\n        if (charactersCount) {\n            setIsResetAnimationActive(false);\n            setShownCharCount(0);\n        }\n    }, [charactersCount]);\n\n    useEffect(() => {\n        if (!isAnimatingText && typeof onFinish === 'function') {\n            onFinish();\n        }\n    }, [isAnimatingText, onFinish]);\n\n    const shownText = useMemo(\n        () => getSubTextFromHTML(textContent, shownCharCount),\n        [shownCharCount, textContent]\n    );\n\n    return (\n        <StyledTypewriter onClick={handleClick}>\n            {isAnimatingText ? (\n                <StyledTypewriterText\n                    dangerouslySetInnerHTML={{ __html: shownText }}\n                    isAnimatingText\n                />\n            ) : (\n                <StyledTypewriterText>{sortedChildren}</StyledTypewriterText>\n            )}\n            {isAnimatingText && (\n                <StyledTypewriterPseudoText\n                    dangerouslySetInnerHTML={{ __html: textContent || '&#8203;' }}\n                />\n            )}\n        </StyledTypewriter>\n    );\n};\n\nTypewriter.displayName = 'Typewriter';\n\nexport default Typewriter;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,WAAA,GAAAF,OAAA;AAKA,IAAAG,MAAA,GAAAH,OAAA;AAA+E,SAAAI,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAN,wBAAAU,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAE,GAAA,CAAAL,GAAA,SAAAM,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAX,GAAA,QAAAW,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAd,GAAA,EAAAW,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAV,GAAA,EAAAW,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAX,GAAA,CAAAW,GAAA,SAAAL,MAAA,CAAAJ,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAhB,GAAA,EAAAM,MAAA,YAAAA,MAAA;AAE/E;AAAA,IACYW,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA,OAMhC;AAAAC,OAAA,CAAAD,oBAAA,GAAAA,oBAAA;AAAA,IACYE,eAAe,0BAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAAAD,OAAA,CAAAC,eAAA,GAAAA,eAAA;AAqC3B,MAAMC,UAA+B,GAAGC,IAAA,IAOlC;EAAA,IAPmC;IACrCC,QAAQ;IACRC,QAAQ;IACRC,UAAU,GAAGP,oBAAoB,CAACQ,MAAM;IACxCC,0BAA0B,GAAG,KAAK;IAClCC,uBAAuB,GAAG,KAAK;IAC/BC,KAAK,GAAGT,eAAe,CAACM;EAC5B,CAAC,GAAAJ,IAAA;EACG,MAAM,CAACQ,oBAAoB,EAAEC,uBAAuB,CAAC,GAAG,IAAAC,eAAQ,EAAC,CAAC,CAAC;EAEnE,MAAMC,cAAc,GAAG,IAAAC,cAAO,EAC1B,MACIC,KAAK,CAACC,OAAO,CAACb,QAAQ,CAAC,IAAII,0BAA0B,GAC/C,IAAAU,mBAAY,EAAwBd,QAAQ,CAAC,GAC7CA,QAAQ,EAClB,CAACA,QAAQ,EAAEI,0BAA0B,CAAC,CACzC;EAED,MAAMW,wBAAwB,GAAGH,KAAK,CAACC,OAAO,CAACH,cAAc,CAAC;EAC9D,MAAMM,aAAa,GAAGD,wBAAwB,GAAGL,cAAc,CAACO,MAAM,GAAG,CAAC;EAE1E,MAAMC,WAAW,GAAG,IAAAP,cAAO,EAAC,MAAM;IAC9B,IAAII,wBAAwB,EAAE;MAC1B,MAAMI,eAAe,GAAGT,cAAc,CAACH,oBAAoB,CAAC;MAE5D,IAAIY,eAAe,EAAE;QACjB,OAAO,aAAAC,cAAK,CAACC,cAAc,CAACF,eAAe,CAAC,GACtC,IAAAG,sBAAc,EAACH,eAAe,CAAC,GAC/BA,eAAe;MACzB;MAEA,OAAO,EAAE;IACb;IAEA,OAAO,aAAAC,cAAK,CAACC,cAAc,CAACX,cAAc,CAAC,GACrC,IAAAY,sBAAc,EAACZ,cAAc,CAAC,GAC9BA,cAAc;EACxB,CAAC,EAAE,CAACK,wBAAwB,EAAER,oBAAoB,EAAEG,cAAc,CAAC,CAAC;EAEpE,MAAMa,eAAe,GAAG,IAAAZ,cAAO,EAAC,MAAM,IAAAa,yBAAkB,EAACN,WAAW,CAAC,EAAE,CAACA,WAAW,CAAC,CAAC;EAErF,MAAM,CAACO,sBAAsB,EAAEC,yBAAyB,CAAC,GAAG,IAAAjB,eAAQ,EAAC,KAAK,CAAC;EAC3E,MAAM,CAACkB,cAAc,EAAEC,iBAAiB,CAAC,GAAG,IAAAnB,eAAQ,EAChDc,eAAe,GAAG,CAAC,GAAG,CAAC,GAAGL,WAAW,CAACD,MAAM,CAC/C;EACD,MAAM,CAACY,mBAAmB,EAAEC,sBAAsB,CAAC,GAAG,IAAArB,eAAQ,EAAC,KAAK,CAAC;EAErE,MAAMsB,eAAe,GACjBJ,cAAc,KAAKT,WAAW,CAACD,MAAM,IACrCF,wBAAwB,IACxBG,WAAW,CAACD,MAAM,KAAK,CAAC;EAE5B,MAAMe,WAAW,GAAG,IAAAC,kBAAW,EAAC,MAAM;IAClCH,sBAAsB,CAAC,IAAI,CAAC;EAChC,CAAC,EAAE,EAAE,CAAC;EAEN,MAAMI,0BAA0B,GAAG,IAAAD,kBAAW,EAC1C,MACIzB,uBAAuB,CAAC,MAAM;IAC1B,IAAI2B,QAAQ,GAAG5B,oBAAoB,GAAG,CAAC;IAEvC,IAAI4B,QAAQ,GAAGnB,aAAa,GAAG,CAAC,EAAE;MAC9BmB,QAAQ,GAAG,CAAC;IAChB;IAEA,OAAOA,QAAQ;EACnB,CAAC,CAAC,EACN,CAACnB,aAAa,EAAET,oBAAoB,CAAC,CACxC;EAED,IAAA6B,gBAAS,EAAC,MAAM;IACZ,IAAIC,QAA4B;IAEhC,IAAIR,mBAAmB,IAAIN,eAAe,KAAK,CAAC,EAAE;MAC9CK,iBAAiB,CAACV,WAAW,CAACD,MAAM,CAAC;IACzC,CAAC,MAAM,IAAIQ,sBAAsB,EAAE;MAC/BY,QAAQ,GAAGC,MAAM,CAACC,WAAW,CAAC,MAAM;QAChCX,iBAAiB,CAAEY,SAAS,IAAK;UAC7B,MAAMC,SAAS,GAAGD,SAAS,GAAG,CAAC;UAE/B,IAAIC,SAAS,KAAK,CAAC,EAAE;YACjBH,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;YAE9B,IAAItB,wBAAwB,EAAE;cAC1B4B,UAAU,CAAC,MAAM;gBACbjB,yBAAyB,CAAC,KAAK,CAAC;gBAChCQ,0BAA0B,EAAE;cAChC,CAAC,EAAEhC,UAAU,CAAC;YAClB;UACJ;UAEA,OAAOuC,SAAS;QACpB,CAAC,CAAC;MACN,CAAC,EAAEnC,KAAK,CAAC;IACb,CAAC,MAAM;MACH+B,QAAQ,GAAGC,MAAM,CAACC,WAAW,CAAC,MAAM;QAChCX,iBAAiB,CAAEY,SAAS,IAAK;UAC7B,IAAIC,SAAS,GAAGD,SAAS,GAAG,CAAC;UAE7B,IAAIC,SAAS,KAAKlB,eAAe,EAAE;YAC/Be,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;;YAE9B;AACxB;AACA;AACA;AACA;YACwBI,SAAS,GAAGvB,WAAW,CAACD,MAAM;YAE9B,IAAIF,wBAAwB,EAAE;cAC1B4B,UAAU,CAAC,MAAM;gBACb,IAAItC,uBAAuB,EAAE;kBACzBqB,yBAAyB,CAAC,IAAI,CAAC;gBACnC,CAAC,MAAM;kBACHE,iBAAiB,CAAC,CAAC,CAAC;kBACpBe,UAAU,CAACT,0BAA0B,EAAEhC,UAAU,GAAG,CAAC,CAAC;gBAC1D;cACJ,CAAC,EAAEA,UAAU,CAAC;YAClB;UACJ;UAEA,OAAOuC,SAAS;QACpB,CAAC,CAAC;MACN,CAAC,EAAEnC,KAAK,CAAC;IACb;IAEA,OAAO,MAAM;MACTgC,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;IAClC,CAAC;EACL,CAAC,EAAE,CACCR,mBAAmB,EACnBvB,KAAK,EACLY,WAAW,CAACD,MAAM,EAClBM,eAAe,EACfE,sBAAsB,EACtBV,wBAAwB,EACxBb,UAAU,EACVc,aAAa,EACbkB,0BAA0B,EAC1B7B,uBAAuB,CAC1B,CAAC;EAEF,IAAA+B,gBAAS,EAAC,MAAM;IACZ,IAAIb,eAAe,EAAE;MACjBG,yBAAyB,CAAC,KAAK,CAAC;MAChCE,iBAAiB,CAAC,CAAC,CAAC;IACxB;EACJ,CAAC,EAAE,CAACL,eAAe,CAAC,CAAC;EAErB,IAAAa,gBAAS,EAAC,MAAM;IACZ,IAAI,CAACL,eAAe,IAAI,OAAO9B,QAAQ,KAAK,UAAU,EAAE;MACpDA,QAAQ,EAAE;IACd;EACJ,CAAC,EAAE,CAAC8B,eAAe,EAAE9B,QAAQ,CAAC,CAAC;EAE/B,MAAM2C,SAAS,GAAG,IAAAjC,cAAO,EACrB,MAAM,IAAAkC,yBAAkB,EAAC3B,WAAW,EAAES,cAAc,CAAC,EACrD,CAACA,cAAc,EAAET,WAAW,CAAC,CAChC;EAED,oBACInD,MAAA,CAAAa,OAAA,CAAAkE,aAAA,CAAC3E,WAAA,CAAA4E,gBAAgB;IAACC,OAAO,EAAEhB;EAAY,GAClCD,eAAe,gBACZhE,MAAA,CAAAa,OAAA,CAAAkE,aAAA,CAAC3E,WAAA,CAAA8E,oBAAoB;IACjBC,uBAAuB,EAAE;MAAEC,MAAM,EAAEP;IAAU,CAAE;IAC/Cb,eAAe;EAAA,EACjB,gBAEFhE,MAAA,CAAAa,OAAA,CAAAkE,aAAA,CAAC3E,WAAA,CAAA8E,oBAAoB,QAAEvC,cAAc,CACxC,EACAqB,eAAe,iBACZhE,MAAA,CAAAa,OAAA,CAAAkE,aAAA,CAAC3E,WAAA,CAAAiF,0BAA0B;IACvBF,uBAAuB,EAAE;MAAEC,MAAM,EAAEjC,WAAW,IAAI;IAAU;EAAE,EAErE,CACc;AAE3B,CAAC;AAEDpB,UAAU,CAACuD,WAAW,GAAG,YAAY;AAAC,IAAAC,QAAA,GAEvBxD,UAAU;AAAAF,OAAA,CAAAhB,OAAA,GAAA0E,QAAA"}
+{"version":3,"file":"Typewriter.js","names":["_react","_interopRequireWildcard","require","_server","_Typewriter","_utils","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set","TypewriterResetDelay","exports","TypewriterSpeed","Typewriter","_ref","children","onFinish","pseudoChildren","resetDelay","Medium","shouldSortChildrenRandomly","shouldUseResetAnimation","speed","currentChildrenIndex","setCurrentChildrenIndex","useState","sortedChildren","useMemo","Array","isArray","shuffleArray","areMultipleChildrenGiven","childrenCount","length","textContent","currentChildren","React","isValidElement","renderToString","charactersCount","getCharactersCount","isResetAnimationActive","setIsResetAnimationActive","shownCharCount","setShownCharCount","shouldStopAnimation","setShouldStopAnimation","isAnimatingText","handleClick","useCallback","handleSetNextChildrenIndex","newIndex","useEffect","interval","window","setInterval","prevState","nextState","clearInterval","setTimeout","shownText","getSubTextFromHTML","pseudoTextHTML","createElement","StyledTypewriter","onClick","StyledTypewriterText","dangerouslySetInnerHTML","__html","StyledTypewriterPseudoText","displayName","_default"],"sources":["../../../src/components/typewriter/Typewriter.tsx"],"sourcesContent":["import React, { FC, ReactElement, useCallback, useEffect, useMemo, useState } from 'react';\nimport { renderToString } from 'react-dom/server';\nimport {\n    StyledTypewriter,\n    StyledTypewriterPseudoText,\n    StyledTypewriterText,\n} from './Typewriter.styles';\nimport { getCharactersCount, getSubTextFromHTML, shuffleArray } from './utils';\n\n// noinspection JSUnusedGlobalSymbols\nexport enum TypewriterResetDelay {\n    Slow = 4000,\n    Medium = 2000,\n    Fast = 1000,\n}\n\n// noinspection JSUnusedGlobalSymbols\nexport enum TypewriterSpeed {\n    Slow = 40,\n    Medium = 30,\n    Fast = 20,\n}\n\nexport type TypewriterProps = {\n    /**\n     * The text to type\n     */\n    children: ReactElement | ReactElement[] | string | string[];\n    /**\n     * Function that is executed when the typewriter animation has finished. This function will not\n     * be executed if multiple texts are used.\n     */\n    onFinish?: VoidFunction;\n    /**\n     * Pseudo-element to be rendered invisible during animation to define the size of the element\n     * for the typewriter effect. By default, the \"children\" is used for this purpose.\n     */\n    pseudoChildren?: ReactElement | string;\n    /**\n     * Waiting time before the typewriter resets the content if multiple texts are given\n     */\n    resetDelay?: TypewriterResetDelay;\n    /**\n     * Specifies whether the children should be sorted randomly if there are multiple texts.\n     * This makes the typewriter start with a different text each time and also changes them\n     * in a random order.\n     */\n    shouldSortChildrenRandomly?: boolean;\n    /**\n     * Specifies whether the reset of the text should be animated with a backspace animation for\n     * multiple texts.\n     */\n    shouldUseResetAnimation?: boolean;\n    /**\n     * The speed of the animation. Use the TypewriterSpeed enum for this prop.\n     */\n    speed?: TypewriterSpeed;\n};\n\nconst Typewriter: FC<TypewriterProps> = ({\n    children,\n    onFinish,\n    pseudoChildren,\n    resetDelay = TypewriterResetDelay.Medium,\n    shouldSortChildrenRandomly = false,\n    shouldUseResetAnimation = false,\n    speed = TypewriterSpeed.Medium,\n}) => {\n    const [currentChildrenIndex, setCurrentChildrenIndex] = useState(0);\n\n    const sortedChildren = useMemo(\n        () =>\n            Array.isArray(children) && shouldSortChildrenRandomly\n                ? shuffleArray<ReactElement | string>(children)\n                : children,\n        [children, shouldSortChildrenRandomly]\n    );\n\n    const areMultipleChildrenGiven = Array.isArray(sortedChildren);\n    const childrenCount = areMultipleChildrenGiven ? sortedChildren.length : 1;\n\n    const textContent = useMemo(() => {\n        if (areMultipleChildrenGiven) {\n            const currentChildren = sortedChildren[currentChildrenIndex];\n\n            if (currentChildren) {\n                return React.isValidElement(currentChildren)\n                    ? renderToString(currentChildren)\n                    : currentChildren;\n            }\n\n            return '';\n        }\n\n        return React.isValidElement(sortedChildren)\n            ? renderToString(sortedChildren)\n            : sortedChildren;\n    }, [areMultipleChildrenGiven, currentChildrenIndex, sortedChildren]);\n\n    const charactersCount = useMemo(() => getCharactersCount(textContent), [textContent]);\n\n    const [isResetAnimationActive, setIsResetAnimationActive] = useState(false);\n    const [shownCharCount, setShownCharCount] = useState(\n        charactersCount > 0 ? 0 : textContent.length\n    );\n    const [shouldStopAnimation, setShouldStopAnimation] = useState(false);\n\n    const isAnimatingText =\n        shownCharCount !== textContent.length ||\n        areMultipleChildrenGiven ||\n        textContent.length === 0;\n\n    const handleClick = useCallback(() => {\n        setShouldStopAnimation(true);\n    }, []);\n\n    const handleSetNextChildrenIndex = useCallback(\n        () =>\n            setCurrentChildrenIndex(() => {\n                let newIndex = currentChildrenIndex + 1;\n\n                if (newIndex > childrenCount - 1) {\n                    newIndex = 0;\n                }\n\n                return newIndex;\n            }),\n        [childrenCount, currentChildrenIndex]\n    );\n\n    useEffect(() => {\n        let interval: number | undefined;\n\n        if (shouldStopAnimation || charactersCount === 0) {\n            setShownCharCount(textContent.length);\n        } else if (isResetAnimationActive) {\n            interval = window.setInterval(() => {\n                setShownCharCount((prevState) => {\n                    const nextState = prevState - 1;\n\n                    if (nextState === 0) {\n                        window.clearInterval(interval);\n\n                        if (areMultipleChildrenGiven) {\n                            setTimeout(() => {\n                                setIsResetAnimationActive(false);\n                                handleSetNextChildrenIndex();\n                            }, resetDelay);\n                        }\n                    }\n\n                    return nextState;\n                });\n            }, speed);\n        } else {\n            interval = window.setInterval(() => {\n                setShownCharCount((prevState) => {\n                    let nextState = prevState + 1;\n\n                    if (nextState === charactersCount) {\n                        window.clearInterval(interval);\n\n                        /**\n                         * At this point, the next value for \"shownCharCount\" is deliberately set to\n                         * the length of the textContent in order to correctly display HTML elements\n                         * after the last letter.\n                         */\n                        nextState = textContent.length;\n\n                        if (areMultipleChildrenGiven) {\n                            setTimeout(() => {\n                                if (shouldUseResetAnimation) {\n                                    setIsResetAnimationActive(true);\n                                } else {\n                                    setShownCharCount(0);\n                                    setTimeout(handleSetNextChildrenIndex, resetDelay / 2);\n                                }\n                            }, resetDelay);\n                        }\n                    }\n\n                    return nextState;\n                });\n            }, speed);\n        }\n\n        return () => {\n            window.clearInterval(interval);\n        };\n    }, [\n        shouldStopAnimation,\n        speed,\n        textContent.length,\n        charactersCount,\n        isResetAnimationActive,\n        areMultipleChildrenGiven,\n        resetDelay,\n        childrenCount,\n        handleSetNextChildrenIndex,\n        shouldUseResetAnimation,\n    ]);\n\n    useEffect(() => {\n        if (charactersCount) {\n            setIsResetAnimationActive(false);\n            setShownCharCount(0);\n        }\n    }, [charactersCount]);\n\n    useEffect(() => {\n        if (!isAnimatingText && typeof onFinish === 'function') {\n            onFinish();\n        }\n    }, [isAnimatingText, onFinish]);\n\n    const shownText = useMemo(\n        () => getSubTextFromHTML(textContent, shownCharCount),\n        [shownCharCount, textContent]\n    );\n\n    const pseudoTextHTML = useMemo(() => {\n        if (pseudoChildren) {\n            return React.isValidElement(pseudoChildren)\n                ? renderToString(pseudoChildren)\n                : pseudoChildren;\n        }\n\n        return textContent || '&#8203;';\n    }, [pseudoChildren, textContent]);\n\n    return useMemo(\n        () => (\n            <StyledTypewriter onClick={handleClick}>\n                {isAnimatingText ? (\n                    <StyledTypewriterText\n                        dangerouslySetInnerHTML={{ __html: shownText }}\n                        isAnimatingText\n                    />\n                ) : (\n                    <StyledTypewriterText>{sortedChildren}</StyledTypewriterText>\n                )}\n                {isAnimatingText && (\n                    <StyledTypewriterPseudoText\n                        dangerouslySetInnerHTML={{ __html: pseudoTextHTML }}\n                    />\n                )}\n            </StyledTypewriter>\n        ),\n        [handleClick, isAnimatingText, pseudoChildren, shownText, sortedChildren, textContent]\n    );\n};\n\nTypewriter.displayName = 'Typewriter';\n\nexport default Typewriter;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,WAAA,GAAAF,OAAA;AAKA,IAAAG,MAAA,GAAAH,OAAA;AAA+E,SAAAI,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAN,wBAAAU,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAE,GAAA,CAAAL,GAAA,SAAAM,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAX,GAAA,QAAAW,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAd,GAAA,EAAAW,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAV,GAAA,EAAAW,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAX,GAAA,CAAAW,GAAA,SAAAL,MAAA,CAAAJ,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAhB,GAAA,EAAAM,MAAA,YAAAA,MAAA;AAE/E;AAAA,IACYW,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAApBA,oBAAoB,CAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA,OAMhC;AAAAC,OAAA,CAAAD,oBAAA,GAAAA,oBAAA;AAAA,IACYE,eAAe,0BAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAfA,eAAe,CAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAAAD,OAAA,CAAAC,eAAA,GAAAA,eAAA;AA0C3B,MAAMC,UAA+B,GAAGC,IAAA,IAQlC;EAAA,IARmC;IACrCC,QAAQ;IACRC,QAAQ;IACRC,cAAc;IACdC,UAAU,GAAGR,oBAAoB,CAACS,MAAM;IACxCC,0BAA0B,GAAG,KAAK;IAClCC,uBAAuB,GAAG,KAAK;IAC/BC,KAAK,GAAGV,eAAe,CAACO;EAC5B,CAAC,GAAAL,IAAA;EACG,MAAM,CAACS,oBAAoB,EAAEC,uBAAuB,CAAC,GAAG,IAAAC,eAAQ,EAAC,CAAC,CAAC;EAEnE,MAAMC,cAAc,GAAG,IAAAC,cAAO,EAC1B,MACIC,KAAK,CAACC,OAAO,CAACd,QAAQ,CAAC,IAAIK,0BAA0B,GAC/C,IAAAU,mBAAY,EAAwBf,QAAQ,CAAC,GAC7CA,QAAQ,EAClB,CAACA,QAAQ,EAAEK,0BAA0B,CAAC,CACzC;EAED,MAAMW,wBAAwB,GAAGH,KAAK,CAACC,OAAO,CAACH,cAAc,CAAC;EAC9D,MAAMM,aAAa,GAAGD,wBAAwB,GAAGL,cAAc,CAACO,MAAM,GAAG,CAAC;EAE1E,MAAMC,WAAW,GAAG,IAAAP,cAAO,EAAC,MAAM;IAC9B,IAAII,wBAAwB,EAAE;MAC1B,MAAMI,eAAe,GAAGT,cAAc,CAACH,oBAAoB,CAAC;MAE5D,IAAIY,eAAe,EAAE;QACjB,OAAO,aAAAC,cAAK,CAACC,cAAc,CAACF,eAAe,CAAC,GACtC,IAAAG,sBAAc,EAACH,eAAe,CAAC,GAC/BA,eAAe;MACzB;MAEA,OAAO,EAAE;IACb;IAEA,OAAO,aAAAC,cAAK,CAACC,cAAc,CAACX,cAAc,CAAC,GACrC,IAAAY,sBAAc,EAACZ,cAAc,CAAC,GAC9BA,cAAc;EACxB,CAAC,EAAE,CAACK,wBAAwB,EAAER,oBAAoB,EAAEG,cAAc,CAAC,CAAC;EAEpE,MAAMa,eAAe,GAAG,IAAAZ,cAAO,EAAC,MAAM,IAAAa,yBAAkB,EAACN,WAAW,CAAC,EAAE,CAACA,WAAW,CAAC,CAAC;EAErF,MAAM,CAACO,sBAAsB,EAAEC,yBAAyB,CAAC,GAAG,IAAAjB,eAAQ,EAAC,KAAK,CAAC;EAC3E,MAAM,CAACkB,cAAc,EAAEC,iBAAiB,CAAC,GAAG,IAAAnB,eAAQ,EAChDc,eAAe,GAAG,CAAC,GAAG,CAAC,GAAGL,WAAW,CAACD,MAAM,CAC/C;EACD,MAAM,CAACY,mBAAmB,EAAEC,sBAAsB,CAAC,GAAG,IAAArB,eAAQ,EAAC,KAAK,CAAC;EAErE,MAAMsB,eAAe,GACjBJ,cAAc,KAAKT,WAAW,CAACD,MAAM,IACrCF,wBAAwB,IACxBG,WAAW,CAACD,MAAM,KAAK,CAAC;EAE5B,MAAMe,WAAW,GAAG,IAAAC,kBAAW,EAAC,MAAM;IAClCH,sBAAsB,CAAC,IAAI,CAAC;EAChC,CAAC,EAAE,EAAE,CAAC;EAEN,MAAMI,0BAA0B,GAAG,IAAAD,kBAAW,EAC1C,MACIzB,uBAAuB,CAAC,MAAM;IAC1B,IAAI2B,QAAQ,GAAG5B,oBAAoB,GAAG,CAAC;IAEvC,IAAI4B,QAAQ,GAAGnB,aAAa,GAAG,CAAC,EAAE;MAC9BmB,QAAQ,GAAG,CAAC;IAChB;IAEA,OAAOA,QAAQ;EACnB,CAAC,CAAC,EACN,CAACnB,aAAa,EAAET,oBAAoB,CAAC,CACxC;EAED,IAAA6B,gBAAS,EAAC,MAAM;IACZ,IAAIC,QAA4B;IAEhC,IAAIR,mBAAmB,IAAIN,eAAe,KAAK,CAAC,EAAE;MAC9CK,iBAAiB,CAACV,WAAW,CAACD,MAAM,CAAC;IACzC,CAAC,MAAM,IAAIQ,sBAAsB,EAAE;MAC/BY,QAAQ,GAAGC,MAAM,CAACC,WAAW,CAAC,MAAM;QAChCX,iBAAiB,CAAEY,SAAS,IAAK;UAC7B,MAAMC,SAAS,GAAGD,SAAS,GAAG,CAAC;UAE/B,IAAIC,SAAS,KAAK,CAAC,EAAE;YACjBH,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;YAE9B,IAAItB,wBAAwB,EAAE;cAC1B4B,UAAU,CAAC,MAAM;gBACbjB,yBAAyB,CAAC,KAAK,CAAC;gBAChCQ,0BAA0B,EAAE;cAChC,CAAC,EAAEhC,UAAU,CAAC;YAClB;UACJ;UAEA,OAAOuC,SAAS;QACpB,CAAC,CAAC;MACN,CAAC,EAAEnC,KAAK,CAAC;IACb,CAAC,MAAM;MACH+B,QAAQ,GAAGC,MAAM,CAACC,WAAW,CAAC,MAAM;QAChCX,iBAAiB,CAAEY,SAAS,IAAK;UAC7B,IAAIC,SAAS,GAAGD,SAAS,GAAG,CAAC;UAE7B,IAAIC,SAAS,KAAKlB,eAAe,EAAE;YAC/Be,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;;YAE9B;AACxB;AACA;AACA;AACA;YACwBI,SAAS,GAAGvB,WAAW,CAACD,MAAM;YAE9B,IAAIF,wBAAwB,EAAE;cAC1B4B,UAAU,CAAC,MAAM;gBACb,IAAItC,uBAAuB,EAAE;kBACzBqB,yBAAyB,CAAC,IAAI,CAAC;gBACnC,CAAC,MAAM;kBACHE,iBAAiB,CAAC,CAAC,CAAC;kBACpBe,UAAU,CAACT,0BAA0B,EAAEhC,UAAU,GAAG,CAAC,CAAC;gBAC1D;cACJ,CAAC,EAAEA,UAAU,CAAC;YAClB;UACJ;UAEA,OAAOuC,SAAS;QACpB,CAAC,CAAC;MACN,CAAC,EAAEnC,KAAK,CAAC;IACb;IAEA,OAAO,MAAM;MACTgC,MAAM,CAACI,aAAa,CAACL,QAAQ,CAAC;IAClC,CAAC;EACL,CAAC,EAAE,CACCR,mBAAmB,EACnBvB,KAAK,EACLY,WAAW,CAACD,MAAM,EAClBM,eAAe,EACfE,sBAAsB,EACtBV,wBAAwB,EACxBb,UAAU,EACVc,aAAa,EACbkB,0BAA0B,EAC1B7B,uBAAuB,CAC1B,CAAC;EAEF,IAAA+B,gBAAS,EAAC,MAAM;IACZ,IAAIb,eAAe,EAAE;MACjBG,yBAAyB,CAAC,KAAK,CAAC;MAChCE,iBAAiB,CAAC,CAAC,CAAC;IACxB;EACJ,CAAC,EAAE,CAACL,eAAe,CAAC,CAAC;EAErB,IAAAa,gBAAS,EAAC,MAAM;IACZ,IAAI,CAACL,eAAe,IAAI,OAAO/B,QAAQ,KAAK,UAAU,EAAE;MACpDA,QAAQ,EAAE;IACd;EACJ,CAAC,EAAE,CAAC+B,eAAe,EAAE/B,QAAQ,CAAC,CAAC;EAE/B,MAAM4C,SAAS,GAAG,IAAAjC,cAAO,EACrB,MAAM,IAAAkC,yBAAkB,EAAC3B,WAAW,EAAES,cAAc,CAAC,EACrD,CAACA,cAAc,EAAET,WAAW,CAAC,CAChC;EAED,MAAM4B,cAAc,GAAG,IAAAnC,cAAO,EAAC,MAAM;IACjC,IAAIV,cAAc,EAAE;MAChB,OAAO,aAAAmB,cAAK,CAACC,cAAc,CAACpB,cAAc,CAAC,GACrC,IAAAqB,sBAAc,EAACrB,cAAc,CAAC,GAC9BA,cAAc;IACxB;IAEA,OAAOiB,WAAW,IAAI,SAAS;EACnC,CAAC,EAAE,CAACjB,cAAc,EAAEiB,WAAW,CAAC,CAAC;EAEjC,OAAO,IAAAP,cAAO,EACV,mBACI7C,MAAA,CAAAa,OAAA,CAAAoE,aAAA,CAAC7E,WAAA,CAAA8E,gBAAgB;IAACC,OAAO,EAAEjB;EAAY,GAClCD,eAAe,gBACZjE,MAAA,CAAAa,OAAA,CAAAoE,aAAA,CAAC7E,WAAA,CAAAgF,oBAAoB;IACjBC,uBAAuB,EAAE;MAAEC,MAAM,EAAER;IAAU,CAAE;IAC/Cb,eAAe;EAAA,EACjB,gBAEFjE,MAAA,CAAAa,OAAA,CAAAoE,aAAA,CAAC7E,WAAA,CAAAgF,oBAAoB,QAAExC,cAAc,CACxC,EACAqB,eAAe,iBACZjE,MAAA,CAAAa,OAAA,CAAAoE,aAAA,CAAC7E,WAAA,CAAAmF,0BAA0B;IACvBF,uBAAuB,EAAE;MAAEC,MAAM,EAAEN;IAAe;EAAE,EAE3D,CAER,EACD,CAACd,WAAW,EAAED,eAAe,EAAE9B,cAAc,EAAE2C,SAAS,EAAElC,cAAc,EAAEQ,WAAW,CAAC,CACzF;AACL,CAAC;AAEDrB,UAAU,CAACyD,WAAW,GAAG,YAAY;AAAC,IAAAC,QAAA,GAEvB1D,UAAU;AAAAF,OAAA,CAAAhB,OAAA,GAAA4E,QAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/typewriter",
-    "version": "5.0.0-beta.105",
+    "version": "5.0.0-beta.110",
     "description": "A set of beautiful React components for developing your own applications with chayns.",
     "keywords": [
         "chayns",
@@ -63,5 +63,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "e22fc61291eefa6633fb92097194be11baf60e71"
+    "gitHead": "a9b6f9e39c587d09b5784554b4206d19a81536e4"
 }