{"id":13578166,"url":"https://github.com/electron-utils/electron-dockable","last_synced_at":"2025-03-20T03:36:20.056Z","repository":{"id":57221618,"uuid":"72596180","full_name":"electron-utils/electron-dockable","owner":"electron-utils","description":"dockable panel for electron (work in progress...)","archived":false,"fork":false,"pushed_at":"2017-10-16T10:34:39.000Z","size":97,"stargazers_count":50,"open_issues_count":1,"forks_count":10,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-23T06:42:36.010Z","etag":null,"topics":["dockable","electron","panel"],"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/electron-utils.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2016-11-02T02:25:41.000Z","updated_at":"2024-04-23T06:42:36.011Z","dependencies_parsed_at":"2022-08-29T01:50:53.682Z","dependency_job_id":null,"html_url":"https://github.com/electron-utils/electron-dockable","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/electron-utils%2Felectron-dockable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-utils%2Felectron-dockable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-utils%2Felectron-dockable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-utils%2Felectron-dockable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron-utils","download_url":"https://codeload.github.com/electron-utils/electron-dockable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244545304,"owners_count":20469832,"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":["dockable","electron","panel"],"created_at":"2024-08-01T15:01:28.085Z","updated_at":"2025-03-20T03:36:20.030Z","avatar_url":"https://github.com/electron-utils.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# electron-dockable\n\n[![Linux Build Status](https://travis-ci.org/electron-utils/electron-dockable.svg?branch=master)](https://travis-ci.org/electron-utils/electron-dockable)\n[![Windows Build status](https://ci.appveyor.com/api/projects/status/gvq9d5i4hw07hulm?svg=true)](https://ci.appveyor.com/project/jwu/electron-dockable)\n[![Dependency Status](https://david-dm.org/electron-utils/electron-dockable.svg)](https://david-dm.org/electron-utils/electron-dockable)\n[![devDependency Status](https://david-dm.org/electron-utils/electron-dockable/dev-status.svg)](https://david-dm.org/electron-utils/electron-dockable#info=devDependencies)\n\n**Work in progress...**\n\n  - [x] dock and undock in single page workspace\n  - [ ] pop out and dock in a panel\n  - [x] save and restore dock layout\n  - [ ] ui-dock-toolbar\n  - [ ] ui-dock-panel (single panel, no tab-bar)\n  - [ ] floating panel in workspace (always on top, set as child window in BrowserWindow)\n  - [ ] provide a way to customize theme\n  - [ ] provide a way to customize dock behaviors\n  - [ ] unit tests\n  - [ ] ...\n\nDockable ui framework for Electron. Use the [Custom Element v1](https://developers.google.com/web/fundamentals/getting-started/primers/customelements) \u0026 [Shadow DOM v1](https://developers.google.com/web/fundamentals/getting-started/primers/shadowdom).\n\n## Install\n\n```bash\nnpm install --save electron-dockable\n```\n\n## Run Examples\n\n```bash\nnpm start ./examples/${name}\n```\n\n## Usage\n\n**main process**\n\nPlease check [electron-panel](https://github.com/electron-utils/electron-panel) to learn how to define a panel-frame.\n\n```javascript\n'use strict';\n\nconst {app} = require('electron');\nconst protocols = require('electron-protocols');\nconst dockable = require('electron-dockable');\n\nprotocols.register('app', protocols.basepath(app.getAppPath()));\n\napp.on('ready', function () {\n  dockable.init({\n    layout: {\n      type: 'dock-area-v',\n      children: [\n        {\n          type: 'panel-group',\n          height: 300,\n          active: 0,\n          children: [\n            { id: 'asset', src: 'app://panels/foo.js' } // a panel-frame defined by you\n          ],\n        },\n        {\n          type: 'dock-area-h',\n          children: [\n            {\n              type: 'panel-group',\n              active: 1,\n              children: [\n                { id: 'bar', src: 'app://panels/bar.js' } // a panel-frame defined by you\n              ],\n            },\n            {\n              type: 'panel-group',\n              active: 0,\n              children: [\n                { id: 'bar-02', src: 'app://panels/bar.js' } // a panel-frame defined by you\n              ],\n            },\n          ],\n        },\n      ]\n    }\n  });\n\n  //\n  dockable.windows.restore(`file://${__dirname}/index.html`, {\n    center: true,\n    width: 400,\n    height: 600,\n  });\n});\n```\n\n**renderer process**\n\n```html\n\u003chtml lang=\"en\"\u003e\n  \u003chead\u003e\n    \u003cmeta charset=\"utf-8\"\u003e\n    \u003ctitle\u003eWorkspace\u003c/title\u003e\n    \u003cstyle\u003e\n      body {\n        position: absolute;\n        top: 0; bottom: 0; left: 0; right: 0;\n        display: flex;\n        flex-direction: column;\n      }\n    \u003c/style\u003e\n  \u003c/head\u003e\n\n  \u003cbody\u003e\n    \u003cui-workspace style=\"flex: 1;\"\u003e\u003c/ui-workspace\u003e\n\n    \u003cscript\u003e\n      require('electron-dockable');\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n## Documentation\n\n  - TODO\n  - [Known Issues](./docs/known-issues.md)\n\n## License\n\nMIT © 2017 Johnny Wu\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-utils%2Felectron-dockable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron-utils%2Felectron-dockable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-utils%2Felectron-dockable/lists"}