{"id":13670365,"url":"https://github.com/hulufei/electron-as-browser","last_synced_at":"2025-04-05T12:09:15.147Z","repository":{"id":35076041,"uuid":"202959531","full_name":"hulufei/electron-as-browser","owner":"hulufei","description":"Make electron like browser easy and flexible.","archived":false,"fork":false,"pushed_at":"2024-01-09T07:20:20.000Z","size":1413,"stargazers_count":211,"open_issues_count":11,"forks_count":45,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T10:06:16.301Z","etag":null,"topics":["addressbar","browserview","electron","electron-browser","newtab"],"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/hulufei.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}},"created_at":"2019-08-18T04:27:03.000Z","updated_at":"2025-03-27T02:02:31.000Z","dependencies_parsed_at":"2023-12-14T03:46:50.731Z","dependency_job_id":"9fcbcd98-1de1-491b-ac1b-fa022b53cbf4","html_url":"https://github.com/hulufei/electron-as-browser","commit_stats":{"total_commits":52,"total_committers":4,"mean_commits":13.0,"dds":0.3846153846153846,"last_synced_commit":"73bd01d6b53f457acbdd1a8fb74adac6ec5821cf"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hulufei%2Felectron-as-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hulufei%2Felectron-as-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hulufei%2Felectron-as-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hulufei%2Felectron-as-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hulufei","download_url":"https://codeload.github.com/hulufei/electron-as-browser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332612,"owners_count":20921853,"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":["addressbar","browserview","electron","electron-browser","newtab"],"created_at":"2024-08-02T09:00:40.130Z","updated_at":"2025-04-05T12:09:15.128Z","avatar_url":"https://github.com/hulufei.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# electron-as-browser\n\n![version](https://img.shields.io/npm/v/electron-as-browser.svg?style=flat-square)![downloads](https://img.shields.io/npm/dt/electron-as-browser.svg?style=flat-square)![license](https://img.shields.io/npm/l/electron-as-browser.svg?style=flat-square)\n\nA node module to help build\tbrowser like windows in electron.\n\n![./screenshot.png](./screenshot.png)\n\n## Features\n\n-   Made with [BrowserView](https://electronjs.org/docs/api/browser-view) instead of [webview](https://electronjs.org/docs/api/webview-tag)\n-   Pluggable control panel (Navigation interface)\n-   Exposed [webContents](https://electronjs.org/docs/api/web-contents) and [BrowserWindow](https://electronjs.org/docs/api/browser-window)\n-   Tricky auto resize just out of the box\n\n## Install\n\n`npm i electron-as-browser`\n\n## Usage\n\n### First, create BrowserLikeWindow in [Main](https://electronjs.org/docs/glossary#main-process) process\n\n```javascript\nimport BrowserLikeWindow from 'electron-as-browser';\n\nlet browser;\n\nbrowser = new BrowserLikeWindow({\n  controlPanel: 'renderer/you-control-interface.html',\n  startPage: 'https://page-to-load-once-open',\n  blankTitle: 'New tab',\n  debug: true // will open controlPanel's devtools\n});\n\n// Trigger on new tab created\nbrowser.on('new-tab', ({ webContents }) =\u003e {\n  // Customize webContents if your like\n});\n\nbrowser.on('closed', () =\u003e {\n  // Make it garbage collected\n  browser = null;\n});\n```\n\n### Second, style your own browser control interface([renderer](https://electronjs.org/docs/glossary#renderer-process) process).\n\nTo make the control interface works, there are two steps:\n\n-   Setup ipc channels to receive tabs' informations\n-   Send actions to control the behaviours\n\nFor react users, there is a custom hook `useConnect` to help you setup ipc channels.\n\n```javascript\nimport useConnect from 'electron-as-browser/useConnect';\n\nconst ControlPanel = () =\u003e {\n  const { tabs, tabIDs, activeID } = useConnect();\n  return (\n    \u003cdiv\u003eUse tabs' information to render your control panel\u003c/div\u003e\n  );\n}\n```\n\nFor non-react users, you have to setup ipc channels yourself, there are three steps:\n\n-   `ipcRenderer.send('control-ready')` on dom ready\n-   `ipcRenderer.on('tabs-update', (e, tabs) =\u003e { // tabs updated })`\n-   `ipcRenderer.on('active-update', (e, activeID) =\u003e { // Active tab's id updated })`\n\nDon't forget to `removeListener` on `ipcRenderer` once control panel unmounted.\n\nOnce setup ipc channels, you'll get all your control panel needed informations:\n\n-   [`tabs`](https://hulufei.github.io/electron-as-browser/#tabs) an object contains all the opened tab's informations\n-   [`tabIDs`](https://hulufei.github.io/electron-as-browser/#tabid) array of opened tab's ids\n-   [`activeID`](https://hulufei.github.io/electron-as-browser/#tabid) current active tab's id\n\nConstruct and style your control interface as your like.\n\nThen you can send actions to control the browser view, the actions can require from `electron-as-browser/control`:\n\n```javascript\nimport {\n  sendEnterURL, // sendEnterURL(url) to load url\n  sendChangeURL, // sendChangeURL(url) on addressbar input change\n  sendGoBack,\n  sendGoForward,\n  sendReload,\n  sendStop,\n  sendNewTab, // sendNewTab([url])\n  sendSwitchTab, // sendSwitchTab(toID)\n  sendCloseTab // sendCloseTab(id)\n} from 'electron-as-browser/control';\n```\n\nSee [example](./example) for a full control interface implementation.\n\n### Run Example\n\n- yarn install\n- yarn start:control\n- yarn start\n\n## [API](https://hulufei.github.io/electron-as-browser/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhulufei%2Felectron-as-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhulufei%2Felectron-as-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhulufei%2Felectron-as-browser/lists"}