{"id":24379824,"url":"https://github.com/seesharpsoft/mmm-overlay","last_synced_at":"2026-07-15T19:33:40.058Z","repository":{"id":271028175,"uuid":"912170076","full_name":"SeeSharpSoft/MMM-Overlay","owner":"SeeSharpSoft","description":"Lightweight module for MagicMirror² to add an overlay for showing any kind of module contents","archived":false,"fork":false,"pushed_at":"2025-01-04T22:11:19.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-27T22:50:02.071Z","etag":null,"topics":["magicmirror","magicmirror-module","magicmirror2","magicmirror2-module"],"latest_commit_sha":null,"homepage":"https://github.com/SeeSharpSoft/MMM-Overlay","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/SeeSharpSoft.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":"2025-01-04T19:55:48.000Z","updated_at":"2025-01-16T12:49:27.000Z","dependencies_parsed_at":"2025-01-04T22:25:44.035Z","dependency_job_id":"2f156e0a-cdfd-4a76-aa03-c4d20f5ddc0d","html_url":"https://github.com/SeeSharpSoft/MMM-Overlay","commit_stats":null,"previous_names":["seesharpsoft/mmm-overlay"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SeeSharpSoft/MMM-Overlay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeSharpSoft%2FMMM-Overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeSharpSoft%2FMMM-Overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeSharpSoft%2FMMM-Overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeSharpSoft%2FMMM-Overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SeeSharpSoft","download_url":"https://codeload.github.com/SeeSharpSoft/MMM-Overlay/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeeSharpSoft%2FMMM-Overlay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35519051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-15T02:00:06.706Z","response_time":131,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["magicmirror","magicmirror-module","magicmirror2","magicmirror2-module"],"created_at":"2025-01-19T07:27:47.707Z","updated_at":"2026-07-15T19:33:40.036Z","avatar_url":"https://github.com/SeeSharpSoft.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MMM-Overlay\n\nThis is a lightweight module for [MagicMirror²][mm] to have a modal overlay to show any kind of modules.\n\n## Installation\n\n### Install\n\nIn your terminal, go to your [MagicMirror²][mm] Module folder and clone MMM-Overlay:\n\n```bash\ncd ~/MagicMirror/modules\ngit clone https://github.com/SeeSharpSoft/MMM-Overlay.git\n```\n\n### Update\n\n```bash\ncd ~/MagicMirror/modules/MMM-Overlay\ngit pull\n```\n\n## Using the module\n\n### Update `index.html`\n\nThis module requires a new region definition in the `index.html` file of MagicMirror (root).\n\nAdd the following line in the `MagicMirror/index.html` within the body tag:\n\n```html\n\u003cdiv class=\"region overlay\"\u003e\u003cdiv class=\"container\"\u003e\u003c/div\u003e\u003c/div\u003e\n```\n\nlike this\n```html\n\u003chtml\u003e\n    \u003chead\u003e\n      ...\n    \u003c/head\u003e\n    \u003cbody\u003e\n        ...\n        \u003cdiv class=\"region fullscreen above\"\u003e\u003cdiv class=\"container\"\u003e\u003c/div\u003e\u003c/div\u003e\n        \u003cdiv class=\"region overlay\"\u003e\u003cdiv class=\"container\"\u003e\u003c/div\u003e\u003c/div\u003e \u003c!-- recommended position is at the end of the region divs --\u003e\n        \u003cscript ... /\u003e\n          ...\n    \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Config\n\nTo use this module, add it to the modules array in the `config/config.js` file:\n\n```js\n    {\n        module: \"MMM-Overlay\",\n        config: {\n          active: false\n        }\n    }\n```\n\n**Note:** Do not add a position to this module.\n\nIf a module should render in the overlay, use `overlay` as position value, like\n```js\n    {\n        module: \"weather\",\n        position: \"overlay\",\n        config: {\n          ...\n        }\n    }\n```\n\n## Configuration options\n\nOption| Possible values | Default |Description\n------|-----------------|---------|-----------\n`active`| `boolean`       | false   |Whether the overlay is active/visible\n\n## Sending notifications to the module\n\nBy default, the overlay is not active/visible. Its visibility can be controlled by sending notifications.\n\nNotification|Description\n------|-----------\n`OVERLAY.SHOW`|Shows (activates) the overlay\n`OVERLAY.HIDE`|Hides (deactivates) the overlay\n`OVERLAY.ACTIVE`|Payload must contain `true`/`false`\n\n## Developer commands\n\n- `npm install` - Install devDependencies like ESLint.\n- `npm run lint` - Run linting and formatter checks.\n- `npm run lint:fix` - Fix linting and formatter issues.\n\n[mm]: https://github.com/MagicMirrorOrg/MagicMirror\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseesharpsoft%2Fmmm-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseesharpsoft%2Fmmm-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseesharpsoft%2Fmmm-overlay/lists"}