Skip to content

Commit 5ad204c

Browse files
GuiEpiGuiEpi
committed
🎉 first commit
0 parents  commit 5ad204c

39 files changed

+5270
-0
lines changed

‎.gitignore‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

‎.prettierrc.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
semi: true,
3+
singleQuote: true,
4+
tabWidth: 2,
5+
trailingComma: 'all',
6+
printWidth: 120,
7+
};

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025, Guillaume Coussot <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<a href="https://react-dot-cursor.guics.st/">
2+
<img alt="react-dot-cursor - Try it out" src="https://github.com/timolins/react-dot-cursor/raw/main/website/public/header.svg"/>
3+
</a>
4+
5+
<div align="center">
6+
<img src="https://badgen.net/npm/v/react-dot-cursor" alt="NPM Version" />
7+
<img src="https://badgen.net/bundlephobia/minzip/react-dot-cursor" alt="minzipped size"/>
8+
<!-- <img src="https://github.com/GuiEpi/react-dot-cursor/workflows/CI/badge.svg" alt="Build Status" /> -->
9+
</div>
10+
11+
<br />
12+
13+
<div align="center"><strong>An opinionated cursor component for React.</strong></div>
14+
15+
<br />
16+
17+
<div align="center">
18+
<a href="https://react-dot-cursor.guics.st/">Website</a>
19+
<span> · </span>
20+
<a href="https://react-dot-cursor.guics.st/docs">Documentation</a>
21+
</div>
22+
23+
<br />
24+
25+
<div align="center">
26+
<sub>Cooked by <a href="https://github.com/GuiEpi/">Guillaume Coussot</a> 👨‍🍳</sub>
27+
</div>
28+
29+
<br />
30+
31+
## Features
32+
33+
- 🚀 Easy to use
34+
- 🔍 Auto-detects content types
35+
- 🚫 Respects disabled attribute
36+
- 🔠 Scales with text size
37+
- 🎥 Animated with motion
38+
- 🎨 Customizable colors
39+
40+
## Installation
41+
42+
### With pnpm
43+
44+
```sh
45+
pnpm add react-dot-cursor
46+
```
47+
48+
### With NPM
49+
50+
```sh
51+
npm install react-dot-cursor
52+
```
53+
54+
## Getting Started
55+
56+
Add the `Cursor` component to your app.
57+
58+
```tsx
59+
import { Cursor } from 'react-dot-cursor';
60+
61+
const App = () => {
62+
return (
63+
<div>
64+
<Cursor />
65+
</div>
66+
);
67+
};
68+
```
69+
70+
Then remove the default cursor with CSS.
71+
72+
```css
73+
:root {
74+
cursor: none !important;
75+
}
76+
```
77+
78+
## Documentation
79+
80+
Find the full API reference on [official documentation](https://react-dot-cursor.guics.st/docs).

‎package.json‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "react-dot-cursor",
3+
"version": "0.1.0",
4+
"description": "An opinionated cursor component for React.",
5+
"exports": {
6+
".": {
7+
"types": "./dist/index.d.ts",
8+
"import": "./dist/index.mjs",
9+
"require": "./dist/index.js"
10+
}
11+
},
12+
"main": "index.js",
13+
"types": "./dist/index.d.ts",
14+
"files": [
15+
"dist"
16+
],
17+
"scripts": {
18+
"build": "tsup src/index.tsx --format esm,cjs --dts",
19+
"dev": "pnpm --filter website dev",
20+
"format": "prettier --write .",
21+
"test": "echo \"Error: no test specified\" && exit 1"
22+
},
23+
"keywords": [
24+
"react",
25+
"motion",
26+
"cursor",
27+
"custom cursor",
28+
"dot cursor",
29+
"motion cursor"
30+
],
31+
"author": "Guillaume Coussot <[email protected]>",
32+
"license": "MIT",
33+
"homepage": "https://react-dot-cursor.guics.st/",
34+
"repository": {
35+
"type": "git",
36+
"url": "git+https://github.com/GuiEpi/react-dot-cursor.git"
37+
},
38+
"bugs": {
39+
"url": "https://github.com/GuiEpi/react-dot-cursor/issues"
40+
},
41+
"dependencies": {
42+
"motion": "^11.15.0"
43+
},
44+
"peerDependencies": {
45+
"react": "^18.3.1",
46+
"react-dom": "^18.3.1"
47+
},
48+
"devDependencies": {
49+
"@types/react": "^18.3.18",
50+
"@types/react-dom": "^18.3.5",
51+
"prettier": "^3.4.2",
52+
"tsup": "^8.3.5",
53+
"typescript": "~5.6.3"
54+
}
55+
}

0 commit comments

Comments
 (0)