Skip to content

Repository files navigation

Typing Text

Make your website interactive with typing text animation — a Gutenberg block by WPDeveloper.

WordPress PHP License

About

Typing Text adds an animated typewriter effect to the WordPress block editor. Set a prefix, a rotating list of typed phrases, and a suffix, then control speed, delay, looping, cursor and fade behaviour — all from the block sidebar.

The animation is powered by typed.js on the front end.

Requirements

Minimum Tested up to
WordPress 6.0 7.1
PHP 7.4 8.5

Installation

From the block editor

  1. Open the WordPress block/Gutenberg editor.
  2. Search for "Typing Text".
  3. Install in one click.

Manually

  1. Upload the typing-text folder to /wp-content/plugins/.
  2. Activate the plugin through the Plugins menu.
  3. See the documentation.

Development

This repository uses two git submodules. Clone with them, or the build and the plugin will both be incomplete:

git clone --recurse-submodules git@github.com:EssentialBlocks/typing-text.git
# already cloned?
git submodule update --init --recursive
Submodule Path Purpose
controls controls/ Shared Essential Blocks inspector controls
style-handler lib/style-handler/ Front-end CSS generation

Install dependencies and build:

pnpm install
pnpm run build     # production build
pnpm run start     # watch mode

A note on dist/modules.js

webpack.config.js builds only two entries — dist/index.js (editor) and dist/frontend/index.js (front end) — plus dist/style.css.

It does not build dist/modules.js. That bundle exposes the EBTypingTextControls global that every file in src/ depends on, and it is produced by the central Essential Blocks pipeline from config/entries.js and committed here as a vendored artifact. pnpm run build leaves it untouched, which works only because CleanWebpackPlugin is filtered out of the config. Deleting dist/ will remove it with no way to regenerate it from this repository.

Packaging a release

Zips are produced with wp dist-archive, which honours .distignore:

wp package install wp-cli/dist-archive-command   # once
wp dist-archive . ../typing-text.zip

.distignore uses zip --exclude patterns of the form */<line>. Do not anchor entries with a leading slash — /controls/ becomes *//controls/*, which matches nothing.

Contributing

Issues and pull requests are welcome at EssentialBlocks/typing-text.

Branches:

  • master — stable
  • latest — active release line
  • dev — in-progress work

Contributors

Plus everyone credited in the plugin directory listing: wpdevteam, re_enter_rupok, Asif2BD, rahat89, fencermonir.

Support

License

GPL-3.0-or-later. See the licence text.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

5 watching

Forks

Releases

Packages

Contributors

Languages

Sponsor
SponsoredKunjungi sekarang
Promo