=== Type-WR  ===
Contributors: petrolytvyn
Requires at least: 5.0
Requires PHP: 7.4
Tested up to: 6.9
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Donate link: https://www.buymeacoffee.com/lytvynpetro
Tags: typewriter, typing, animation, text, letter
        
**A plugin that adds a simple, customizable typewriter (typing) animation effect to any HTML element on your WordPress site.**

== Description ==

Type-WR allows you to easily implement the popular "typing text" animation effect without writing a single line of JavaScript.

Simply wrap the target text in a shortcode or use a specific CSS class, and the plugin will sequentially display the text character by character, simulating a traditional typewriter.

**Key Features:**

* **Easy Integration:** Use the [typewr] shortcode or apply the class 'typewr-type'.
* **Customization:** Control typing speed, the presence of a blinking cursor, and the conditions for when to show the animation.
* **Lightweight:** Minimal JavaScript footprint (typewr-script.js) ensuring fast page load times.
* **Compatibility:** Works seamlessly with the Block Editor (Gutenberg) and Classic Editor.

== Installation ==

### Manual Installation

1.  Upload the 'type-wr' folder to the '/wp-content/plugins/' directory.
2.  Activate the plugin through the 'Plugins' menu in WordPress.

### Usage

**1. Using the Shortcode:**

Wrap your content with the shortcode:

    [typewr]This text will be typed out letter by letter.[/typewr]

There may be nested tags inside. They will be printed one by one.
 
    [typewr]
        <h1>This title will be printed.</h1>
        <p>And this paragraph too.</p>
    [/typewr] 
   

**2. Using a CSS Class :**

If you use code add the class 'typewr-type' to any HTML element (eg  div, h1, h2, h3, pre, p ) on your page or post.

    <div class ='typewr-type'>
        <h1>This title will be printed letter by letter.</h1>
        <p>This text will be typed out letter by letter.</p>
    </div>

You can create animation directly in the text

    This word will be <span class='typewr-type'>animated</span>.

### Setting

You can change the settings in the "Settings" menu: select "Type-WR".


**Available Setting Attributes:**

* speed : Time in milliseconds between each character (default: 50).
* cursor : Checkbox - show blinking cursor or not  (default: true).  
* trigger : When to start animation select "When loading the page" or "When an element appears on the screen"  (default: 'load')".


== Frequently Asked Questions ==

= How do I change the speed of the typing or the presence of a blinking cursor? =

You can adjust the speed or showing the cursor in the plugin settings page (Settings -> Type-WR).

= Does it work with special characters? =

Yes, the script handles standard and most UTF-8 characters without issues.

== Screenshots ==

1. The settings panel showing customization options for speed, cursor, and triggers.
2. Example of the animated typing effect in action on the website frontend.

== Changelog ==

= 1.0.0 =
* Initial release.
* Added core typing functionality via 'typewr-script.js'.
* Included shortcode [typewr] and CSS class 'typewr-type'.

== Upgrade Notice ==

= 1.0.0 =
This is the first stable release. Please ensure you clear any caching after activation.