Build a beautiful Home Assistant dashboard easily
APACHE-2.0 License
Mushroom is a collection of cards for Home Assistant Dashboard UI.
Mushroom mission is to propose easy to use components to build your Home Assistant dashboard.
yaml
)The goal of Mushroom is not to provide custom card for deep customization. You can use the excellent UI Lovelace Minimalist and Button card plugins for this.
Mushroom is available in HACS (Home Assistant Community Store).
Use this link to directly go to the repository in HACS
or
mushroom.js
file from the latest release.mushroom.js
file into your config/www
folder.mushroom.js
in Dashboard. There's two way to do that:
/local/mushroom.js
β Set Resource type as JavaScript Module
.lovelace
section.
resources:
- url: /local/mushroom.js
type: module
All the Mushroom cards can be configured using Dashboard UI editor.
Different cards are available for differents entities :
A template badge is available if you're using at least Home Assistant 2024.8.
Mushroom works without theme but you can add a theme for better experience by installing the Mushroom Themes. If you want more information about themes, check out the official Home Assistant documentation about themes.
You can run a demo instance of Home Assistant with docker by running:
npm run start:hass
Once it's done, go to Home Assistant instance http://localhost:8123 and start configuration.
If you are on Windows, either run the above command in Powershell, or use the below if using Command Prompt:
npm run start:hass-cmd
In another terminal, install dependencies and run development server:
npm install
npm start
Server will start on port 4000
.
You can build the mushroom.js
file in dist
folder by running the build command.
npm run build
fr
, fr-CA
, zh-Hans
.{language_code}.json
with your language code in the translation folder. Examples: fr.json
.localize.ts file
and add your language in the languages
record.Help about card mod configuration is not provided in this repository. More info in the state of card mod support.
The design is inspired by 7ahangβs work on Behance and Ui Lovelace Minimalist.