react-markdown-typewriter 1.0.0 → 1.0.2

package/README.md

@@ -2,6 +2,8 @@
 
 This library provides a new component, `MarkdownTypewriter`, that combines the Markdown component of [react-markdown](https://www.npmjs.com/package/react-markdown) with the animation of typewriter. The animation was created entirely with [motion](https://www.npmjs.com/package/motion).
 
+Live demo: <https://codesandbox.io/p/sandbox/react-markdown-typewriter-rgjf6t>
+
 ## Why?
 
 This library was born during the development of my game engine [pixi-vn](https://www.npmjs.com/package/@drincs/pixi-vn). I needed a component that would display the current dialogue of a character with the "Typewriter" effect and I also wanted to give the developer the possibility to use Markdown to add style to the text.
@@ -23,7 +25,7 @@ The component accepts all the props of the `react-markdown` component and adds s
 This is a very simple example of how to use the component:
 
 ```tsx
-import MarkdownTypewriter from "../components/Typewriter";
+import { MarkdownTypewriter } from "react-markdown-typewriter";
 
 export default function NarrationScreen() {
     return (
@@ -40,25 +42,34 @@ This is a more complex example:
 import { useRef } from "react";
 import rehypeRaw from "rehype-raw";
 import remarkGfm from "remark-gfm";
-import MarkdownTypewriter from "../components/Typewriter";
+import { MarkdownTypewriter } from "react-markdown-typewriter";
 
 export default function NarrationScreen() {
     const paragraphRef = useRef<HTMLDivElement>(null);
+    const scrollToEnd = useCallback((ref: { current: HTMLSpanElement | null }) => {
+        if (paragraphRef.current && ref.current) {
+            let scrollTop = ref.current.offsetTop - paragraphRef.current.clientHeight / 2;
+            paragraphRef.current.scrollTo({
+                top: scrollTop,
+                behavior: "auto",
+            });
+        }
+    }, []);
     return (
         <div ref={paragraphRef}>
             <MarkdownTypewriter
                 remarkPlugins={[remarkGfm]}
                 rehypePlugins={[rehypeRaw]}
                 delay={20}
-                scrollRef={paragraphRef}
                 motionProps={{
                     onAnimationComplete: () => {
                         console.log("Typewriter finished");
                     },
-                    letterVariants: {
+                    characterVariants: {
                         hidden: { opacity: 0 },
                         visible: { opacity: 1, transition: { opacity: { duration: 0 } } },
                     },
+                    onCharacterAnimationComplete: scrollToEnd,
                 }}
             >
                 Hello World
@@ -75,7 +86,7 @@ export default function NarrationScreen() {
 In addition to the `react-markdown` component props, the component accepts the following props:
 
 * `delay`: The delay in milliseconds between the appearance of one letter and the next. Default: `10`. (Optional)
-* `scrollRef`: The reference to the element that will be scrolled when the text exceeds the height of the container. (Optional)
 * `motionProps` (Optional):
   * The props to pass to the [motion span](https://motion.dev/docs/react-motion-component).
-  * `letterVariants`: The motion variants for each individual letter. Default: `{ hidden: { opacity: 0 }, visible: { opacity: 1, transition: { opacity: { duration: 0 } } } }` (Optional).
+  * `characterVariants`: The motion variants for each individual letter. Default: `{ hidden: { opacity: 0 }, visible: { opacity: 1, transition: { opacity: { duration: 0 } } } }` (Optional).
+  * `onCharacterAnimationComplete`: A callback that is called when the animation of a letter is complete. The callback is called with the reference to the letter. (Optional)