{"id":13760640,"url":"https://github.com/badrap/bar-of-progress","last_synced_at":"2025-04-04T09:09:58.120Z","repository":{"id":34645176,"uuid":"180989210","full_name":"badrap/bar-of-progress","owner":"badrap","description":"A small, easy \u0026 zero-dependency progress bar component","archived":false,"fork":false,"pushed_at":"2024-06-16T17:39:41.000Z","size":649,"stargazers_count":246,"open_issues_count":2,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-28T08:07:36.535Z","etag":null,"topics":["javascript","progress-bar","typescript","zero-dependency"],"latest_commit_sha":null,"homepage":"","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/badrap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-12T10:49:57.000Z","updated_at":"2025-01-30T13:39:07.000Z","dependencies_parsed_at":"2024-01-15T03:42:02.231Z","dependency_job_id":"91164b2b-28de-42ac-87af-9b2fc89cc4df","html_url":"https://github.com/badrap/bar-of-progress","commit_stats":{"total_commits":58,"total_committers":3,"mean_commits":"19.333333333333332","dds":0.03448275862068961,"last_synced_commit":"b31db220cff8b8bf90ea8396e90bcf67dcd127f8"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fbar-of-progress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fbar-of-progress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fbar-of-progress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fbar-of-progress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badrap","download_url":"https://codeload.github.com/badrap/bar-of-progress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247043337,"owners_count":20874086,"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":["javascript","progress-bar","typescript","zero-dependency"],"created_at":"2024-08-03T13:01:15.022Z","updated_at":"2025-04-04T09:09:58.090Z","avatar_url":"https://github.com/badrap.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# bar-of-progress [![tests](https://github.com/badrap/bar-of-progress/workflows/tests/badge.svg)](https://github.com/badrap/bar-of-progress/actions?query=workflow%3Atests) [![npm](https://img.shields.io/npm/v/@badrap/bar-of-progress.svg)](https://www.npmjs.com/package/@badrap/bar-of-progress)\n\nA small, easy \u0026 zero-dependency progress bar component.\n\n![](https://user-images.githubusercontent.com/19776768/56576324-b40f1100-65d0-11e9-8332-37411ed01bd8.gif)\n\n## Features\n\n- **Zero dependencies**: Also not tied to any framework in particular.\n- **Small size**: \u003c 500 bytes with Brotli (\u003c 600 bytes gzipped).\n- **Easy to use**: Just a couple of lines and off you go. And TypeScript types are now available as well!\n\n\u003e [!NOTE]\n\u003e We consider this package to be feature-complete, and as such we're not taking in any new feature requests or suggestions. Please use the issue tracker for bug reports and security concerns, which we highly value and welcome. Thank you for your understanding ❤️\n\n## Installation\n\n```sh\n$ npm i @badrap/bar-of-progress\n```\n\n## Usage\n\nImport the package and create a progress bar instance:\n\n```js\nimport ProgressBar from \"@badrap/bar-of-progress\";\n\nconst progress = new ProgressBar();\n```\n\nShow the progress bar and begin animating it by calling the `.start()` method. \n\n```js\nprogress.start();\n```\n\n\u003e **Note**\n\u003e By default the progress bar does not appear immediately when `.start()` is called. Instead there is a 80 millisecond grace period, allowing very quickly completed tasks to avoid showing the progress bar. You can modify this (and other) behavior, see [Customization](#customization).\n\nEnd the progress bar animation by calling the `.finish()` method:\n\n```js\nsetTimeout(() =\u003e {\n  progress.finish();\n}, 1000);\n```\n\nYou can reuse a `progress` instance multiple times - every time `.start()` gets called the progress bar starts animation from scratch.\n\n## Customization\n\nThe progress bar's appearance and behavior can be (slightly) customized with constructor parameters. Here are the different options and their default values:\n\n```js\nconst progress = new ProgressBar({\n  // The size (height) of the progress bar.\n  // Numeric values get converted to px.\n  size: 2,\n\n  // Color of the progress bar.\n  // Also used for the glow around the bar.\n  color: \"#29e\",\n\n  // Class name used for the progress bar element.\n  className: \"bar-of-progress\",\n\n  // How many milliseconds to wait before the progress bar\n  // animation starts after calling .start().\n  delay: 80,\n});\n```\n\n## License\n\nThis library is licensed under the MIT license. See [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadrap%2Fbar-of-progress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadrap%2Fbar-of-progress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadrap%2Fbar-of-progress/lists"}