Skip to content

Production-ready animations, transitions, backgrounds, and scenes for Remotion

2.0 KB
Raw Blame
"use client";

import { useQueryStates } from "nuqs";
import { useEffect, useMemo, useRef } from "react";
import { useTrackEvent } from "@/lib/analytics";
import { type ControlConfig, getDefaults } from "@/lib/customizer-config";
import { buildParsers } from "@/lib/ui-preview-internals";

/**
 * Customizer state shared by the animation and ui previews: URL-synced values
 * (nuqs, one query param per control), reset, and the analytics the docs
 * widgets have always sent. Customize events are debounced per prop so a
 * slider drag reports once, not on every step.
 */
export function useCustomizer(name: string, controls: ControlConfig) {
  const trackEvent = useTrackEvent();
  const { parsers, urlKeys } = useMemo(
    () => buildParsers(name, controls),
    [name, controls],
  );
  const defaults = useMemo(() => getDefaults(controls), [controls]);

  const [values, setValues] = useQueryStates(parsers, {
    urlKeys,
    clearOnDefault: true,
    shallow: true,
  });

  const isDefault = useMemo(
    () => Object.entries(defaults).every(([k, v]) => values[k] === v),
    [defaults, values],
  );

  useEffect(() => {
    trackEvent("docs_component_viewed", { component: name });
  }, [name, trackEvent]);

  const timers = useRef<Map<string, ReturnType<typeof setTimeout>>>(new Map());
  useEffect(() => {
    const pending = timers.current;
    return () => {
      for (const timer of pending.values()) clearTimeout(timer);
      pending.clear();
    };
  }, []);

  const change = (key: string, value: unknown) => {
    setValues((prev) => ({ ...prev, [key]: value }));
    const existing = timers.current.get(key);
    if (existing) clearTimeout(existing);
    timers.current.set(
      key,
      setTimeout(() => {
        trackEvent("component_customized", { component: name, prop: key });
        timers.current.delete(key);
      }, 500),
    );
  };

  const reset = () => {
    setValues(null);
    trackEvent("customizer_reset", { component: name });
  };

  return {
    values: values as Record<string, unknown>,
    isDefault,
    change,
    reset,
  };
}