{"id":16795406,"url":"https://github.com/fifciu/vsf-browser-update","last_synced_at":"2025-07-21T22:37:19.241Z","repository":{"id":100621593,"uuid":"293042750","full_name":"Fifciu/vsf-browser-update","owner":"Fifciu","description":"Vue Storefront 1.11+ PWA Module that wraps Browser Update npm's package. It allows us to use all configuration options from the original package.","archived":false,"fork":false,"pushed_at":"2020-09-06T10:06:32.000Z","size":8,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T03:14:04.611Z","etag":null,"topics":["module","pwa","vsf","vuestorefront"],"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/Fifciu.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":"2020-09-05T09:20:51.000Z","updated_at":"2020-09-07T06:24:34.000Z","dependencies_parsed_at":"2023-05-16T10:00:44.932Z","dependency_job_id":null,"html_url":"https://github.com/Fifciu/vsf-browser-update","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Fifciu/vsf-browser-update","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fifciu%2Fvsf-browser-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fifciu%2Fvsf-browser-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fifciu%2Fvsf-browser-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fifciu%2Fvsf-browser-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fifciu","download_url":"https://codeload.github.com/Fifciu/vsf-browser-update/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fifciu%2Fvsf-browser-update/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266393655,"owners_count":23922425,"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-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["module","pwa","vsf","vuestorefront"],"created_at":"2024-10-13T09:16:16.910Z","updated_at":"2025-07-21T22:37:19.219Z","avatar_url":"https://github.com/Fifciu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vue Storefront Browser Update\nPWA Module\n![Preview](https://user-images.githubusercontent.com/30155292/92304237-6eac7300-ef7c-11ea-8ecb-eadc51d90845.png)\n\nIt is wrapper for: https://github.com/browser-update/browser-update\n\n## Requirements\n- Vue Storefront 1.11+\n\n## How to install\n1. Clone repository to src/modules of your PWA with SSH or HTTPS:\n```sh\n# With SSH\ngit clone git@github.com:Fifciu/vsf-browser-update.git src/modules/vsf-browser-update;\n# With HTTPS\ngit clone https://github.com/Fifciu/vsf-browser-update.git src/modules/vsf-browser-update;\n```\n\n2. Import \u0026 register module in `src/modules/client.ts`:\n```ts\nimport { BrowserUpdateModule } from './vsf-browser-update';\n\n// ...\nexport function registerClientModules () {\n  // ...\n  registerModule(BrowserUpdateModule)\n  // ...\n}\n```\n\n3. In your `config/local.json` add:\n```js\n\"browserUpdate\": {\n    \"enabled\": true\n}\n```\n\n4. That's all. To test if everything went well - run app with `yarn dev` and append to the end of url `#test-bu` phrase. It will force popup to show.\n\n## How to customize\n\nIn your `config/local.json` you can use `configuration` option:\n```js\n\"browserUpdate\": {\n    \"enabled\": true,\n    \"configuration\": {\n        // Your config\n    }\n}\n```\n\n[List of attributes can be found there](http://browser-update.org/customize.html)\n\nAs configuration is inside JSON, it does not support these attributes:\n- `container`\n- `onshow`\n- `onclick`\n- `onclose`\n\nTo modify them you have to use module's config inside `src/modules/client.ts`, e.g:\n```ts\nregisterModule(BrowserUpdateModule, {\n    onshow (infos) {\n        console.log('Just shown', infos)\n    },\n    onclick (infos) {\n        console.log('Just clicked \"Update browser\"', infos)\n    },\n    onclose (infos) {\n        console.log('Just clicked \"Ignore\"', infos)\n    }\n})\n```\n\nFor `container`, you should use function which returns DOMElement. I make sure it will be executed only client-side, so you can easily use `window`.\n```ts\nregisterModule(BrowserUpdateModule, {\n    container () {\n        return window.document.body;\n    }\n})\n```\n\n*Caution*: configuration inside `client.ts` has bigger power than one inside `local.json` so it is possible to overwrite options. However, keep in mind it is only about `Browser Update` config, you cannot disable module by option in client.ts.\n\nIf you want to customize CSS - just use `#buorg` identifier. It is easier to use it because when you use `.buorg` class it will have same power as default ones and default ones will overwrite it. It is also important to do not use `scoped` stylings for that purpose.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffifciu%2Fvsf-browser-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffifciu%2Fvsf-browser-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffifciu%2Fvsf-browser-update/lists"}