Skip to content

Commit de4d689

Browse files
SkyZeroZxSkyZeroZx
committed
chore: Update README
1 parent 467a748 commit de4d689

1 file changed

Lines changed: 26 additions & 28 deletions

File tree

‎libs/ngx-typed-writer/README.md‎

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
11
# NgxTypedWriter | Angular
22

3-
Angular component for typing text animation . Angular SSR and Universal ( previous Angular 16 ) Friendly.
4-
5-
Zoneless compatibility ( developer preview )
3+
Angular SSR-friendly typing text animation component with zoneless compatibility.
64

75
Based in [Typed.JS](https://github.com/mattboldt/typed.js)
86

9-
Rewriter native for Angular
7+
Rewritten natively for Angular
108

119
# DEMO
1210

1311
See a [live demo](https://skyzerozx.github.io/ngx-typed-writer)
1412

15-
1613
## Versions
1714

1815
Latest version available for each version of Angular
1916

2017
| ngx-typed-writer | Angular |
21-
| ---------------------- | ----------- |
22-
| 1.0.0 - 1.2.0 | 16.xx 17.xx |
23-
| 1.3.0 | 17.x 18.xx |
24-
| 1.4.0 | 18.x 19.xx |
25-
| 1.5.0 | 19.x 20.xx |
18+
| ---------------- | ----------- |
19+
| 1.0.0 - 1.2.0 | 16.xx 17.xx |
20+
| 1.3.0 | 17.x 18.xx |
21+
| 1.4.0 | 18.x 19.xx |
22+
| 1.5.0 | 19.x 20.xx |
23+
| 1.6.0 | 20.x 21.xx |
2624

2725
## Basic Usage
2826

@@ -83,7 +81,7 @@ In the following example emable `smartBackspace`, this would only backspace the
8381

8482
```bash
8583
npm install ngx-typed-writer
86-
```
84+
```
8785

8886
## Import Standalone
8987

@@ -120,26 +118,26 @@ export class AppModule { }
120118

121119
# Inputs
122120

123-
| Input | Type | Description |
124-
|----------------|------------|-----------------------------------------------------------------------------|
125-
| strings | `string[]` | An array of strings to be typed. |
126-
| typeSpeed | `number` | The speed at which the strings are typed, in milliseconds. |
127-
| startDelay | `number` | The delay before the first string is typed, in milliseconds. |
128-
| backSpeed | `number` | The speed at which the strings are back-spaced, in milliseconds. |
129-
| smartBackspace | `boolean` | When use smart backspace, which means that the typing will stop <br> when the next string starts with the same characters as the current string. |
130-
| shuffle | `boolean` | Whether to shuffle the strings before typing them. |
131-
| backDelay | `number` | The delay before the back-spacing starts, in milliseconds. |
132-
| isHTML | `boolean` | Whether the strings contain HTML. |
133-
| fadeOut | `boolean` | Whether the component should fade out after each string is typed. |
134-
| loop | `boolean` | When you activate the loop, the list of strings loops infinitely with the typing animation. |
135-
| showCursor | `boolean` | Whether to show a cursor while the component is typing. |
136-
| cursorChar | `string` | The character to use for the cursor. |
137-
| fadeOutDelay | `number` | The delay before the component starts to fade out, in milliseconds. |
121+
| Input | Type | Description |
122+
| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
123+
| strings | `string[]` | An array of strings to be typed. |
124+
| typeSpeed | `number` | The speed at which the strings are typed, in milliseconds. |
125+
| startDelay | `number` | The delay before the first string is typed, in milliseconds. |
126+
| backSpeed | `number` | The speed at which the strings are back-spaced, in milliseconds. |
127+
| smartBackspace | `boolean` | When use smart backspace, which means that the typing will stop <br> when the next string starts with the same characters as the current string. |
128+
| shuffle | `boolean` | Whether to shuffle the strings before typing them. |
129+
| backDelay | `number` | The delay before the back-spacing starts, in milliseconds. |
130+
| isHTML | `boolean` | Whether the strings contain HTML. |
131+
| fadeOut | `boolean` | Whether the component should fade out after each string is typed. |
132+
| loop | `boolean` | When you activate the loop, the list of strings loops infinitely with the typing animation. |
133+
| showCursor | `boolean` | Whether to show a cursor while the component is typing. |
134+
| cursorChar | `string` | The character to use for the cursor. |
135+
| fadeOutDelay | `number` | The delay before the component starts to fade out, in milliseconds. |
138136

139137
# Outputs
140138

141139
| Output | Description |
142-
|--------------|--------------------------------------------------------------------------------------|
140+
| ------------ | ------------------------------------------------------------------------------------ |
143141
| destroy | Emitted when the component is destroyed. |
144142
| initTyped | Emitted when the first string is typed. |
145-
| completeLoop | Emitted when the last string is typed and the component loops back to the beginning. |
143+
| completeLoop | Emitted when the last string is typed and the component loops back to the beginning. |

0 commit comments

Comments
 (0)