{"id":21396796,"url":"https://github.com/favware/colorette-spinner","last_synced_at":"2025-07-13T19:31:26.456Z","repository":{"id":37016967,"uuid":"500973082","full_name":"favware/colorette-spinner","owner":"favware","description":"A super tiny and efficient terminal spinner based on nanospinner","archived":false,"fork":false,"pushed_at":"2025-07-13T00:44:00.000Z","size":16353,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-13T05:30:42.472Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/favware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["favna"],"patreon":"favna","open_collective":null,"ko_fi":"favna","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://donate.favware.tech/paypal"}},"created_at":"2022-06-07T19:14:34.000Z","updated_at":"2025-07-13T00:44:03.000Z","dependencies_parsed_at":"2023-12-17T02:27:32.217Z","dependency_job_id":"711bfc52-1cc2-4a89-9f84-a1526778c9d4","html_url":"https://github.com/favware/colorette-spinner","commit_stats":{"total_commits":85,"total_committers":4,"mean_commits":21.25,"dds":0.2588235294117647,"last_synced_commit":"0952e3c38cc7be1d7c99a9261705b0056c7cdb2b"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/favware/colorette-spinner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/favware%2Fcolorette-spinner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/favware%2Fcolorette-spinner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/favware%2Fcolorette-spinner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/favware%2Fcolorette-spinner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/favware","download_url":"https://codeload.github.com/favware/colorette-spinner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/favware%2Fcolorette-spinner/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265194880,"owners_count":23725984,"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","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":[],"created_at":"2024-11-22T14:29:17.710Z","updated_at":"2025-07-13T19:31:26.009Z","avatar_url":"https://github.com/favware.png","language":"TypeScript","funding_links":["https://github.com/sponsors/favna","https://patreon.com/favna","https://ko-fi.com/favna","https://donate.favware.tech/paypal","https://github.com/sponsors/Favna"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# colorette-spinner\n\n**A super tiny and efficient terminal spinner based on [nanospinner]**\n\n[![GitHub](https://img.shields.io/github/license/favware/colorette-spinner)](https://github.com/favware/colorette-spinner/blob/main/LICENSE)\n[![npm](https://img.shields.io/npm/v/@favware/colorette-spinner?color=crimson\u0026logo=npm)](https://www.npmjs.com/package/@favware/colorette-spinner)\n\n[![Support Server](https://discord.com/api/guilds/512303595966824458/embed.png?style=banner2)](https://join.favware.tech)\n\n![](./assets/demo.gif)\n\n\u003c/div\u003e\n\n## Description\n\nThis is an extremely tiny and simple terminal spinner based on [nanospinner]\nwhile using [colorette] instead of picocolors\n\n## Installation\n\nYou can use the following command to install this package, or replace\n`npm install -D` with your package manager of choice.\n\n```sh\nnpm install -D @favware/colorette-spinner\n```\n\n## Usage\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .spin()\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nLooping over `spin` method will animate a given spinner.\n\n```js\nsetInterval(() =\u003e {\n  spinner.spin();\n}, 25);\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .start(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nIn order to start the spinner call `start`. This will perform drawing the\nspinning animation\n\n```js\nspinner.start();\nspinner.start({ text: 'Start', color: 'yellow' });\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .stop(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nIn order to stop the spinner call `stop`. This will finish drawing the spinning\nanimation and return to new line.\n\n```js\nspinner.stop();\nspinner.stop({ text: 'Done!', mark: ':O', color: 'magenta' });\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .success(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nUse `success` call to stop the spinning animation and replace the spinning\nsymbol with check mark character to indicate successful completion.\n\n```js\nspinner.success();\nspinner.success({ text: 'Successful!', mark: ':)' });\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .warn(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nUse `warn` call to stop the spinning animation and replace the spinning symbol\nwith warn mark character to indicate warning completion.\n\n```js\nspinner.warn();\nspinner.warn({ text: 'Warning!', mark: ':|' });\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .error(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nUse `error` call to stop the spinning animation and replace the spinning symbol\nwith cross character to indicate error completion.\n\n```js\nspinner.error();\nspinner.error({ text: 'Error!', mark: ':(' });\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .update(options?)\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nUse `update` call to dynamically change\n\n```js\nspinner.update({\n  text: 'Run test',\n  color: 'white',\n  stream: process.stdout,\n  frames: ['.', 'o', '0', '@', '*'],\n  interval: 100\n});\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .clear()\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nClears the spinner`s output\n\n```js\nspinner.clear();\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    \u003cb\u003e\n      \u003ccode\u003e\n        .reset()\n      \u003c/code\u003e\n    \u003c/b\u003e\n  \u003c/summary\u003e\n\nIn order to reset the spinner to its initial frame do:\n\n```js\nspinner.reset();\n```\n\n\u003c/details\u003e\n\n## Buy us some doughnuts\n\nFavware projects are and always will be open source, even if we don't get\ndonations. That being said, we know there are amazing people who may still want\nto donate just to show their appreciation. Thank you very much in advance!\n\nWe accept donations through Ko-fi, Paypal, Patreon, GitHub Sponsorships, and\nvarious cryptocurrencies. You can use the buttons below to donate through your\nmethod of choice.\n\n|   Donate With   |                      Address                      |\n| :-------------: | :-----------------------------------------------: |\n|      Ko-fi      |  [Click Here](https://donate.favware.tech/kofi)   |\n|     Patreon     | [Click Here](https://donate.favware.tech/patreon) |\n|     PayPal      | [Click Here](https://donate.favware.tech/paypal)  |\n| GitHub Sponsors |  [Click Here](https://github.com/sponsors/Favna)  |\n|     Bitcoin     |       `1E643TNif2MTh75rugepmXuq35Tck4TnE5`        |\n|    Ethereum     |   `0xF653F666903cd8739030D2721bF01095896F5D6E`    |\n|    LiteCoin     |       `LZHvBkaJqKJRa8N7Dyu41Jd1PDBAofCik6`        |\n\n## Contributors\n\nPlease make sure to read the [Contributing Guide][contributing] before making a\npull request.\n\nThank you to all the people who already contributed to Sapphire!\n\n\u003ca href=\"https://github.com/favware/colorette-spinner/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=favware/colorette-spinner\" /\u003e\n\u003c/a\u003e\n\n[contributing]: ./.github/CONTRIBUTING.md\n[nanospinner]: https://github.com/usmanyunusov/nanospinner\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffavware%2Fcolorette-spinner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffavware%2Fcolorette-spinner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffavware%2Fcolorette-spinner/lists"}