JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1552
  • Score
    100M100P100Q106831F
  • License MIT

Framework-agnostic animated handwriting renderer with React, Svelte, Vue, Nuxt, SolidJS, Astro, and Web Components adapters

Package Exports

  • tegaki
  • tegaki/astro
  • tegaki/core
  • tegaki/fonts/amiri
  • tegaki/fonts/caveat
  • tegaki/fonts/italianno
  • tegaki/fonts/klee-one
  • tegaki/fonts/parisienne
  • tegaki/fonts/suez-one
  • tegaki/fonts/tangerine
  • tegaki/fonts/tillana
  • tegaki/nuxt
  • tegaki/react
  • tegaki/shaper-harfbuzz
  • tegaki/solid
  • tegaki/svelte
  • tegaki/vue
  • tegaki/wc

Readme

Tegaki

Handwriting animation for any font

Tegaki (手書き) turns any font into animated handwriting. No manual path authoring. No native dependencies. Just pick a font.

npm license


Hello World handwriting animation


Quick Start

1. Install

npm install tegaki

2. Use (React example)

import { TegakiRenderer } from 'tegaki';
import caveat from 'tegaki/fonts/caveat';

function App() {
  return (
    <TegakiRenderer font={caveat} style={{ fontSize: '48px' }}>
      Hello World
    </TegakiRenderer>
  );
}

That's it. The text draws itself stroke by stroke with natural timing.

Framework Support

Tegaki works with all major frameworks:

import { TegakiRenderer } from 'tegaki/react';   // React
import { TegakiRenderer } from 'tegaki/svelte';  // Svelte
import { TegakiRenderer } from 'tegaki/vue';     // Vue
import { TegakiRenderer } from 'tegaki/solid';   // SolidJS
---
import TegakiRenderer from 'tegaki/astro';       // Astro
---
import { TegakiEngine } from 'tegaki/core';      // Vanilla JS
import { registerTegakiElement } from 'tegaki/wc'; // Web Components

Built-in Fonts

Several handwriting fonts are bundled and ready to use:

  • Caveattegaki/fonts/caveat (Latin)
  • Italiannotegaki/fonts/italianno (Latin)
  • Tangerinetegaki/fonts/tangerine (Latin)
  • Parisiennetegaki/fonts/parisienne (Latin)
  • Suez Onetegaki/fonts/suez-one (Hebrew + Latin)
  • Amiritegaki/fonts/amiri (Arabic + Latin)
  • Tillanategaki/fonts/tillana (Devanagari + Latin)
  • Klee Onetegaki/fonts/klee-one (Japanese: kana + Kyōiku grade 1–2 kanji + Latin)

For other fonts, use the interactive generator to create a custom bundle.

Documentation

Visit gkurt.com/tegaki for full documentation:

Integrations

License

MIT