Skip to content

Commit

Permalink
[Add] animate on click
Browse files Browse the repository at this point in the history
  • Loading branch information
pedro-isacss committed May 21, 2023
1 parent 621e013 commit f7f40b5
Show file tree
Hide file tree
Showing 6 changed files with 385 additions and 262 deletions.
3 changes: 2 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
test
test
docs
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@
A simple custom cursor that leaves a temporary trail wherever it goes.
</p>

---------------------
---

## Get Started

Import the Mouseee code via CDN and replace {version} with the desired version.

```html
<script src="https://cdn.jsdelivr.net/npm/mouseee@{version}/lib/index.js" type="module"></script>
<script
src="https://cdn.jsdelivr.net/npm/mouseee@{version}/lib/index.js"
type="module"
></script>
```

> See all versions of the Mouse by [clicking here](https://www.npmjs.com/package/mouseee).
Expand All @@ -36,18 +39,20 @@ Import the Mouseee code via CDN and replace {version} with the desired version.

```javascript
const mouseeeConfig = {
color: "#fff", // cursor border color
size: 20, // cursor size
trailColor: "#fff", // trail color
trailTime: 300, // trail duration time
showTrail: true // show trail
}
color: "#fff", // cursor border color
size: 20, // cursor size
trailColor: "#fff", // trail color
trailTime: 300, // trail duration time
showTrail: true, // show trail
clickAnimation: true, // animation on click
};
```

## Licence

Mouseee is [MIT licensed](https://github.com/pedro-isacss/mouseee/blob/master/LICENSE).

## More details

- NPM: https://www.npmjs.com/package/mouseee
- jsDelivr: https://www.jsdelivr.com/package/npm/mouseee
Loading

0 comments on commit f7f40b5

Please sign in to comment.