{"id":13588605,"url":"https://github.com/piitaya/lovelace-mushroom","last_synced_at":"2026-02-27T16:18:47.213Z","repository":{"id":37009091,"uuid":"444350375","full_name":"piitaya/lovelace-mushroom","owner":"piitaya","description":"Build a beautiful Home Assistant dashboard easily","archived":false,"fork":false,"pushed_at":"2026-01-01T19:51:10.000Z","size":3594,"stargazers_count":4759,"open_issues_count":411,"forks_count":416,"subscribers_count":28,"default_branch":"main","last_synced_at":"2026-01-24T09:28:33.525Z","etag":null,"topics":["card","hacktoberfest","hacs","home-assistant","lovelace","mushroom"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piitaya.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"piitaya","buy_me_a_coffee":"piitaya","custom":["https://www.paypal.me/pbottein"]}},"created_at":"2022-01-04T08:58:46.000Z","updated_at":"2026-01-23T16:29:46.000Z","dependencies_parsed_at":"2024-01-05T19:32:35.212Z","dependency_job_id":"db19b961-121b-449e-80ca-d87a46bf2dda","html_url":"https://github.com/piitaya/lovelace-mushroom","commit_stats":{"total_commits":693,"total_committers":109,"mean_commits":"6.3577981651376145","dds":0.3203463203463204,"last_synced_commit":"d5baf62d8035833113030a08ccd259c08862d484"},"previous_names":[],"tags_count":134,"template":false,"template_full_name":null,"purl":"pkg:github/piitaya/lovelace-mushroom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piitaya%2Flovelace-mushroom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piitaya%2Flovelace-mushroom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piitaya%2Flovelace-mushroom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piitaya%2Flovelace-mushroom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piitaya","download_url":"https://codeload.github.com/piitaya/lovelace-mushroom/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piitaya%2Flovelace-mushroom/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28850473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T15:15:36.453Z","status":"ssl_error","status_checked_at":"2026-01-28T15:15:13.020Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["card","hacktoberfest","hacs","home-assistant","lovelace","mushroom"],"created_at":"2024-08-01T15:06:49.008Z","updated_at":"2026-01-30T18:01:15.813Z","avatar_url":"https://github.com/piitaya.png","language":"TypeScript","funding_links":["https://github.com/sponsors/piitaya","https://buymeacoffee.com/piitaya","https://www.paypal.me/pbottein","https://www.buymeacoffee.com/piitaya"],"categories":["TypeScript","hacktoberfest","Dashboard Cards","🌐 Web Development - Frontend"],"sub_categories":["🧱 Dashboard frameworks"],"readme":"# 🍄 Mushroom\n\n[![hacs][hacs-badge]][hacs-url]\n[![release][release-badge]][release-url]\n![downloads][downloads-badge]\n![build][build-badge]\n[![translations][translations-badge]][weblate-url]\n\n\u003ca href=\"https://www.buymeacoffee.com/piitaya\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/white_img.png\" alt=\"Buy Me A Coffee\" style=\"height: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\n![Overview](https://user-images.githubusercontent.com/5878303/152332130-760cf616-5c40-4825-a482-bb8f1f0f5251.png)\n\n## What is mushroom ?\n\nMushroom is a collection of cards for [Home Assistant][home-assistant] Dashboard UI.\n\nMushroom mission is to propose easy to use components to build your [Home Assistant][home-assistant] dashboard.\n\n### Features\n\n- 🛠 Editor for **all cards** and and **all options** (no need to edit `yaml`)\n- 😍 Icon picker\n- 🖌 Color picker\n- 🚀 0 dependencies : no need to install another card.\n- 🌈 Based on Material UI colors\n- 🌓 Light and dark theme support\n- 🎨 Optional theme customization\n- 🌎 Internationalization\n\nThe goal of Mushroom is not to provide custom card for deep customization. You can use the excellent [UI Lovelace Minimalist][ui-lovelace-minimalist] and [Button card][button-card] plugins for this.\n\n## Installation\n\n### HACS\n\nMushroom is available in [HACS][hacs] (Home Assistant Community Store).\n\nUse this link to directly go to the repository in HACS\n\n[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=piitaya\u0026repository=lovelace-mushroom)\n\n_or_\n\n1. Install HACS if you don't have it already\n2. Open HACS in Home Assistant\n3. Search for \"Mushroom\"\n4. Click the download button. ⬇️\n\n### Manual\n\n1. Download `mushroom.js` file from the [latest release][release-url].\n2. Put `mushroom.js` file into your `config/www` folder.\n3. Add reference to `mushroom.js` in Dashboard. There's two way to do that:\n   - **Using UI:** _Settings_ → _Dashboards_ → _More Options icon_ → _Resources_ → _Add Resource_ → Set _Url_ as `/local/mushroom.js` → Set _Resource type_ as `JavaScript Module`.\n     **Note:** If you do not see the Resources menu, you will need to enable _Advanced Mode_ in your _User Profile_\n   - **Using YAML:** Add following code to `lovelace` section.\n     ```yaml\n     resources:\n       - url: /local/mushroom.js\n         type: module\n     ```\n\n## Usage\n\nAll the Mushroom cards can be configured using Dashboard UI editor.\n\n1. In Dashboard UI, click 3 dots in top right corner.\n2. Click _Edit Dashboard_.\n3. Click Plus button to add a new card.\n4. Find one of the _Custom: Mushroom_ card in the list.\n\n### Cards\n\nDifferent cards are available for differents entities :\n\n- 🚨 [Alarm card](docs/cards/alarm-control-panel.md)\n- 🔔 [Chips card](docs/cards/chips.md)\n- 🌡 [Climate card](docs/cards/climate.md)\n- 🪟 [Cover card](docs/cards/cover.md)\n- 🪄 [Entity card](docs/cards/entity.md)\n- 🕳 [Empty card](docs/cards/empty.md)\n- 💨 [Fan card](docs/cards/fan.md)\n- 💧 [Humidifier card](docs/cards/humidifier.md)\n- 💡 [Light card](docs/cards/light.md)\n- 🔒 [Lock card](docs/cards/lock.md)\n- 📺 [Media card](docs/cards/media-player.md)\n- 🔢 [Number card](docs/cards/number.md)\n- 🙋 [Person card](docs/cards/person.md)\n- 📑 [Select card](docs/cards/select.md)\n- 🛠 [Template card](docs/cards/template.md)\n- ✏️ [Title card](docs/cards/title.md)\n- 📦 [Update card](docs/cards/update.md)\n- 🧹 [Vacuum card](docs/cards/vacuum.md)\n\n### Legacy cards\n\nSome cards are considered as legacy, are not available in the card picker but you can still use them :\n\n- 🛠 [Legacy Template card](docs/cards/legacy-template.md)\n\n### Badges\n\nA [template badge](docs/badges/template.md) is available if you're using at least Home Assistant 2024.8.\n\n### Theme customization\n\nMushroom works without theme but you can add a theme for better experience by installing the [Mushroom Themes](https://github.com/piitaya/lovelace-mushroom-themes). If you want more information about themes, check out the official [Home Assistant documentation about themes][home-assitant-theme-docs].\n\n## Development server\n\n### Home assistant demo\n\nYou can run a demo instance of Home Assistant with docker by running:\n\n```sh\nnpm run start:hass\n```\n\nOnce it's done, go to Home Assistant instance [http://localhost:8123](http://localhost:8123) and start configuration.\n\n#### Windows Users\n\nIf you are on Windows, either run the above command in Powershell, or use the below if using Command Prompt:\n\n```sh\nnpm run start:hass-cmd\n```\n\n### Development\n\nIn another terminal, install dependencies and run development server:\n\n```sh\nnpm install\nnpm start\n```\n\nServer will start on port `4000`.\n\n### Build\n\nYou can build the `mushroom.js` file in `dist` folder by running the build command.\n\n```sh\nnpm run build\n```\n\n### Translations\n\nIf you want to help translating Mushroom, you can translate it directly from your browser using [Weblate][weblate-url].\n\n### Maintainer steps to add a new language\n\n1. To be compatible with Home Assistant, language tags have to follow [BCP 47](https://www.rfc-editor.org/info/bcp47). A list of most language tags can be found here: [IANA subtag registry](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). Examples: `fr`, `fr-CA`, `zh-Hans`.\n2. Create a new file `{language_code}.json` with your language code in the [translation folder](https://github.com/piitaya/lovelace-mushroom/tree/main/src/translations). Examples: `fr.json`.\n3. Import your file into the [`localize.ts file`](https://github.com/piitaya/lovelace-mushroom/blob/main/src/localize.ts) and add your language in the `languages` record.\n4. Don't forget to test locally with the development server by choosing the language with the Home Assistant UI in your profile.\n\n## Troubleshooting\n\n### I don't see the last changes\n\n1. Check that your Home Assistant version is the latest. Some new Mushroom features can only be visible for the latest Home Assistant version.\n2. Check that you have the latest Mushroom version on HACS\n3. Check that you have the latest Mushroom version by checking the browser console\n4. Clear your cache :\n   - delete mushroom resources (https://my.home-assistant.io/redirect/lovelace_resources/)\n   - uninstall Mushroom from HACS\n   - reinstall Mushroom from HACS\n\n### My card mod configuration doesn't work.\n\nHelp about card mod configuration is not provided in this repository. More info in the [state of card mod support](https://github.com/piitaya/lovelace-mushroom/issues/1366).\n\n## Credits\n\nThe design is inspired by [7ahang’s work][7ahang] on Behance and [Ui Lovelace Minimalist][ui-lovelace-minimalist].\n\n\u003c!-- Badges --\u003e\n\n[hacs-url]: https://github.com/hacs/integration\n[hacs-badge]: https://img.shields.io/badge/hacs-default-orange.svg?style=flat-square\n[release-badge]: https://img.shields.io/github/v/release/piitaya/lovelace-mushroom?style=flat-square\n[downloads-badge]: https://img.shields.io/github/downloads/piitaya/lovelace-mushroom/total?style=flat-square\n[build-badge]: https://img.shields.io/github/actions/workflow/status/piitaya/lovelace-mushroom/build.yml?branch=main\u0026style=flat-square\n[translations-badge]: https://hosted.weblate.org/widget/mushroom/svg-badge.svg\n\n\u003c!-- References --\u003e\n\n[home-assistant]: https://www.home-assistant.io/\n[home-assitant-theme-docs]: https://www.home-assistant.io/integrations/frontend/#defining-themes\n[hacs]: https://hacs.xyz\n[ui-lovelace-minimalist]: https://ui-lovelace-minimalist.github.io/UI/\n[button-card]: https://github.com/custom-cards/button-card\n[7ahang]: https://www.behance.net/gallery/88433905/Redesign-Smart-Home\n[release-url]: https://github.com/piitaya/lovelace-mushroom/releases\n[weblate-url]: https://hosted.weblate.org/engage/mushroom/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiitaya%2Flovelace-mushroom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiitaya%2Flovelace-mushroom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiitaya%2Flovelace-mushroom/lists"}