Shimmer Text

<span class="kodza-shimmer">Thinking about your request</span>

<span class="kodza-shimmer kodza-shimmer--hover">Shines when you look</span>

<span class="kodza-shimmer kodza-shimmer--pointer">Follow the light</span>

/* Kodza License: free to use, client work included. Not to resell or redistribute, ported or not: https://kodza.dev/docs/#print-license */
/* Kodza — Shimmer Text
   A band of light that sweeps across the text, the way a busy interface says
   "still working on it". Three behaviours:
     (default)  an endless, quiet sweep
     --hover    one sweep each time the pointer comes in
     --pointer  the light follows the pointer (with the small script)
   It stays readable at every moment, and still for reduced motion.
   Everything is tuned with the --kz-shimmer-* variables. */
.kodza-shimmer {
  --kz-shimmer-base: rgba(10, 10, 10, 0.42);
  --kz-shimmer-light: #0a0a0a;
  --kz-shimmer-width: 18%;
  --kz-shimmer-duration: 2.2s;
  --kz-shimmer-x: 50%;

  display: inline-block;
  color: var(--kz-shimmer-base);
  background-image: linear-gradient(
    100deg,
    var(--kz-shimmer-base) calc(50% - var(--kz-shimmer-width)),
    var(--kz-shimmer-light) 50%,
    var(--kz-shimmer-base) calc(50% + var(--kz-shimmer-width))
  );
  background-size: 300% 100%;
  background-position: 100% 0;
  -webkit-background-clip: text;
  background-clip: text;
  -webkit-text-fill-color: transparent;
  animation: kodza-shimmer-sweep var(--kz-shimmer-duration) linear infinite;
}

@keyframes kodza-shimmer-sweep {
  from { background-position: 100% 0; }
  to { background-position: 0 0; }
}

/* One sweep per visit */
.kodza-shimmer--hover {
  animation: none;
}

.kodza-shimmer--hover:hover {
  animation: kodza-shimmer-sweep calc(var(--kz-shimmer-duration) * 0.55) cubic-bezier(0.45, 0, 0.25, 1) 1;
}

/* The light sits where the pointer is (set by the script), and fades in and out */
.kodza-shimmer--pointer {
  animation: none;
  background-image: radial-gradient(
    circle at var(--kz-shimmer-x) 50%,
    var(--kz-shimmer-light) 0,
    var(--kz-shimmer-base) var(--kz-shimmer-spot, 0px)
  );
  background-size: 100% 100%;
  transition: --kz-shimmer-spot 0.4s ease;
}

.kodza-shimmer--pointer.is-lit {
  --kz-shimmer-spot: 4.5em;
}

@property --kz-shimmer-spot {
  syntax: "<length>";
  inherits: true;
  initial-value: 0px;
}

/* Windows high contrast: plain text */
@media (forced-colors: active) {
  .kodza-shimmer {
    background: none;
    color: CanvasText;
    -webkit-text-fill-color: CanvasText;
  }
}

@media (prefers-reduced-motion: reduce) {
  .kodza-shimmer,
  .kodza-shimmer--hover:hover {
    animation: none;
    background: none;
    -webkit-text-fill-color: var(--kz-shimmer-light);
  }
}

/* Theming example — on a dark background:
.dark-section .kodza-shimmer {
  --kz-shimmer-base: rgba(255, 255, 255, 0.4);
  --kz-shimmer-light: #ffffff;
}
*/

/* kodza-guard af4fd6ccd15b — generated by Kodza, do not edit.
   Theme guard: keeps a site's own CSS (WordPress themes, Bootstrap, CSS resets…) off this
   component. :not(#_) is always true and weighs as much as an id, so these lines win over
   theme rules made of classes and tags. Customise the component through its --kz-* variables. */

/* What the browser gives, on everything the component leaves to it */

.kodza-shimmer:not(#_) {
  box-sizing: revert;
}

// Kodza License: free to use, client work included. Not to resell or redistribute, ported or not: https://kodza.dev/docs/#print-license
// Kodza — Shimmer Text
// Only needed for the --pointer variant: moves the light to the pointer's position.
(() => {
  const SELECTOR = '.kodza-shimmer--pointer';
  // One instance. Everything it starts is tied to `signal`, so kodza:destroy stops it all
  function mount(text, signal) {
    text.addEventListener('pointermove', (event) => {
      const rect = text.getBoundingClientRect();
      text.style.setProperty('--kz-shimmer-x', `${((event.clientX - rect.left) / rect.width) * 100}%`);
    }, { signal });
    text.addEventListener('pointerenter', () => text.classList.add('is-lit'), { signal });
    text.addEventListener('pointerleave', () => text.classList.remove('is-lit'), { signal });
  }

  // Kodza lifecycle, the same in every component: `kodza:init` starts the instances inside
  // event.detail.root (the whole page by default), `kodza:destroy` stops them and puts their
  // markup back. For themes and apps that swap content without a page load.
  const instances = new WeakMap();
  const find = (scope = document) => [scope, ...scope.querySelectorAll(SELECTOR)].filter((el) => el.matches?.(SELECTOR));
  const init = (scope) => find(scope).forEach((root) => {
    if (root.classList.contains('is-ready')) return; // already running, maybe from another copy of this script
    const controller = new AbortController();
    instances.set(root, { controller, html: root.innerHTML, attrs: [...root.attributes].map((a) => [a.name, a.value]) });
    mount(root, controller.signal);
    root.classList.add('is-ready');
  });
  const destroy = (scope) => find(scope).forEach((root) => {
    const instance = instances.get(root);
    if (!instance) return;
    instances.delete(root);
    instance.controller.abort();
    [...root.attributes].forEach((a) => root.removeAttribute(a.name));
    instance.attrs.forEach(([name, value]) => root.setAttribute(name, value));
    root.innerHTML = instance.html;
  });
  document.addEventListener('kodza:init', (event) => init(event.detail?.root));
  document.addEventListener('kodza:destroy', (event) => destroy(event.detail?.root));
  init();
  // Loaded in <head>, the script runs before the markup exists: once more when it is parsed
  if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', () => init(), { once: true });
})();

'use client';
// Kodza — Shimmer Text, for React. From https://kodza.dev/components/text-shimmer/
// Kodza License: free to use, client work included. Not to resell or redistribute, ported or not: https://kodza.dev/docs/#print-license
// Next to this file: text-shimmer.css and text-shimmer.js, the component's CSS and JS from Kodza, as they are.
// Yours to edit: the markup is plain JSX below.
// The script changes this markup once React has rendered it (it adds layers, splits text, moves
// nodes), so React must not patch it afterwards. When a prop changes, the key gives React a fresh
// element: kodza:destroy stops the script on the old one, kodza:init starts it on the new one.
import { useRef, useEffect, type ComponentPropsWithoutRef, type ComponentRef, type CSSProperties } from 'react';
import './text-shimmer.css';

type Variant = "hover" | "pointer";

export type ShimmerTextProps = Omit<ComponentPropsWithoutRef<'span'>, "children" | "variant" | "vars"> & {
  /** Modifier class(es): .kodza-shimmer--hover, .kodza-shimmer--pointer (default: pointer, the one the script runs on; [] for none) */
  variant?: Variant | Variant[];
  /** Settings, as CSS variables on the root */
  vars?: {
    /** default: rgba(10, 10, 10, 0.42) */
    "--kz-shimmer-base"?: string | number;
    /** default: #0a0a0a */
    "--kz-shimmer-light"?: string | number;
    /** default: 18% */
    "--kz-shimmer-width"?: string | number;
    /** default: 2.2s */
    "--kz-shimmer-duration"?: string | number;
  };
  /** The text, plain: the script reads it and rebuilds the markup around it */
  children?: string;
  className?: string;
};

export function ShimmerText({ variant = "pointer", vars, children = "Follow the light", className, style, ...rest }: ShimmerTextProps) {
  const ref = useRef<ComponentRef<'span'>>(null);
  const classes = ["kodza-shimmer", ...([] as string[]).concat(variant ?? []).map((v) => `kodza-shimmer--${v}`), className].filter(Boolean).join(' ');
  // Everything the markup is made of: when it changes, React gets a fresh element (see the top)
  const key = JSON.stringify([classes, vars, children, style, rest]);

  // Starts the script on this element once React has rendered it, stops it when it goes
  useEffect(() => {
    const root = ref.current;
    let live = true;
    // @ts-ignore: a plain script, no types to find
    import('./text-shimmer.js').then(() => {
      if (live) document.dispatchEvent(new CustomEvent('kodza:init', { detail: { root } }));
    });
    return () => {
      live = false;
      document.dispatchEvent(new CustomEvent('kodza:destroy', { detail: { root } }));
    };
  }, [key]);

  return (
    <span key={key} {...rest} className={classes} style={{ ...vars, ...style } as CSSProperties} ref={ref}>{children}</span>
  );
}