rocket-cursor-component 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 +59 -1
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,2 +1,60 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Rocket Cursor Component
|
|
2
|
+
|
|
2
3
|
A customizable React component that replaces the mouse cursor with an animated rocket that rotates based on movement and displays a flame effect when in motion.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install the package via npm:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install rocket-cursor-component
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Here's an example of how to use the `RocketCursor` component in your React app:
|
|
16
|
+
|
|
17
|
+
```jsx
|
|
18
|
+
import React from "react";
|
|
19
|
+
import RocketCursor from "rocket-cursor-component";
|
|
20
|
+
|
|
21
|
+
function App() {
|
|
22
|
+
return (
|
|
23
|
+
<div>
|
|
24
|
+
<h1>Your app content here</h1>
|
|
25
|
+
<RocketCursor size={60} threshold={15} />
|
|
26
|
+
</div>
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export default App;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Props
|
|
34
|
+
|
|
35
|
+
| Prop | Type | Default | Description |
|
|
36
|
+
| ----------- | ------- | ------- | ------------------------------------------ |
|
|
37
|
+
| `size` | number | `50` | The size of the rocket cursor |
|
|
38
|
+
| `threshold` | number | `10` | Distance to move before the rocket rotates |
|
|
39
|
+
| `isVisible` | boolean | `true` | Show or hide the rocket cursor |
|
|
40
|
+
|
|
41
|
+
## Features
|
|
42
|
+
|
|
43
|
+
- **Custom Cursor**: Replaces the default mouse cursor with a rocket that follows the cursor.
|
|
44
|
+
- **Rotation**: The rocket rotates in the direction of the cursor movement.
|
|
45
|
+
- **Flame Effect**: The rocket displays a flame animation when the cursor is moving.
|
|
46
|
+
- **Customizable**: Easily adjust the size, rotation threshold, and visibility of the rocket.
|
|
47
|
+
|
|
48
|
+
## Changelog
|
|
49
|
+
|
|
50
|
+
### 1.0.0
|
|
51
|
+
|
|
52
|
+
- Initial release of the Rocket Cursor component.
|
|
53
|
+
|
|
54
|
+
## Author
|
|
55
|
+
|
|
56
|
+
[No898](https://github.com/No898)
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rocket-cursor-component",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A customizable React component that replaces the cursor with an animated rocket.",
|
|
5
5
|
"main": "dist/rocket.Cursor.js",
|
|
6
6
|
"types": "dist/rocket.Cursor.d.ts",
|
|
@@ -13,7 +13,10 @@
|
|
|
13
13
|
"react": "^17.0.0"
|
|
14
14
|
},
|
|
15
15
|
"devDependencies": {
|
|
16
|
-
"
|
|
17
|
-
"
|
|
16
|
+
"react": "^17.0.0",
|
|
17
|
+
"typescript": "^4.0.0"
|
|
18
|
+
},
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"rocket-cursor-component": "^1.0.0"
|
|
18
21
|
}
|
|
19
22
|
}
|