slot-text

Dependency-free text roll animation for tiny, tactile UI labels.

📦 Install

Choose your preferred package manager:

npm

npm install slot-text

pnpm

pnpm add slot-text

Bun

bun add slot-text

Yarn

yarn add slot-text

🚀 Quick start

import "slot-text/style.css";
import { slotText, chromatic } from "slot-text";

const label = slotText(document.querySelector("#copy")!, "Copy");

// the classic Copy → Copied → Copy, in one call
label.flash("Copied", { enter: { color: chromatic() } });

That's it — import the CSS once, attach to an element, roll text.

🧪 Try it locally

The included playground has one button that flashes Copy → Copied → Copy.

npm run build
python3 -m http.server

Open http://localhost:8000/examples/basic/.

🧩 API

const label = slotText(element, "Copy", options);

label.set("Copied");                  // permanent change
label.set("Copy", { direction: "down" });
label.set("Changes saved", {
  rollBy: "word",
  duration: 180,
  stagger: 25,
});                                   // faster, word-by-word roll
label.flash("Copied");                // temporary — rolls back after 1.4s
label.destroy();

💡 flash is spam-safe — repeat clicks restart the revert timer instead of queuing extra rolls, and an explicit set() cancels any pending revert.

label.flash("Copied", {
  revertAfter: 1400,                              // ms before rolling back
  enter: { direction: "up", color: chromatic() }, // roll-in
  exit: { direction: "down" },                    // roll-back
});

⚛️ React

import "slot-text/style.css";
import { SlotText } from "slot-text/react";
import { chromatic } from "slot-text";

<SlotText
  text={copied ? "Copied" : "Copy"}
  options={{ direction: copied ? "up" : "down", color: copied ? chromatic() : undefined }}
/>

💚 Vue

<script setup lang="ts">
import "slot-text/style.css";
import { SlotText } from "slot-text/vue";
</script>

<template>
  <SlotText text="Copied" :options="{ direction: 'up' }" />
</template>

🔷 Solid

import "slot-text/style.css";
import { createSignal } from "solid-js";
import { slotText } from "slot-text/solid";

const [label, setLabel] = createSignal("Copy");

<button aria-label={label()} onClick={() => setLabel("Copied")}>
  <span use:slotText={{ text: label(), options: { direction: "up" } }} />
</button>

🧡 Svelte

<script lang="ts">
  import "slot-text/style.css";
  import { slotText } from "slot-text/svelte";

  let label = "Copy";
</script>

<button aria-label={label} on:click={() => label = "Copied"}>
  <span use:slotText={{ text: label, options: { direction: "up" } }}></span>
</button>

⚙️ Options

🛑 interrupt

• interrupt: true (default) — cuts off any roll in flight, starts fresh.
• interrupt: false — lets the current roll finish; the latest call plays after it lands, duplicates are dropped. Ideal for spam-prone buttons.

🌈 chromatic()

Built-in rainbow color helper — pass it as color for a per-segment hue sweep.

🔤 Font support

By default, each user-perceived character animates in its own measured cell. Set rollBy: "word" to keep each word together and roll it as one unit.

✅ Great with: monospace fonts, proportional Latin / Cyrillic / Greek (Geist, Inter, SF, …), italics, glyphs with overhang.

⚠️ Character mode tradeoffs:

• Kerning is lost — pairs like AV sit slightly looser (invisible at label sizes).
• Ligatures won't form (fi, fl, coding ligatures).
• Joined scripts (Arabic, Devanagari) render as isolated forms.
• Grapheme clusters such as combining marks and ZWJ emoji stay together when Intl.Segmenter is available; older browsers fall back to Unicode code points.
• Very tall display fonts may clip at the roll mask (line-height: 1.3).

Word mode preserves kerning, ligatures and joined-script shaping inside each word, but the whole word rolls together.

In short: ideal for short labels, numbers, statuses and commands — in essentially any font you'd use for those.

📝 Notes

• Browser-only DOM utility, zero runtime dependencies.
• React, Vue, Solid, and Svelte are optional peer dependencies — plain JS users don't need them.
• Import the CSS once before using the animation.
• If the stylesheet loads late, labels stay as plain readable text and upgrade to slot animation once the required layout styles become available.
• Low-level helpers also exported: buildSlotText, animateSlotText, chromatic.