ngx-astro-shine-border 1.0.0 → 1.0.1
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/README.md +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ngx-astro-shine-border
|
|
2
|
+
|
|
3
|
+
Shine border effect for **Astro**. A zero-runtime port of `@omnedia/ngx-shine-border` to Astro components — no Angular dependency.
|
|
4
|
+
|
|
5
|
+
A shiny animated gradient border that rotates around your content.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- Pure Astro component (`.astro`), no Angular runtime.
|
|
10
|
+
- CSS-based, fully self-contained, no extra dependencies.
|
|
11
|
+
- Instances get unique ids, so you can use several on the same page.
|
|
12
|
+
- Animation pauses when off-screen (`IntersectionObserver`), same as the original.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install ngx-astro-shine-border
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```astro
|
|
23
|
+
---
|
|
24
|
+
import ShineBorder from 'ngx-astro-shine-border';
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
<ShineBorder>
|
|
28
|
+
<h1>Hello world</h1>
|
|
29
|
+
</ShineBorder>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Props
|
|
33
|
+
|
|
34
|
+
| Prop | Default |
|
|
35
|
+
| --------------------- | ------------------------------- |
|
|
36
|
+
| `gradientColorStart` | `'#ffaa40'` |
|
|
37
|
+
| `gradientColorMiddle` | `'#fe8fb5'` |
|
|
38
|
+
| `gradientColorEnd` | `'#9c40ff'` |
|
|
39
|
+
| `borderRadius` | `'0.5rem'` |
|
|
40
|
+
| `borderColor` | `'hsla(0, 0%, 0%, 0)'` |
|
|
41
|
+
| `animationDuration` | `'14s'` |
|
|
42
|
+
|
|
43
|
+
All components accept `class` for additional styling.
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT. Original effect © [Omnedia](https://github.com/omnedia) (MIT).
|