@gfazioli/mantine-text-animate 2.3.9 → 2.3.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CODE_OF_CONDUCT.md +1 -1
- package/README.md +31 -15
- package/package.json +1 -1
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -60,7 +60,7 @@ representative at an online or offline event.
|
|
|
60
60
|
|
|
61
61
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
62
|
reported to the community leaders responsible for enforcement at
|
|
63
|
-
|
|
63
|
+
giovambattista.fazioli@gmail.com.
|
|
64
64
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
65
|
|
|
66
66
|
All community leaders are obligated to respect the privacy and security of the
|
package/README.md
CHANGED
|
@@ -9,28 +9,25 @@
|
|
|
9
9
|
[](https://www.npmjs.com/package/@gfazioli/mantine-text-animate)
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)
|
|
15
|
+
|
|
12
16
|
</div>
|
|
13
17
|
|
|
14
18
|
## Overview
|
|
15
19
|
|
|
16
20
|
This component is created on top of the [Mantine](https://mantine.dev/) library.
|
|
17
21
|
|
|
18
|
-
[
|
|
19
|
-
)](https://mantine.dev/)
|
|
20
|
-
|
|
21
|
-
The `TextAnimate` component allows you to animate text with various effects.
|
|
22
|
-
Additionally, it provides other sub components such as `TextAnimate.TextTicker`, `TextAnimate.Typewriter`, `TextAnimate.NumberTicker`, and `TextAnimate.Spinner`.
|
|
23
|
-
You can also use three useful hooks: `useTextTicker`, `useTypewriter`, and `useNumberTicker`.
|
|
22
|
+
[Mantine TextAnimate](https://gfazioli.github.io/mantine-text-animate/) is a comprehensive animation toolkit for text in React, designed to integrate seamlessly with Mantine UI. At its core, the TextAnimate component lets you choose entry/exit/static states and apply animations such as slide, scale, and blur, while controlling granularity with the by prop (character, word, line) and timing through duration, delay, and segmentDelay. Fine‑tuning is enabled via animateProps—translateDistance, scaleAmount, and blurAmount—so you can tailor motion intensity per effect. Event handlers like onAnimationStart and onAnimationEnd make it straightforward to react to animation lifecycles.
|
|
24
23
|
|
|
25
|
-
|
|
26
|
-
)](https://www.youtube.com/playlist?list=PL85tTROKkZrWyqCcmNCdWajpx05-cTal4)
|
|
27
|
-
[](https://gfazioli.github.io/mantine-text-animate/)
|
|
29
|
-
[](https://mantine-extensions.vercel.app/)
|
|
24
|
+
Beyond basic text transitions, the package offers higher‑level primitives for common patterns: TextAnimate.Typewriter and the useTypewriter hook provide cursor and blink options, speed/delay controls, loop behavior, multiline rendering, and hooks to start/stop/reset typing, plus onTypeEnd and onTypeLoop callbacks.
|
|
31
25
|
|
|
32
|
-
|
|
26
|
+
For data presentations, useNumberTicker animates numeric values with speed, easing, and completion callbacks, while useTextTicker reveals target strings from random characters with configurable character sets, reveal direction, and lifecycle control. Styling is fully compatible with Mantine props, and global styles can be imported directly or within a CSS layer, making the system flexible for documentation sites, dashboards, and rich UI interactions.
|
|
33
27
|
|
|
28
|
+
> [!note]
|
|
29
|
+
>
|
|
30
|
+
> → [Demo and Documentation](https://gfazioli.github.io/mantine-text-animate/) → [Youtube Video](https://www.youtube.com/playlist?list=PL85tTROKkZrWyqCcmNCdWajpx05-cTal4) → [More Mantine Components](https://mantine-extensions.vercel.app/)
|
|
34
31
|
|
|
35
32
|
## Installation
|
|
36
33
|
|
|
@@ -184,11 +181,30 @@ function Demo() {
|
|
|
184
181
|
);
|
|
185
182
|
}
|
|
186
183
|
```
|
|
184
|
+
## Sponsor
|
|
187
185
|
|
|
188
186
|
<div align="center">
|
|
189
|
-
|
|
190
|
-
[
|
|
187
|
+
|
|
188
|
+
[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)
|
|
191
189
|
|
|
192
190
|
</div>
|
|
193
191
|
|
|
192
|
+
Your support helps me:
|
|
193
|
+
|
|
194
|
+
- Keep the project actively maintained with timely bug fixes and security updates
|
|
195
|
+
- Add new features, improve performance, and refine the developer experience
|
|
196
|
+
- Expand test coverage and documentation for smoother adoption
|
|
197
|
+
- Ensure long‑term sustainability without relying on ad hoc free time
|
|
198
|
+
- Prioritize community requests and roadmap items that matter most
|
|
199
|
+
|
|
200
|
+
Open source thrives when those who benefit can give back—even a small monthly contribution makes a real difference. Sponsorships help cover maintenance time, infrastructure, and the countless invisible tasks that keep a project healthy.
|
|
201
|
+
|
|
202
|
+
Your help truly matters.
|
|
203
|
+
|
|
204
|
+
💚 [Become a sponsor](https://github.com/sponsors/gfazioli?o=esc) today and help me keep this project reliable, up‑to‑date, and growing for everyone.
|
|
205
|
+
|
|
206
|
+
---
|
|
194
207
|
https://github.com/user-attachments/assets/8bbeb7ef-9e1f-46ab-a105-cdd1e0040780
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
[](https://www.star-history.com/#gfazioli/mantine-text-animate&Timeline)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gfazioli/mantine-text-animate",
|
|
3
|
-
"version": "2.3.
|
|
3
|
+
"version": "2.3.10",
|
|
4
4
|
"description": "The TextAnimate component allows you to animate text with various effects.",
|
|
5
5
|
"homepage": "https://gfazioli.github.io/mantine-text-animate/",
|
|
6
6
|
"packageManager": "yarn@4.0.1",
|