Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moefyit/vuepress-plugin-cursor-effects
:tada: Add a cute click effect to your mouse in your vuepress!
https://github.com/moefyit/vuepress-plugin-cursor-effects
cursor effects plugin vuepress
Last synced: about 2 months ago
JSON representation
:tada: Add a cute click effect to your mouse in your vuepress!
- Host: GitHub
- URL: https://github.com/moefyit/vuepress-plugin-cursor-effects
- Owner: moefyit
- License: mit
- Created: 2019-10-18T16:33:37.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T18:57:24.000Z (7 months ago)
- Last Synced: 2024-07-19T13:48:18.023Z (2 months ago)
- Topics: cursor, effects, plugin, vuepress
- Language: JavaScript
- Homepage: https://moefyit.github.io/moefy-vuepress/
- Size: 41 KB
- Stars: 23
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-web-effect - vuepress-plugin-cursor-effects - Add a cute click effect to your mouse in your vuepress! (🚀 A series of exquisite and compact web page cool effects / Mouse Effect)
- awesome-web-effect - vuepress-plugin-cursor-effects - Add a cute click effect to your mouse in your vuepress! (🚀 A series of exquisite and compact web page cool effects / Mouse Effect)
README
# vuepress-plugin-cursor-effects
:tada: Add a cute click effect to your mouse in your vuepress!
- Document: [moefy-vuepress](https://moefyit.github.io/moefy-vuepress/)
- Live demo: [notev](https://nyakku.moe/)
> Want to use it outside of VuePress1.x? Try [moefy-canvas](https://github.com/moefyit/moefy-canvas)!
## Install
```bash
yarn add vuepress-plugin-cursor-effects -D
# or use npm
npm i vuepress-plugin-cursor-effects -D
```
## Usage
```javascript
module.exports = {
plugins: ['cursor-effects'],
}
```
## Options
```js
module.exports = {
plugins: [
[
'cursor-effects',
{
size: 2, // size of the particle, default: 2
shape: ['star' | 'circle'], // shape of the particle, default: 'star'
zIndex: 999999999, // z-index property of the canvas, default: 999999999
},
],
],
}
```
## Thanks
- [hexo-theme-sagiri](https://github.com/DIYgod/diygod.me/blob/master/themes/sagiri/src/cursor-effects.js)