MCPcopy
hub / github.com/alexmacarthur/typeit

github.com/alexmacarthur/typeit @v8.8.7 sqlite

repository ↗ · DeepWiki ↗ · release v8.8.7 ↗
104 symbols 307 edges 85 files 7 documented · 7%
README

TypeIt

The Most Versatile JavaScript Animated Typing Utility on the Planet

Bundle Size npm downloads Tweet

<img src="https://github.com/alexmacarthur/typeit/raw/v8.8.7/readme-demo.gif" alt="" style="border: 5px solid #24292e;">

Overview

TypeIt is the most versatile JavaScript typewriter effect utility on the planet. With its simple yet flexible configuration, you're empowerd to type single or multiple strings that break lines, delete & replace each other, easily handle string containing HTML, loop, and a whole lot more.

For more advanced, controlled typing effects, TypeIt comes with companion functions that can be chained to control your typing down to a single character or millisecond, enabling you to type an dynamic narrative, with complete reign over speed changes, line breaks, deletions, and pauses.

Key Features

  • Offers a beautiful, fluent API for chaining commands in order to fine-tune an effect.
  • Choose to start typing only when your target element becomes visible on the screen.
  • Loop your string(s) continuously.
  • Define strings programmatically or directly in the HTML (a useful fallback in case user doesn't have JavaScript enabled, as well as for SEO).
  • Handle HTML (even nested tags!) with ease, preserving all of its attributes (classes, ids, etc.).
  • Offered as an ES module for modern bundlers, or a UMD library for loading via a traditional <script> tags.

License Options

Using TypeIt for an open source or personal project is completely free is licensed under GPLv3. To use it in a commercial project, however, a paid license is required. Learn more about them here:

Demos

See some more examples and try out the sandbox at https://typeitjs.com.

Documentation

All of TypeIt's documentation can be found at https://typeitjs.com/docs.

Included Packages

  • typeit - The original, vanilla JavaScript library.
  • typeit-react - A simple React package wrapping the vanilla library.

Contribute

Please do! Check out the CONTRIBUTING.md file to see how to get started.

Know of a Neat Site Using TypeIt?

I'd love to see and share it! Send me a message or tweet at me.

Need Help?

If you're working with a custom implementation of TypeIt and would like some help, I'm available for hire. Get in touch!

Extension points exported contracts — how you extend this code

QueueI (Interface)
(no doc)
packages/typeit/src/Queue.ts
TypeItProps (Interface)
(no doc)
packages/typeit-react/src/index.tsx
CursorAnimationOptions (Interface)
(no doc)
packages/typeit/src/types.ts
CursorOptions (Interface)
(no doc)
packages/typeit/src/types.ts
Options (Interface)
(no doc)
packages/typeit/src/types.ts
Statuses (Interface)
(no doc)
packages/typeit/src/types.ts

Core symbols most depended-on inside this repo

go
called by 64
packages/typeit/src/TypeIt.ts
type
called by 64
packages/typeit/src/TypeIt.ts
getQueue
called by 38
packages/typeit/src/TypeIt.ts
move
called by 33
packages/typeit/src/TypeIt.ts
delete
called by 27
packages/typeit/src/TypeIt.ts
done
called by 23
packages/typeit/src/Queue.ts
pause
called by 14
packages/typeit/src/TypeIt.ts
expandTextNodes
called by 14
packages/typeit/src/helpers/expandTextNodes.ts

Shape

Function 50
Method 43
Interface 9
Class 2

Languages

TypeScript100%

Modules by API surface

packages/typeit/src/TypeIt.ts45 symbols
packages/typeit/src/Queue.ts14 symbols
packages/typeit/src/types.ts4 symbols
packages/typeit/src/helpers/fireItem.ts4 symbols
packages/typeit-react/src/index.tsx4 symbols
packages/typeit/src/helpers/chunkStrings.ts3 symbols
packages/typeit/src/helpers/wait.ts2 symbols
packages/typeit/src/helpers/rebuildCursorAnimation.ts2 symbols
packages/typeit/src/helpers/countStepsToSelector.ts2 symbols
packages/typeit/__tests__/setup.js2 symbols
packages/typeit-react/examples/app.tsx2 symbols
packages/typeit/src/helpers/updateCursorPosition.ts1 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

Dependencies from manifests, versioned

@babel/preset-typescript7.25.9 · 1×
@testing-library/jest-dom6.6.2 · 1×
@testing-library/react16.0.1 · 1×
@types/react18.3.12 · 1×
husky9.1.1 · 1×
jsdom25.0.1 · 1×
lerna8.1.6 · 1×
lint-staged15.2.7 · 1×
prettier3.3.3 · 1×
react>=18.3.1 · 1×
react-dom>=18.3.1 · 1×

For agents

$ claude mcp add typeit \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact