Rewrite examples in documentation to TypeScript (#5873)

cspell.json

@@ -21,6 +21,16 @@
     "workletization",
     "workletize",
     "workletized",
+    "barfoo",
+    "devs",
+    "chlgm",
+    "bfrg",
+    "typecheck",
+    "usehooks",
+    "animable",
+    "ispreview",
+    "pressable",
+    "inout",
     "workletizes",
     "worklets"
   ],

docs/docusaurus.config.js

@@ -162,6 +162,9 @@ const config = {
                   test: /\.txt/,
                   type: 'asset/source',
                 },
+                {
+                  test: /\.tsx?$/
+                }
               ],
             },
             resolve: {

docs/package.json

@@ -19,9 +19,7 @@
   "dependencies": {
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-export-namespace-from": "^7.18.9",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/preset-react": "^7.18.6",
-    "@babel/preset-typescript": "^7.21.0",
+    "@babel/preset-env": "^7.24.4",
     "@docusaurus/core": "^2.4.3",
     "@docusaurus/plugin-debug": "^2.4.3",
     "@docusaurus/preset-classic": "^2.4.3",

docs/src/components/InteractiveExample/index.tsx

@@ -15,6 +15,56 @@ import ResetDark from '@site/static/img/reset-dark.svg';
 
 import styles from './styles.module.css';
 
+import ts from 'typescript';
+import prettier from 'prettier/standalone';
+import babelParser from 'prettier/parser-babel';
+
+function compileTSXtoJSX(tsxCode: string) {
+  const PLACEHOLDER_FOR_EMPTY_LINES = '// PLACEHOLDER-FOR-EMPTY-LINES';
+  const PLACEHOLDER_FOR_BREAKING_LINES = '// PLACEHOLDER-FOR-BREAKING-LINES';
+
+  // Adding comments to the end of each line to avoid vanishing empty lines
+  tsxCode = tsxCode
+    .split('\n')
+    .map((line) =>
+      line.trim() === '' ? PLACEHOLDER_FOR_EMPTY_LINES : line + PLACEHOLDER_FOR_BREAKING_LINES
+    )
+    .join('\n');
+  const result = ts.transpileModule(tsxCode, {
+    compilerOptions: {
+      module: ts.ModuleKind.ESNext,
+      jsx: ts.JsxEmit.Preserve,
+      pretty: true,
+      target: ts.ScriptTarget.ES2015,
+      removeComments: false,
+      noEmit: false,
+      indentSize: 2,
+    },
+  });
+
+  const output = result.outputText
+    .split('\n')
+    .map((l) =>
+      l.trim() === PLACEHOLDER_FOR_EMPTY_LINES
+        ? ''
+        : l.trim().endsWith(PLACEHOLDER_FOR_BREAKING_LINES)
+        ? l.slice(0, l.indexOf(PLACEHOLDER_FOR_BREAKING_LINES)).trimEnd()
+        : l
+    )
+    .join('\n');
+
+  return prettier.format(output, {
+    parser: 'babel',
+    bracketSameLine: true,
+    printWidth: 80,
+    singleQuote: true,
+    trailingComma: 'es5',
+    tabWidth: 2,
+    arrowParens: 'always',
+    plugins: [babelParser],
+  });
+}
+
 interface Props {
   src: string;
   component: React.ReactNode;
@@ -23,16 +73,23 @@ interface Props {
   larger?: boolean; // should the view be enlarged?
 }
 
+enum Tab {
+  PREVIEW,
+  TYPESCRIPT,
+  JAVASCRIPT,
+}
+
 export default function InteractiveExample({
-  src,
+  src: tsxCode,
   component,
   label,
   showCode = false,
   larger = false,
 }: Props) {
   const [_, copy] = useCopyToClipboard();
   const [key, setKey] = React.useState(0);
-  const [showPreview, setShowPreview] = React.useState(!showCode);
+  const [tab, setTab] = React.useState<Tab>(Tab.PREVIEW);
+  const [jsxCode, setJsxCode] = React.useState(() => compileTSXtoJSX(tsxCode));
 
   const resetExample = () => {
     setKey(key + 1);
@@ -45,9 +102,11 @@ export default function InteractiveExample({
       {() => (
         <div
           className={`${styles.container} ${larger && styles.largerContainer} 
-          ${!showPreview ? styles.code : ''}`}
-          data-ispreview={showPreview}>
-          {showPreview && prefersReducedMotion && <ReducedMotionWarning />}
+          ${tab !== Tab.PREVIEW ? styles.code : ''}`}
+          data-ispreview={tab === Tab.PREVIEW}>
+          {tab === Tab.PREVIEW && prefersReducedMotion && (
+            <ReducedMotionWarning />
+          )}
           <div
             className={clsx(
               styles.buttonsContainer,
@@ -57,18 +116,26 @@ export default function InteractiveExample({
               <button
                 className={clsx(
                   styles.actionButton,
-                  showPreview ? styles.actionButtonActive : ''
+                  tab === Tab.PREVIEW ? styles.actionButtonActive : ''
                 )}
-                onClick={() => setShowPreview(true)}>
+                onClick={() => setTab(Tab.PREVIEW)}>
                 Preview
               </button>
               <button
                 className={clsx(
                   styles.actionButton,
-                  !showPreview ? styles.actionButtonActive : ''
+                  tab === Tab.TYPESCRIPT ? styles.actionButtonActive : ''
                 )}
-                onClick={() => setShowPreview(false)}>
-                Code
+                onClick={() => setTab(Tab.TYPESCRIPT)}>
+                TS
+              </button>
+              <button
+                className={clsx(
+                  styles.actionButton,
+                  tab === Tab.JAVASCRIPT ? styles.actionButtonActive : ''
+                )}
+                onClick={() => setTab(Tab.JAVASCRIPT)}>
+                JS
               </button>
             </div>
             <AnimableIcon
@@ -77,14 +144,14 @@ export default function InteractiveExample({
               animation={Animation.FADE_IN_OUT}
               onClick={(actionPerformed, setActionPerformed) => {
                 if (!actionPerformed) {
-                  copy(src);
+                  copy(tab === Tab.JAVASCRIPT ? jsxCode : tsxCode);
                   setActionPerformed(true);
                 }
               }}
             />
           </div>
           <div className={styles.previewContainer}>
-            {showPreview ? (
+            {tab === Tab.PREVIEW ? (
               <>
                 <React.Fragment key={key}>{component}</React.Fragment>
 
@@ -108,9 +175,13 @@ export default function InteractiveExample({
                   />
                 </div>
               </>
+            ) : tab === Tab.TYPESCRIPT ? (
+              <div className={styles.interactiveCodeBlock}>
+                <CodeBlock language="tsx">{tsxCode}</CodeBlock>
+              </div>
             ) : (
               <div className={styles.interactiveCodeBlock}>
-                <CodeBlock language="jsx">{src}</CodeBlock>
+                <CodeBlock language="jsx">{jsxCode}</CodeBlock>
               </div>
             )}
           </div>

docs/src/examples/AnimatedPropAdapter.jsx → docs/src/examples/AnimatedPropAdapter.tsx

@@ -26,7 +26,7 @@ const adapter = createAnimatedPropAdapter(
 );
 
 export default function App() {
-  const opacity = useSharedValue(0);
+  const opacity = useSharedValue<number>(0);
 
   React.useEffect(() => {
     opacity.value = withRepeat(withTiming(1), -1, true);

docs/src/examples/AnimatedReactionMeasure.jsx → docs/src/examples/AnimatedReactionMeasure.tsx

@@ -10,8 +10,8 @@ import Animated, {
 } from 'react-native-reanimated';
 
 export default function App() {
-  const animatedRef = useAnimatedRef();
-  const width = useSharedValue(100);
+  const animatedRef = useAnimatedRef<Animated.View>();
+  const width = useSharedValue<number>(100);
   const [text, setText] = React.useState(width.value);
 
   const handlePress = () => {
@@ -25,8 +25,7 @@ export default function App() {
       const measurement = measure(animatedRef);
 
       if (measurement !== null) {
-        const measuredWidth = parseInt(measurement.width, 10);
-        runOnJS(setText)(measuredWidth);
+        runOnJS(setText)(measurement.width);
       }
     }
   );

docs/src/examples/AnimatedRef.jsx → docs/src/examples/AnimatedRef.tsx

@@ -4,7 +4,7 @@ import Animated, { useAnimatedRef } from 'react-native-reanimated';
 
 export default function App() {
   // highlight-next-line
-  const animatedRef = useAnimatedRef();
+  const animatedRef = useAnimatedRef<Animated.View>();
 
   return (
     <View style={styles.container}>

docs/src/examples/AnimatingProps.jsx → docs/src/examples/AnimatingProps.tsx

@@ -10,7 +10,7 @@ import { Svg, Circle } from 'react-native-svg';
 const AnimatedCircle = Animated.createAnimatedComponent(Circle);
 
 export default function App() {
-  const r = useSharedValue(20);
+  const r = useSharedValue<number>(20);
 
   const handlePress = () => {
     r.value += 10;

docs/src/examples/AnimatingStyles.jsx → docs/src/examples/AnimatingStyles.tsx

@@ -7,7 +7,7 @@ import Animated, {
 } from 'react-native-reanimated';
 
 export default function App() {
-  const translateX = useSharedValue(0);
+  const translateX = useSharedValue<number>(0);
 
   const handlePress = () => {
     translateX.value += 50;

docs/src/examples/ApplyingModifiers/Delay.jsx → docs/src/examples/ApplyingModifiers/Delay.tsx

@@ -11,7 +11,7 @@ import { View, Button, StyleSheet } from 'react-native';
 import React from 'react';
 
 export default function App() {
-  const offset = useSharedValue(0);
+  const offset = useSharedValue<number>(0);
 
   const style = useAnimatedStyle(() => ({
     transform: [{ translateX: offset.value }],

docs/src/examples/ApplyingModifiers/Repeat.jsx → docs/src/examples/ApplyingModifiers/Repeat.tsx

@@ -8,7 +8,7 @@ import { View, Button, StyleSheet } from 'react-native';
 import React from 'react';
 
 export default function App() {
-  const offset = useSharedValue(0);
+  const offset = useSharedValue<number>(0);
 
   const style = useAnimatedStyle(() => ({
     transform: [{ translateX: offset.value }],

docs/src/examples/ApplyingModifiers/Sequence.jsx → docs/src/examples/ApplyingModifiers/Sequence.tsx

@@ -1,7 +1,6 @@
 import Animated, {
   useSharedValue,
   withTiming,
-  Easing,
   useAnimatedStyle,
   withRepeat,
   withSequence,
@@ -10,7 +9,7 @@ import { View, Button, StyleSheet } from 'react-native';
 import React from 'react';
 
 export default function App() {
-  const offset = useSharedValue(0);
+  const offset = useSharedValue<number>(0);
 
   const style = useAnimatedStyle(() => ({
     transform: [{ translateX: offset.value }],

docs/src/examples/ApplyingModifiers/Timing.jsx → docs/src/examples/ApplyingModifiers/Timing.tsx

@@ -7,7 +7,7 @@ import { View, Button, StyleSheet } from 'react-native';
 import React from 'react';
 
 export default function App() {
-  const offset = useSharedValue(0);
+  const offset = useSharedValue<number>(0);
 
   // highlight-start
   const style = useAnimatedStyle(() => ({

docs/src/examples/CancelAnimation.jsx → docs/src/examples/CancelAnimation.tsx

@@ -11,7 +11,7 @@ import Animated, {
 const OFFSET = 200;
 
 export default function App() {
-  const offset = useSharedValue(OFFSET);
+  const offset = useSharedValue<number>(OFFSET);
 
   const animatedStyles = useAnimatedStyle(() => ({
     transform: [{ translateX: offset.value }],

docs/src/examples/Clamp.jsx → docs/src/examples/Clamp.tsx

@@ -9,12 +9,13 @@ import {
   Gesture,
   GestureDetector,
   GestureHandlerRootView,
+  PanGesture,
 } from 'react-native-gesture-handler';
 
 export default function App() {
-  const offset = useSharedValue(0);
+  const offset = useSharedValue<number>(0);
 
-  const pan = Gesture.Pan().onChange((event) => {
+  const pan: PanGesture = Gesture.Pan().onChange((event) => {
     // highlight-next-line
     offset.value += clamp(event.changeX, -5, 5);
   });