Add JS Doc

WordPress · Jan 1, 2025 · 4561b70 · 4561b70
1 parent 53f3721
commit 4561b70
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/packages/block-editor/src/components/typewriter/index.js b/packages/block-editor/src/components/typewriter/index.js
@@ -260,6 +260,25 @@ export function useTypewriter() {
 	);
 }
 
+/**
+ * Typewriter component displays its children with a typewriter effect.
+ *
+ * @example
+ * ```jsx
+ * function Example(){
+ *   return (
+ *     <Typewriter>
+ *       Hello World
+ *     </Typewriter>
+ *   );
+ * }
+ * ```
+ *
+ * @param {Object}               props
+ * @param {JSX.Element | string} props.children The children to display with a typewriter effect.
+ *
+ * @return {JSX.Element} The rendered Typewriter component.
+ */
 function Typewriter( { children } ) {
 	return (
 		<div ref={ useTypewriter() } className="block-editor__typewriter">