{"id":18429413,"url":"https://github.com/bigpipe/bigpipe-progress","last_synced_at":"2025-04-13T21:44:27.514Z","repository":{"id":27993266,"uuid":"31487391","full_name":"bigpipe/bigpipe-progress","owner":"bigpipe","description":"BigPipe plugin which shows a custom progress bar when your pagelets are loading.","archived":false,"fork":false,"pushed_at":"2020-10-26T13:43:59.000Z","size":9,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-16T11:18:53.482Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bigpipe.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}},"created_at":"2015-03-01T05:03:21.000Z","updated_at":"2020-10-26T13:44:02.000Z","dependencies_parsed_at":"2022-08-02T10:52:39.414Z","dependency_job_id":null,"html_url":"https://github.com/bigpipe/bigpipe-progress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-progress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-progress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-progress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-progress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigpipe","download_url":"https://codeload.github.com/bigpipe/bigpipe-progress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788868,"owners_count":21161726,"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-06T05:16:57.759Z","updated_at":"2025-04-13T21:44:27.484Z","avatar_url":"https://github.com/bigpipe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bigpipe-progress\n\n[![Version npm][version]](http://browsenpm.org/package/bigpipe-progress)[![Build Status][build]](https://travis-ci.org/bigpipe/bigpipe-progress)[![Dependencies][david]](https://david-dm.org/bigpipe/bigpipe-progress)[![Coverage Status][cover]](https://coveralls.io/r/bigpipe/bigpipe-progress?branch=master)\n\n[version]: http://img.shields.io/npm/v/bigpipe-progress.svg?style=flat-square\n[build]: http://img.shields.io/travis/bigpipe/bigpipe-progress/master.svg?style=flat-square\n[david]: https://img.shields.io/david/bigpipe/bigpipe-progress.svg?style=flat-square\n[cover]: http://img.shields.io/coveralls/bigpipe/bigpipe-progress/master.svg?style=flat-square\n\nThis module adds a small progress bar in to the page will increment each time\na pagelet on your page is fully loaded (all the CSS and JS).\n\n## Installation\n\nThe module is released in the public npm registry and can be installed by\nrunning:\n\n```bash\nnpm install --save bigpipe-progress\n```\n\nIn your terminal. The `--save` flag tells `npm` to automatically add the\ninstalled version to your `package.json`\n\n## Usage\n\nAs this is a plugin for the `bigpipe` framework it can be loaded using the\n`bigpipe.use` method as show in the example below:\n\n```js\nvar BigPipe = require('bigpipe');\nvar bigpipe = BigPipe.createServer({\n  port: 8080\n});\n\n//\n// We can require the module directly and pass it in bigpipe's use method.\n//\nbigpipe.use('progress', require('bigpipe-progress'));\n```\n\nAnd that all you need to load in the plugin. Now, the plugin that we load in the\npage is un-styled but has some special classes that can be used for styling\npurposes.\n\nWe also have an example CSS file in the root of this repository if you want to\nhave some design inspiration. The following class names are set:\n\n- `.progressive` This className is applies to the parent `div` element of the\n  progress bar.\n- `.bar` The div within the `.progressive` element who's `width` style attribute\n  is increased.\n\nWhen the progress bar reaches 100% we automatically hide the progress bar.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigpipe%2Fbigpipe-progress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigpipe%2Fbigpipe-progress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigpipe%2Fbigpipe-progress/lists"}