Skip to content

Commit 60594b8

Browse files
committed
docs(docs): 📝 readme, license, changelog
1 parent bc29334 commit 60594b8

File tree

5 files changed

+173
-28
lines changed

5 files changed

+173
-28
lines changed

CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-01-XX
9+
10+
### Added
11+
12+
- Initial release of @iscodex/tailwindcss-animate
13+
- Support for Tailwind CSS v4 with @utility and @theme syntax
14+
- 85+ animation utilities across 11 categories:
15+
- Attention Seekers (16 animations)
16+
- Back Entrances/Exits (8 animations)
17+
- Bouncing Entrances/Exits (10 animations)
18+
- Dashing (4 animations)
19+
- Fading Entrances/Exits (10 animations)
20+
- Flippers (5 animations)
21+
- Rotating Entrances/Exits (10 animations)
22+
- Sliding Entrances/Exits (8 animations)
23+
- Specials (6 animations)
24+
- Zooming Entrances/Exits (10 animations)
25+
- Animation control utilities:
26+
- Duration control with arbitrary values
27+
- Delay control with arbitrary values
28+
- Direction control (normal, reverse, alternate)
29+
- Fill mode control (none, forwards, backwards, both)
30+
- Iteration count control (finite and infinite)
31+
- Play state control (running, paused)
32+
- Timing function control (ease, linear, cubic-bezier)
33+
- Animation composition control (replace, add, accumulate)
34+
- CSS custom properties for global animation theming
35+
- Modular architecture with organized animation categories
36+
37+
[1.0.0]: https://github.com/iscodex/tailwindcss-animate/releases/tag/v1.0.0

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Francisco Luis Rios Vega
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 110 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ Extended animation utilities for Tailwind CSS v4. Modern, lightweight, and fully
44

55
## Features
66

7-
- **Tailwind CSS v4 Native** - Built with `@utility` and `@theme` syntax
7+
- **Tailwind CSS v4** - Built with `@utility` and `@theme` syntax
88
- **Zero Configuration** - Just import and start animating
99
- **Fully Customizable** - Control duration, delay, timing, and more
1010
- **CSS Custom Properties** - Easy theming and dynamic control
1111
- **Modular Architecture** - Import only what you need
12-
- **TypeScript Support** - Complete type definitions included
1312

1413
## Installation
1514

@@ -48,41 +47,135 @@ Start using animations:
4847
- `animate-flash` - Flashing effect
4948
- `animate-head-shake` - Head shake movement
5049
- `animate-heart-beat` - Heart beating effect
51-
- `animate-jello` - Jello wobble effect
50+
- `animate-jelly` - Jello wobble effect
5251
- `animate-rubber-band` - Rubber band stretch
5352
- `animate-shake-x` - Horizontal shake
5453
- `animate-shake-y` - Vertical shake
5554
- `animate-swing` - Pendulum swing
5655
- `animate-tada` - Celebration effect
5756
- `animate-wiggle` - Gentle rotation wiggle
5857
- `animate-wobble` - Side-to-side wobble
58+
- `animate-float` - Floating effect
59+
- `animate-spin` - Continuous rotation
60+
- `animate-ping` - Ping radar effect
61+
- `animate-pulse` - Pulse opacity
62+
- `animate-bounce` - Bouncing effect
5963

60-
### Dashing Animations
64+
### Back Entrances
6165

62-
- `animate-dash-in-left` - Fast slide in from left
63-
- `animate-dash-in-right` - Fast slide in from right
64-
- `animate-dash-out-left` - Fast slide out to left
65-
- `animate-dash-out-right` - Fast slide out to right
66+
- `animate-back-in-down` - Back entrance from top
67+
- `animate-back-in-start` - Back entrance from left
68+
- `animate-back-in-end` - Back entrance from right
69+
- `animate-back-in-up` - Back entrance from bottom
6670

67-
### Bouncing Effects
71+
### Back Exits
72+
73+
- `animate-back-out-down` - Back exit to bottom
74+
- `animate-back-out-start` - Back exit to left
75+
- `animate-back-out-end` - Back exit to right
76+
- `animate-back-out-up` - Back exit to top
77+
78+
### Bouncing Entrances
6879

6980
- `animate-bounce-in` - Bounce entrance
7081
- `animate-bounce-in-down` - Bounce in from top
82+
- `animate-bounce-in-start` - Bounce in from left
83+
- `animate-bounce-in-end` - Bounce in from right
7184
- `animate-bounce-in-up` - Bounce in from bottom
85+
86+
### Bouncing Exits
87+
7288
- `animate-bounce-out` - Bounce exit
89+
- `animate-bounce-out-down` - Bounce out to bottom
90+
- `animate-bounce-out-start` - Bounce out to left
91+
- `animate-bounce-out-end` - Bounce out to right
92+
- `animate-bounce-out-up` - Bounce out to top
93+
94+
### Dashing
95+
96+
- `animate-dash-in-start` - Fast slide in from left
97+
- `animate-dash-in-end` - Fast slide in from right
98+
- `animate-dash-out-start` - Fast slide out to left
99+
- `animate-dash-out-end` - Fast slide out to right
100+
101+
### Fading Entrances
73102

74-
### Rotating Effects
103+
- `animate-fade-in` - Fade entrance
104+
- `animate-fade-in-down` - Fade in from top
105+
- `animate-fade-in-start` - Fade in from left
106+
- `animate-fade-in-end` - Fade in from right
107+
- `animate-fade-in-up` - Fade in from bottom
108+
109+
### Fading Exits
110+
111+
- `animate-fade-out` - Fade exit
112+
- `animate-fade-out-down` - Fade out to bottom
113+
- `animate-fade-out-start` - Fade out to left
114+
- `animate-fade-out-end` - Fade out to right
115+
- `animate-fade-out-up` - Fade out to top
116+
117+
### Flippers
118+
119+
- `animate-flip` - 3D flip effect
120+
- `animate-flip-in-x` - Flip in on X-axis
121+
- `animate-flip-in-y` - Flip in on Y-axis
122+
- `animate-flip-out-x` - Flip out on X-axis
123+
- `animate-flip-out-y` - Flip out on Y-axis
124+
125+
### Rotating Entrances
75126

76127
- `animate-rotate-in` - Rotating entrance
128+
- `animate-rotate-in-down-start` - Rotate in from top-left
129+
- `animate-rotate-in-down-end` - Rotate in from top-right
130+
- `animate-rotate-in-up-start` - Rotate in from bottom-left
131+
- `animate-rotate-in-up-end` - Rotate in from bottom-right
132+
133+
### Rotating Exits
134+
77135
- `animate-rotate-out` - Rotating exit
136+
- `animate-rotate-out-down-start` - Rotate out to bottom-left
137+
- `animate-rotate-out-down-end` - Rotate out to bottom-right
138+
- `animate-rotate-out-up-start` - Rotate out to top-left
139+
- `animate-rotate-out-up-end` - Rotate out to top-right
78140

79-
### Special Effects
141+
### Sliding Entrances
142+
143+
- `animate-slide-in-down` - Slide in from top
144+
- `animate-slide-in-up` - Slide in from bottom
145+
- `animate-slide-in-start` - Slide in from left
146+
- `animate-slide-in-end` - Slide in from right
147+
148+
### Sliding Exits
149+
150+
- `animate-slide-out-down` - Slide out to bottom
151+
- `animate-slide-out-up` - Slide out to top
152+
- `animate-slide-out-start` - Slide out to left
153+
- `animate-slide-out-end` - Slide out to right
154+
155+
### Specials
80156

81157
- `animate-hinge` - Door hinge effect
82158
- `animate-jack-in` - Pop-up like jack-in-the-box
83159
- `animate-jack-out` - Reverse jack-in effect
160+
- `animate-roll-in` - Rolling entrance
161+
- `animate-roll-out` - Rolling exit
162+
- `animate-particle` - Particle effect
163+
164+
### Zooming Entrances
165+
166+
- `animate-zoom-in` - Zoom entrance
167+
- `animate-zoom-in-down` - Zoom in from top
168+
- `animate-zoom-in-up` - Zoom in from bottom
169+
- `animate-zoom-in-start` - Zoom in from left
170+
- `animate-zoom-in-end` - Zoom in from right
171+
172+
### Zooming Exits
84173

85-
_And many more..._
174+
- `animate-zoom-out` - Zoom exit
175+
- `animate-zoom-out-down` - Zoom out to bottom
176+
- `animate-zoom-out-up` - Zoom out to top
177+
- `animate-zoom-out-start` - Zoom out to left
178+
- `animate-zoom-out-end` - Zoom out to right
86179

87180
## Control Utilities
88181

@@ -127,12 +220,6 @@ _And many more..._
127220
<div class="animate-bounce animate-ease-in-out">Smooth bounce</div>
128221
```
129222

130-
### Composition
131-
132-
```html
133-
<div class="animate-bounce animate-wiggle animate-add">Combined animations</div>
134-
```
135-
136223
## CSS Custom Properties
137224

138225
Customize animations globally using CSS custom properties:
@@ -155,7 +242,9 @@ Customize animations globally using CSS custom properties:
155242
### Hover Animations
156243

157244
```html
158-
<button class="hover:animate-wiggle transition-all">Hover to wiggle</button>
245+
<button class="hover:animate-wiggle hover:animate-infinite">
246+
Hover to wiggle
247+
</button>
159248
```
160249

161250
### Responsive Animations
@@ -172,17 +261,13 @@ Customize animations globally using CSS custom properties:
172261
<div class="animate-spin animate-duration-[3.5s]">Custom timing</div>
173262
```
174263

175-
## Contributing
176-
177-
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
178-
179264
## License
180265

181266
MIT License - see [LICENSE](LICENSE.md) file for details.
182267

183268
## Changelog
184269

185-
See [CHANGELOG.md](CHANGELOG.md) for version history.
270+
See [CHANGELOG](CHANGELOG.md) for version history.
186271

187272
## Links
188273

@@ -193,4 +278,4 @@ See [CHANGELOG.md](CHANGELOG.md) for version history.
193278

194279
---
195280

196-
Made with ❤️ by [@iscodex](https://github.com/iscodex)
281+
Made with ❤️ by [@alckordev](https://github.com/alckordev)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"files": [
3131
"/src",
3232
"/README.md",
33-
"/LICENSE"
33+
"/LICENSE.md"
3434
],
3535
"author": "Francisco Luis Rios Vega <[email protected]>",
3636
"license": "MIT",

web/app/routes/configurator.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,11 @@ export default function Configurator() {
102102
))}
103103
</div>
104104
</Sidebar>
105-
<div className="relative">
105+
<div className="relative p-16">
106106
<div className="absolute inset-0 dots-pattern opacity-70" />
107-
Content
107+
<div className="relative z-10">
108+
<div className="animate-bounce md:animate-fade-in lg:animate-none bg-pink-500 w-10 h-10"></div>
109+
</div>
108110
</div>
109111
<Sidebar position="end" className="w-90">
110112
<div className="mb-8 px-6">

0 commit comments

Comments
 (0)