{"id":16432800,"url":"https://github.com/2nthony/loading-screen","last_synced_at":"2025-03-16T17:35:50.319Z","repository":{"id":39547843,"uuid":"183481552","full_name":"2nthony/loading-screen","owner":"2nthony","description":"🚥Loading screen for webpack plugin inspired by Nuxt.js's loading screen","archived":false,"fork":false,"pushed_at":"2023-12-15T20:14:02.000Z","size":533,"stargazers_count":58,"open_issues_count":21,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-20T22:15:39.220Z","etag":null,"topics":["it-just-works","loading-screen","nuxt","vue","webpack","webpack-plugin"],"latest_commit_sha":null,"homepage":"","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/2nthony.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":null,"patreon":"evillt","open_collective":null,"ko_fi":"evillt","tidelift":null,"custom":"https://donate.evila.me"}},"created_at":"2019-04-25T17:36:43.000Z","updated_at":"2024-06-21T18:56:01.848Z","dependencies_parsed_at":"2024-06-21T18:55:49.367Z","dependency_job_id":"0c950be6-e35c-497a-acad-9e731b1a70a0","html_url":"https://github.com/2nthony/loading-screen","commit_stats":{"total_commits":42,"total_committers":2,"mean_commits":21.0,"dds":"0.19047619047619047","last_synced_commit":"7c9c0065234aa1d61dec70c677714022ed4fc31f"},"previous_names":["evillt/loading-screen"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2nthony%2Floading-screen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2nthony%2Floading-screen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2nthony%2Floading-screen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2nthony%2Floading-screen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2nthony","download_url":"https://codeload.github.com/2nthony/loading-screen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221666414,"owners_count":16860415,"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":["it-just-works","loading-screen","nuxt","vue","webpack","webpack-plugin"],"created_at":"2024-10-11T08:44:23.780Z","updated_at":"2024-10-27T11:01:31.475Z","avatar_url":"https://github.com/2nthony.png","language":"JavaScript","readme":"\u003cimg src=\"https://user-images.githubusercontent.com/19513289/57039264-c0f5c980-6c8e-11e9-8894-3737f5671900.png\" alt=\"logo\"\u003e\n\n---\n\n[![NPM version](https://badgen.net/npm/v/loading-screen?icon=npm)](https://npmjs.com/package/loading-screen)\n[![NPM download](https://badgen.net/npm/dm/loading-screen?icon=npm)](https://npmjs.com/package/loading-screen)\n[![CircleCI](https://badgen.net/circleci/github/evillt/loading-screen?icon=circleci)](https://circleci.com/gh/evillt/loading-screen/tree/master)\n[![$donate](https://badgen.net/badge/$/donate/f2a)](https://patreon.com/evillt)\n\nPlease consider starring the project to show your ❤️ and support.\n\n![](https://user-images.githubusercontent.com/19513289/57173244-66f82e00-6e5f-11e9-887d-2bf01df4dca7.gif)\n\n## Introduction\n\nWebpack terminal information to browser.\n\n**_This plugin is recommended for webpack-based app bundler._**\n\n## Install\n\n```console\nyarn add loading-screen -D\n```\n\nUsing poi? Go [poi-plugin-loading-screen](https://github.com/evillt/poi-plugin-loading-screen)\n\n## Usage\n\nIn your `webpack.config.js`:\n\n```js\nconst LoadingScreenPlugin = require('loading-screen')\n\nmodule.exports = {\n  plugins: [new LoadingScreenPlugin()]\n}\n```\n\n## API\n\n`new LoadingScreenPlugin(options)`\n\n### host\n\n- Type: `string`\n- Default: `'localhost'`\n\nThe loading screen server host.\n\nP.S. CANNOT be the same as the app server host.\n\n### port\n\n- Type: `number`\n- Default: `process.env.port || 4000`\n\nThe loading screen server port.\n\n### callback\n\n- Type: `(req, res) =\u003e void`\n- DefaultBehavior: Print loading screen server message.\n\nThe loading screen server callback.\n\n### baseURL\n\n- Type: `string`\n- Default: `'/'`\n\nSimiliar with `webpack.output.publicPath`.\n\n### logo\n\n- Type: `url | HTML.innerHTML`\n- Default: `'https://webpack.js.org/assets/icon-square-big.svg'` which mean is webpack logo\n\nSet url to display your prefer logo for loading screen.\n\nOr with regular HTML:\n\n```js\nnew LoadingScreenPlugin({\n  logo: '\u003cdiv\u003emy logo\u003c/div\u003e'\n})\n```\n\n### theme\n\n- Type: `ThemeConfig`\n- Default: `DefaultThemeConfig`\n\nCustomize loading screen progress bar color.\n\n```ts\ninterface ThemeConfig {\n  client?: string\n  server?: string\n  modern?: string\n}\n\nconst DefaultThemeConfig = {\n  client: '#8ed5fb',\n  server: '#1b78bf',\n  modern: '#2f495e'\n}\n```\n\n### env\n\n- Type: `'development' | 'production'`\n- Default: `process.env.NODE_ENV`\n\nEnable loading screen when is `'development'`, disable otherwise.\n\n### handler\n\n- Type: `(per, message, ...details) =\u003e void`\n\nProgress hooks report details.\n\nReference: https://webpack.js.org/plugins/progress-plugin/\n\n### showPercent\n\n- Type: `boolean`\n- Default: `true`\n\n## Credits\n\n- [**nuxt/loading-screen**](https://github.com/nuxt/loading-screen)\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Author\n\n**loading-screen** © [EVILLT](https://github.com/evillt), Released under the [MIT](./LICENSE) License.\n\nAuthored and maintained by **EVILLT** with help from contributors ([list](https://github.com/evillt/loading-screen/contributors)).\n\n\u003e [evila.me](https://evila.me) · GitHub [@evillt](https://github.com/evillt) · Twitter [@evillt](https://twitter.com/evillt)\n","funding_links":["https://patreon.com/evillt","https://ko-fi.com/evillt","https://donate.evila.me"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2nthony%2Floading-screen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2nthony%2Floading-screen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2nthony%2Floading-screen/lists"}