Skip to content

Latest commit

 

History

History
191 lines (132 loc) · 7.6 KB

README.md

File metadata and controls

191 lines (132 loc) · 7.6 KB
Raw

🍄 Mushroom

hacs release downloads build translations

Buy Me A Coffee

Overview

What is mushroom ?

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.

Features

  • 🛠 Editor for all cards and and all options (no need to edit yaml)
  • 😍 Icon picker
  • 🖌 Color picker
  • 🚀 0 dependencies : no need to install another card.
  • 🌈 Based on Material UI colors
  • 🌓 Light and dark theme support
  • 🎨 Optional theme customization
  • 🌎 Internationalization

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.

Installation

HACS

Mushroom is available in HACS (Home Assistant Community Store).

Use this link to directly go to the repository in HACS

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

or

  1. Install HACS if you don't have it already
  2. Open HACS in Home Assistant
  3. Search for "Mushroom"
  4. Click the download button. ⬇️

Manual

  1. Download mushroom.js file from the latest release.
  2. Put mushroom.js file into your config/www folder.
  3. Add reference to mushroom.js in Dashboard. There's two way to do that:
    • Using UI: Settings → Dashboards → More Options icon → Resources → Add Resource → Set Url as /local/mushroom.js → Set Resource type as JavaScript Module. Note: If you do not see the Resources menu, you will need to enable Advanced Mode in your User Profile
    • Using YAML: Add following code to lovelace section. 
      resources:
    - url: /local/mushroom.js
      type: module

Usage

All the Mushroom cards can be configured using Dashboard UI editor.

  1. In Dashboard UI, click 3 dots in top right corner.
  2. Click Edit Dashboard.
  3. Click Plus button to add a new card.
  4. Find one of the Custom: Mushroom card in the list.

Cards

Different cards are available for differents entities :

Badges

A template badge is available if you're using at least Home Assistant 2024.8.

Theme customization

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.

Development server

Home assistant demo

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.

Windows Users

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

Development

In another terminal, install dependencies and run development server:

npm install
npm start

Server will start on port 4000.

Build

You can build the mushroom.js file in dist folder by running the build command.

npm run build

Translations

If you want to help translating Mushroom, you can translate it directly from your browser using Weblate.

Maintainer steps to add a new language

  1. To be compatible with Home Assistant, language tags have to follow BCP 47. A list of most language tags can be found here: IANA subtag registry. Examples: fr, fr-CA, zh-Hans.
  2. Create a new file {language_code}.json with your language code in the translation folder. Examples: fr.json.
  3. Import your file into the localize.ts file and add your language in the languages record.
  4. Don't forget to test locally with the development server by choosing the language with the Home Assistant UI in your profile.

Troubleshooting

I don't see the last changes

  1. Check that your Home Assistant version is the latest. Some new Mushroom features can only be visible for the latest Home Assistant version.
  2. Check that you have the latest Mushroom version on HACS
  3. Check that you have the latest Mushroom version by checking the browser console
  4. Clear your cache :

My card mod configuration doesn't work.

Help about card mod configuration is not provided in this repository. More info in the state of card mod support.

Credits

The design is inspired by 7ahang’s work on Behance and Ui Lovelace Minimalist.