bongocat-react 1.0.0 → 1.1.0
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 +32 -1
- package/assets/bongocat.gif +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
A React component that adds an animated BongoCat overlay to your app. The cat reacts to keyboard typing and mouse clicks in real-time.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
<p align="center">
|
|
6
|
+
<img src="assets/bongocat.gif" alt="BongoCat demo" width="300" />
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
Built using [BongoCat-mac](https://github.com/Gamma-Software/BongoCat-mac) as reference (MIT licensed).
|
|
6
10
|
|
|
7
11
|
## Install
|
|
8
12
|
|
|
@@ -48,6 +52,33 @@ function App() {
|
|
|
48
52
|
| `className` | `string` | `""` | Additional CSS class |
|
|
49
53
|
| `style` | `CSSProperties` | — | Additional inline styles |
|
|
50
54
|
|
|
55
|
+
## Positioning
|
|
56
|
+
|
|
57
|
+
By default, the cat sits in the **bottom-right corner**. Use `bottom`, `right`, and `style` to place it wherever you want:
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
{/* Bottom-right (default) */}
|
|
61
|
+
<BongoCat />
|
|
62
|
+
|
|
63
|
+
{/* Bottom-left */}
|
|
64
|
+
<BongoCat right="auto" style={{ left: 16 }} />
|
|
65
|
+
|
|
66
|
+
{/* Top-right */}
|
|
67
|
+
<BongoCat bottom="auto" style={{ top: 16 }} />
|
|
68
|
+
|
|
69
|
+
{/* Top-left */}
|
|
70
|
+
<BongoCat bottom="auto" right="auto" style={{ top: 16, left: 16 }} />
|
|
71
|
+
|
|
72
|
+
{/* Centered at bottom */}
|
|
73
|
+
<BongoCat right="auto" style={{ left: "50%", transform: "translateX(-50%)" }} />
|
|
74
|
+
|
|
75
|
+
{/* Custom offset */}
|
|
76
|
+
<BongoCat bottom={40} right={40} />
|
|
77
|
+
|
|
78
|
+
{/* Bigger cat */}
|
|
79
|
+
<BongoCat width={130} height={80} />
|
|
80
|
+
```
|
|
81
|
+
|
|
51
82
|
## Privacy
|
|
52
83
|
|
|
53
84
|
This package does not track, collect, or transmit any data. No analytics, no telemetry, no cookies. It's intentionally kept simple — just a lil kitty reacting to your keystrokes and clicks, entirely client-side.
|
|
Binary file
|
package/package.json
CHANGED