micro-interactions-css
Version:
Easy and Handy CSS npm that delivers micro interactions with just adding classes.
170 lines (103 loc) โข 3.21 kB
Markdown
* * * * *
```
# ๐ฏ micro-interactions-css
A tiny, fast, and plug-and-play CSS utility library for beautiful micro-interactions like hover effects, spins, scaling, movement, and shine animations --- no JavaScript needed.
---
## ๐ฆ Installation
### Via npm
```bash
npm install micro-interactions-css
```
### Import in React/Vite/Next.js
```
import 'micro-interactions-css/dist/micro-interactions.css';
```
### Via CDN
#### ๐ UNPKG
```
<link rel="stylesheet" href="https://unpkg.com/micro-interactions-css/dist/micro-interactions.css" />
```
#### ๐ jsDelivr
```
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/micro-interactions-css/dist/micro-interactions.css" />
```
#### Pin to a specific version
```
<!-- For version 1.0.0 -->
<link rel="stylesheet" href="https://unpkg.com/micro-interactions-css@1.0.0/dist/micro-interactions.css" />
```
* * * * *
๐ Features
-----------
- ๐ `spin` / `spin-reverse`
- ๐ `scale` / `scale-down`
- โฌ
๏ธ โก๏ธ โฌ๏ธ โฌ๏ธ `move-left` / `move-right` / `move-top` / `move-bottom`
- โจ `shine` (a slick shimmer effect on text or buttons)
- โก One class = One effect
- โ๏ธ Lightweight & easy to extend
* * * * *
๐ง Usage
--------
Just add the class to any element, and the animation will kick in.
```
<button class="move-right micro-interaction">Hover Me</button>
<div class="scale micro-interaction">Scale On Hover</div>
<span class="spin">I Spin Forever</span>
<p class="shine">โจ Shiny Text โจ</p>
```
> ๐ก Combine with `.micro-interaction` for smooth transitions.
* * * * *
๐ง Available Classes
--------------------
| Class | Description | Trigger |
| --- | --- | --- |
| `.move-right` | Moves element to the right | `:hover` |
| `.move-left` | Moves element to the left | `:hover` |
| `.move-top` | Moves element upward | `:hover` |
| `.move-bottom` | Moves element downward | `:hover` |
| `.scale` | Scales element up | `:hover` |
| `.scale-down` | Scales element down | `:hover` |
| `.spin` | Infinite spin clockwise | always |
| `.spin-reverse` | Infinite spin counter-clockwise | always |
| `.shine` | Adds shine effect (like shimmer) | `:hover` |
| `.micro-interaction` | Adds smooth transition to elements | optional |
* * * * *
๐จ Example
----------
```
<button class="move-top micro-interaction">Move Top</button>
<span class="spin-reverse">Loading...</span>
```
* * * * *
๐งช Playgrounds
--------------
- โ
Works in all modern browsers
- ๐ ๏ธ No JavaScript required
- ๐ป Perfect for buttons, links, icons, text, etc.
* * * * *
๐ File Structure
-----------------
```
micro-interactions-css/
โโโ dist/
โ โโโ micro-interactions.css
โโโ package.json
โโโ README.md
```
* * * * *
๐ License
----------
MIT --- free to use, modify, and share.
* * * * *
๐ก Pro Tips
-----------
- Use together with TailwindCSS or Bootstrap.
- Add your own custom keyframes or extend the library.
- Respect motion preferences with `prefers-reduced-motion` for accessibility (coming soon).
* * * * *
๐จโ๐ป Author
------------
Made with ๐ by [Your Name]
> โญ Star the repo if you find it helpful!
```
---