{"id":26442151,"url":"https://github.com/guillaume-rygn/ms-cursor","last_synced_at":"2025-08-21T07:39:56.146Z","repository":{"id":65163845,"uuid":"584969271","full_name":"guillaume-rygn/MS-Cursor","owner":"guillaume-rygn","description":"🖱️🐁 Modern and Simple cursor design","archived":false,"fork":false,"pushed_at":"2023-01-07T13:29:52.000Z","size":132,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-27T12:47:49.866Z","etag":null,"topics":["animation","css","cursor","mouse"],"latest_commit_sha":null,"homepage":"https://ms-cursor-demo.vercel.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guillaume-rygn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2023-01-04T01:28:42.000Z","updated_at":"2024-10-25T13:20:29.000Z","dependencies_parsed_at":"2023-01-13T15:44:46.815Z","dependency_job_id":null,"html_url":"https://github.com/guillaume-rygn/MS-Cursor","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/guillaume-rygn/MS-Cursor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaume-rygn%2FMS-Cursor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaume-rygn%2FMS-Cursor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaume-rygn%2FMS-Cursor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaume-rygn%2FMS-Cursor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guillaume-rygn","download_url":"https://codeload.github.com/guillaume-rygn/MS-Cursor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaume-rygn%2FMS-Cursor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267803984,"owners_count":24146527,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animation","css","cursor","mouse"],"created_at":"2025-03-18T10:17:50.887Z","updated_at":"2025-07-30T03:33:19.933Z","avatar_url":"https://github.com/guillaume-rygn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ms-cursor 🖱️🪄\n\n[![GitHub Version](https://img.shields.io/github/v/release/guillaume-rygn/MS-Cursor.svg?style=for-the-badge)](https://github.com/guillaume-rygn/MS-Cursor/releases)\n\n![Demo](./assets/home.gif)\n\n## ***It has never been so easy to have a modern mouse design !***\n\u0026nbsp;\n\n## Demo : https://ms-cursor-demo.vercel.app/\n\u0026nbsp;\n\n## Installation\n\nInstall with npm:\n```shell\nnpm i ms-cursor\n```\n\nor install with yarn: \n\n```shell\nyarn add ms-cursor\n```\n\u0026nbsp;\n## Initialize: \n\nAdd JS script: \n\nwith yarn or npm : \n```HTML\n\u003cscript src='./node_modules/ms-cursor/index.js'\u003e\u003c/script\u003e\n```\n\nwith CDN :\n```HTML\n\u003cscript src='https://cdn.jsdelivr.net/npm/ms-cursor@1.2.0/index.min.js'\u003e\u003c/script\u003e\n```\n\nIn HEAD of index.html file: \n\n```HTML\n\u003clink rel=\"stylesheet\" href=\"./node_modules/ms-cursor/style.css\" /\u003e\n```\n\nOr initialize with CDN in HEAD of index.html file: \n\n```HTML\n\u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/ms-cursor@1.2.0/style.min.css\"/\u003e\n```\n\n\u0026nbsp;\n## How to use it \n\nAfter initialize **MS-Cursor** you can set the cursor. You just need to pass an attribute to the script tag.\n\n**If you do not specify anything, the mouse will take the default values!**\n\n\u0026nbsp;\n### Size\n\nyou can adjust the size of the mouse drag.\n\n```HTML\n\u003c!--Default 30--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    size=\"60\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Pause Animation\n\nWhen the mouse movement stops an animation is triggered. Have this attribute you can disable it.\n\n```HTML\n\u003c!--Default enable--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    pause-animation=\"disable\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Difference\n\nThis inverse effect corresponds to the CSS property:\n```CSS\nmix-blend-mode: difference\n```\n\nThe colors of the mouse animation when hovering over an element.\n\n```HTML\n\u003c!--Default enable--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    difference=\"disable\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Cursor\n\nBy default the cursor remains visible except when the mouse stops. You can completely disable the cursor with this attribute.\n\n```HTML\n\u003c!--Default enable--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    cursor=\"disable\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Color\n\nYou can change the color of mouse effect.\n\n```HTML\n\u003c!--Default white with difference enable and black without difference --\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    color=\"#ffffff\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Circle-Outline\n\nWhen the mouse stops, an animation starts and a border appears. You can disable it with this attribute.\n\n```HTML\n\u003c!--Default enable--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    circle-outline=\"disable\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Color-Outline\n\nWhen the mouse stops, an animation starts and a border appears. You can change the color of the border with this attribute.\n**This attribute not working if you disable pause-animation attribute**\n\n```HTML\n\u003c!--Default same color than color attribute--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    color-outline=\"#ffffff\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n### Gradient\n\nYou can activate a gradient for your mouse. This attribute replaces the color attribute. You just need to pass every color separate by a comma into a string.\n\n```HTML\n\u003c!--Default none--\u003e\n\n\u003cscript\n    src=\"./node_modules/ms-cursor/index.js\"\n\n    gradient=\"#1f005c, #48005f, #680060, #830060, #9c155f, #b22c5e, #c5415d, #d5585c, #e36e5c, #ef865e, #f89d63, #ffb56b\" \n\u003e\u003c/script\u003e\n```\n\u0026nbsp;\n## Founder\n| [Guillaume Reygner](https://twitter.com/guillaume_rygn) |\n| ----------- |\n| MS-Cursor Creator | \n\u0026nbsp;\n## License\n\nMS Cursor is licensed under the [Hippocratic License](LICENSE.md).\n\n\u0026nbsp;\n## Code of conduct\n\nThis project and everyone participating in it is governed by the MS Cursor [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. \n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaume-rygn%2Fms-cursor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguillaume-rygn%2Fms-cursor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaume-rygn%2Fms-cursor/lists"}