{"id":15639630,"url":"https://github.com/guillaumebriday/vue-scroll-progress-bar","last_synced_at":"2025-12-24T11:01:46.855Z","repository":{"id":57114518,"uuid":"166882837","full_name":"guillaumebriday/vue-scroll-progress-bar","owner":"guillaumebriday","description":"Vue.js plugin for page scroll progress bar","archived":false,"fork":false,"pushed_at":"2024-01-12T16:43:01.000Z","size":753,"stargazers_count":85,"open_issues_count":4,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-08T17:02:19.102Z","etag":null,"topics":["npm-package","progress-bar","scroll-events","scrollbar","vue","vue-plugin","vuecli3","vuejs2"],"latest_commit_sha":null,"homepage":"https://vue-scroll-progress-bar.netlify.com/","language":"JavaScript","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/guillaumebriday.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"guillaumebriday"}},"created_at":"2019-01-21T21:24:13.000Z","updated_at":"2024-03-08T07:04:29.000Z","dependencies_parsed_at":"2024-06-18T23:59:41.158Z","dependency_job_id":"c64f6587-7936-4321-9b01-7433db4a1d41","html_url":"https://github.com/guillaumebriday/vue-scroll-progress-bar","commit_stats":{"total_commits":62,"total_committers":3,"mean_commits":"20.666666666666668","dds":"0.33870967741935487","last_synced_commit":"de3296faee4e41cf24f0a80b5c140127d5e2f5f0"},"previous_names":["guillaumebriday/vue-scroll-progressbar"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/guillaumebriday/vue-scroll-progress-bar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaumebriday%2Fvue-scroll-progress-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaumebriday%2Fvue-scroll-progress-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaumebriday%2Fvue-scroll-progress-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaumebriday%2Fvue-scroll-progress-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guillaumebriday","download_url":"https://codeload.github.com/guillaumebriday/vue-scroll-progress-bar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guillaumebriday%2Fvue-scroll-progress-bar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271999361,"owners_count":24856182,"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-08-25T02:00:12.092Z","response_time":1107,"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":["npm-package","progress-bar","scroll-events","scrollbar","vue","vue-plugin","vuecli3","vuejs2"],"created_at":"2024-10-03T11:26:44.975Z","updated_at":"2025-12-24T11:01:41.803Z","avatar_url":"https://github.com/guillaumebriday.png","language":"JavaScript","funding_links":["https://github.com/sponsors/guillaumebriday","https://www.paypal.me/guillaumebriday"],"categories":[],"sub_categories":[],"readme":"# vue-scroll-progress-bar\n\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/guillaumebriday)\n![](https://github.com/guillaumebriday/vue-scroll-progress-bar/workflows/Lint/badge.svg)\n[![](https://img.shields.io/npm/dt/@guillaumebriday/vue-scroll-progress-bar.svg)](https://www.npmjs.com/package/@guillaumebriday/vue-scroll-progress-bar)\n[![](https://img.shields.io/npm/v/@guillaumebriday/vue-scroll-progress-bar.svg)](https://www.npmjs.com/package/@guillaumebriday/vue-scroll-progress-bar)\n[![](https://img.shields.io/github/license/guillaumebriday/vue-scroll-progress-bar.svg)](https://github.com/guillaumebriday/vue-scroll-progress-bar)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/63086bf9-f804-451e-9319-052191432063/deploy-status)](https://app.netlify.com/sites/vue-scroll-progress-bar/deploys)\n\n## Getting started\n\n## Install\n\n```bash\n$ npm install @guillaumebriday/vue-scroll-progress-bar --save\n```\n\nor\n\n```bash\n$ yarn add @guillaumebriday/vue-scroll-progress-bar\n```\n\nInstall the plugin into Vue:\n```js\nimport Vue from 'vue'\nimport VueScrollProgressBar from '@guillaumebriday/vue-scroll-progress-bar'\n\nVue.use(VueScrollProgressBar)\n```\n\nOr use the component directly:\n\n```js\nimport { VueScrollProgressBar } from '@guillaumebriday/vue-scroll-progress-bar'\n\nexport default {\n  components: {\n    VueScrollProgressBar\n  },\n\n  // ...\n}\n```\n\n## Basic Usage\n\n```html\n\u003ctemplate\u003e\n  \u003cvue-scroll-progress-bar @complete=\"handleComplete\" height=\"2rem\" /\u003e\n\u003c/template\u003e\n```\n\n## Props\n\n|key|description|default|\n|:---|---|---|\n| `height`|Height of the progress bar|`'.5rem'`|\n|`backgroundColor`|Background property of the progress bar|`'linear-gradient(to right, #38C172, #51D88A)'`|\n|`barClass`|Class attribute of the progress bar|`'{}'`|\n|`containerColor`|Background property of the progress bar container|`'transparent'`|\n|`zIndex`|z-index property of the progress bar container|`'50'`|\n|`containerClass`|Class attribute of the progress bar container|`'{\"progress-bar-container--container\": true}'`|\n\nWith :\n\n```css\n.progress-bar-container--container {\n  position: fixed;\n  width: 100%;\n  top: 0;\n  left: 0;\n}\n```\n\n`containerClass` must be used to override the `.progress-bar-container--container` default class. You can use the default `:class` syntax on the component to add classes if needed.\n\n## Events\n\n|key|description|\n|:---|---|\n| `begin`|When scroll reached 0%|\n|`complete`|When scroll reached 100%|\n\n## Develop\n\n### Project setup\n```bash\n$ yarn install\n$ yarn build\n```\n\n### Open example app\n\n```bash\n$ cd example\n$ yarn\n$ yarn serve\n```\n\n### Lint files\n```bash\n$ yarn lint\n```\n\n## Contributing\n\nDo not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.\n\n## License\n\nThis project is released under the [MIT](http://opensource.org/licenses/MIT) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumebriday%2Fvue-scroll-progress-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguillaumebriday%2Fvue-scroll-progress-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumebriday%2Fvue-scroll-progress-bar/lists"}