kiosk-mode

Hides the header and/or sidebar drawer in Home Assistant lovelace dashboards.

Installation

Follow only one of two installation methods below, HACS or Manually:

If you want to learn how to install and set some basic configurations in kiosk-mode through a video, check the next one from @smarthomejunkie.

Installation through HACS

In the "Frontend" section of HACS hit the plus icon in the bottom right
Search for Kiosk Mode and install it
If using YAML mode or if HACS doesn't automatically add it, you'll need to add the resource manually:

Go to your configuration.yaml file and add the url of the plugin as an extra_module_url:

# You should update the version number at the end of the url
# after every update to avoid the old version being cached by Home Assistant
frontend:
  extra_module_url:
    - /hacsfiles/kiosk-mode/kiosk-mode.js?v1.0.0

Manual installation

Download kiosk-mode.js from the latest release and place it in your www folder
Add the resource:

If you are in storage mode (default mode)

Go to Settings > Dashboards
Click on the three dots located on the top-right corner and then click on Resources
Click on ADD RESOURCE on the bottom-right of the screen
Add the URL to the file that you have downloaded previously (e.g /local/kiosk-mode.js?v=1.0.0)
Make sure you add the correct version at the end of the URL (e.g. ?v=1.0.0) because in this way you make Home Assistant to load the new version instead of a version stored in cache

If you are in yaml mode

Go to your configuration.yaml file and add the url of the plugin as an extra_module_url:

# You should update the version number at the end of the url
# after every update to avoid the old version being cached by Home Assistant
frontend:
  extra_module_url:
    - /hacsfiles/kiosk-mode/kiosk-mode.js?v1.0.0

If you have trouble installing please read this guide

Important Info

Since Home Assistant 2023.12.0 it is possible to access the raw config of a "Default dashboard" controlled by Home Assistant. It is important to remark that any configuration that you add to these kinds of dashboards will be ignored so kiosk-mode will not be able to read it. You need to create a "New dashboard from scratch" controlled by you to make it work with kiosk-mode.
If you need to disable Kiosk-Mode temporarily add ?disable_km to the end of your URL.
Config is placed in the root of your Lovelace config: kiosk_mode: should not be indented & is per dashboard.
If you want the same settings on other dashboards you'll need to repeat the config on those dashboards as well.
Refresh page after config changes.

Simple config example

YAML mode users need to add the configuration manually to the lovelace dashboard file in which they want to enable kiosk-mode. Non-YAML users (Storage Mode) need to add the configuration to each lovelace panel going to Edit dashboard option (pencil icon on the top-right of the screen). Once in Edit Dashboard mode, click on the top-right three-dots button and select Raw configuration editor.

kiosk_mode:
  hide_header: true
  
views:

Note: views: is added in the example above to show where kiosk_mode: should be placed in your Lovelace config

Config Options

Config Option	Type	Default	Description
`kiosk`	Boolean	false	Hides both the header and sidebar.
`hide_header`¹	Boolean	false	Hides only the header.
`hide_sidebar`	Boolean	false	Hides only the sidebar.
`hide_menubutton`¹	Boolean	false	Hides only the sidebar menu icon.
`hide_notifications`	Boolean	false	Hide the notifications entry-point.
`hide_account`	Boolean	false	Hides the account icon.
`hide_search`	Boolean	false	Hides the search icon.
`hide_assistant`	Boolean	false	Hides the assistant icon.
`hide_overflow`	Boolean	false	Hides the top right overflow menu.
`block_overflow`	Boolean	false	Blocks the top right overflow menu mouse interactions.
`hide_refresh`	Boolean	false	Hides the "Refresh" button inside the top right overflow menu in lovelace yaml mode.
`hide_unused_entities`	Boolean	false	Hides the "Unused entities" button inside the top right overflow menu in lovelace yaml mode.
`hide_reload_resources`	Boolean	false	Hides the "Reload resources" button inside the top right overflow menu in lovelace yaml mode.
`hide_edit_dashboard`	Boolean	false	Hides the "Edit dashboard" button inside the top right overflow menu.
`block_mouse`	Boolean	false	Blocks completely the mouse. No interaction is allowed and the mouse will not be visible. Can only be disabled with `?disable_km` query parameter in the URL..
`block_context_menu`	Boolean	false	Prevents opening a right-click context menu (sometimes accessible via tap-and-hold on touchscreen devices).
`hide_dialog_header_history`	Boolean	false	Hides the "History" icon in the header of more-info dialogs.
`hide_dialog_header_settings`²	Boolean	false	Hides the "Settings" icon in the header of more-info dialogs.
`hide_dialog_header_overflow`²	Boolean	false	Hides the top right overflow menu in the header of more-info dialogs.
`hide_dialog_header_action_items`	Boolean	false	Hides all the action items from the header of more-info dialogs.
`hide_dialog_history`	Boolean	false	Hides the "History" section in the more-info dialogs.
`hide_dialog_history_show_more`	Boolean	false	Hides the "Show more" link in the "History" section of more-info dialogs.
`hide_dialog_logbook`	Boolean	false	Hides the "Logbook" section in the more-info dialogs.
`hide_dialog_logbook_show_more`	Boolean	false	Hides the "Show more" link in the "Logbook" section of more-info dialogs.
`hide_dialog_attributes`	Boolean	false	Hides the "Attributes" section in the more-info dialogs.
`hide_dialog_media_actions`	Boolean	false	Hides the actions block in the more-info dialogs of media-player entities.
`hide_dialog_update_actions`	Boolean	false	Hides the actions block in the more-info dialogs of update entities.
`hide_dialog_timer_actions`	Boolean	false	Hides the actions block in the more-info dialogs of timer entities.
`hide_dialog_climate_actions`	Boolean	false	Hides all the actions in the more-info dialogs of climate entities.
`hide_dialog_climate_temperature_actions`	Boolean	false	Hides the temperature cotrol actions in the more-info dialogs of climate entities.
`hide_dialog_climate_settings_actions`	Boolean	false	Hides the mode and preset actions in the more-info dialogs of climate entities.
`hide_dialog_light_actions`	Boolean	false	Hides all the actions in the more-info dialogs of light entities.
`hide_dialog_light_control_actions`	Boolean	false	Hides the control actions in the more-info dialogs of light entities.
`hide_dialog_light_color_actions`	Boolean	false	Hides the favorite colors actions in the more-info dialogs of light entities.
`hide_dialog_light_settings_actions`	Boolean	false	Hides the settings actions in the more-info dialogs of light entities.
`ignore_entity_settings`³	Boolean	false	Useful for conditional configs and will cause `entity_settings` to be ignored.
`ignore_mobile_settings`⁴	Boolean	false	Useful for conditional configs and will cause `mobile_settings` to be ignored.
`ignore_disable_km`³	Boolean	false	Useful for conditional configs and will cause `disable_km` URL parameter to be ignored.

¹ Take into account that swipe gesture to open the sidebar was removed from Home Assistant in version 2023.4, if you hide the header or the sidebar menu icon, you will not have any way to access the sidebar natively in a browser.

² These elements are not visible by default if the account is not an admin account.

³ These options only work if they are placed inside admin_settings, non_admin_settings, user_settings or mobile_settings. They will not have any effect if they are placed inside entity_settings

⁴ This option only works if it is placed inside admin_settings, non_admin_settings or user_settings. It will not have any effect if it is placed inside mobile_settings or entity_settings

Options through screenshots

Lovelace dashboard

Options	Hides / Blocks
`kiosk`	1 and 2
`hide_header`	1
`hide_sidebar`	2
`hide_menubutton`	3
`hide_notifications`	4
`hide_account`	5
`hide_search`	6
`hide_assistant`	7
`hide_overflow`	8
`block_overflow`	8
`block_mouse`	whole interface
`block_context_menu`	right click anywhere

Overflow menu

Options	Hides
`hide_refresh`	9
`hide_unused_entities`	10
`hide_reload_resources`	11
`hide_edit_dashboard`	12

More info dialog (media entity)

Options	Hides
`hide_dialog_header_action_items`	13
`hide_dialog_header_history`	14
`hide_dialog_header_settings`	15
`hide_dialog_header_overflow`	16
`hide_dialog_media_actions`	17

More info dialog (climate entity)

Options	Hides
`hide_dialog_climate_actions`	18
`hide_dialog_climate_temperature_actions`	19
`hide_dialog_climate_settings_actions`	20

More info dialog (light entity)

Options	Hides
`hide_dialog_light_actions`	21
`hide_dialog_light_control_actions`	22
`hide_dialog_light_color_actions`	23
`hide_dialog_light_settings_actions`	24

More info dialog (update entity / timer entity)

Options	Hides
`hide_dialog_update_actions`	25
`hide_dialog_timer_actions`	25

More info dialog (sensor entity)

Options	Hides
`hide_dialog_history`	26
`hide_dialog_logbook`	27
`hide_dialog_attributes`	28
`hide_dialog_history_show_more`	29
`hide_dialog_logbook_show_more`	30

Conditional Lovelace Config

Contitional configs take priority and if a condition matches all other config options/methods are ignored. These use the same options as above, but placed under one of the following user/entity conditions:

admin_settings:

Sets the config for every admin user.
Overwritten by user_settings, mobile_settings, and entity_settings ( unless one of the ignore options is used ).

kiosk_mode:
  admin_settings:
    hide_header: true

non_admin_settings:

Sets the config for every regular user.
Overwritten by user_settings, mobile_settings, and entity_settings ( unless one of the ignore options is used ).

kiosk_mode:
  non_admin_settings:
    hide_header: true
    ignore_entity_settings: true

user_settings:

Sets the config for specific users. This uses a user's name, not their username (if they're different).
Overwritten by mobile_settings, and entity_settings ( unless one of the ignore options is used ).

kiosk_mode:
  user_settings:
    - users:
        - "ryan meek"
        - "maykar"
      hide_sidebar: true
    - users:
        - "the wife"
      kiosk: true
      ignore_entity_settings: true

mobile_settings:

Sets the config for mobile devices. The default breakpoint is 812px, which can be changed by setting the custom_width option.
Overwritten by entity_settings, unless ignore_entity_settings is used, can be ignored with ignore_mobile_settings.

kiosk_mode:
  mobile_settings:
    hide_header: true
    ignore_entity_settings: true
    custom_width: 768

entity_settings:

Dynamically change config on any entity's state. Under entity: list the entity followed by the state that will enable the config below. For more complex logic use this with a template sensor.
Takes priority over all other config settings unless they use ignore_entity_settings.

Any condition that doesn't match will then fall back to previous configurations if another "false" entity condition hasn't also been set (see the 2nd example).

kiosk_mode:
  entity_settings:
    - entity:
        input_boolean.hide_sidebar: 'on'
      hide_sidebar: true
    - entity:
        sensor.hide_header: 'on'
      hide_header: true
    - entity:
        input_text.kiosk: 'true'
      kiosk: true

kiosk_mode:
  entity_settings:
    # hide_sidebar has both true and false conditions to be a true override.
    - entity:
        input_boolean.hide_sidebar: 'on'
      hide_sidebar: true
    - entity:
        input_boolean.hide_sidebar: 'off'
      hide_sidebar: false

Query Strings

Add a query string such as ?kiosk to the end of your URL:

https://hass:8123/lovelace/default_view?kiosk

If you need to add multiple query parameters, you need to separate them by & (only the first parameter should be prepended by ?):

https://hass:8123/lovelace/default_view?hide_header&hide_sidebar

The query string options are:

?kiosk to hide both header and sidebar
?hide_header to hide only the header
?hide_sidebar to hide only the sidebar
?hide_menubutton to hide sidebar menu button
?hide_notifications to hide the notifications entry-point
?hide_account to hide the account icon
?hide_search to hide the search icon
?hide_assistant to hide the assistant icon
?hide_overflow to hide the top right menu
?block_overflow to block the top right overflow menu mouse interactions
?hide_refresh to hide the "Refresh" button inside the top right menu in lovelace yaml mode
?hide_unused_entities to hide the "Unused entities" button inside the top right menu in lovelace yaml mode
?hide_reload_resources to hide the "Reload resources" button inside the top right menu in lovelace yaml mode
?hide_edit_dashboard to hide the "Edit dashboard" button inside the top right menu
?block_mouse to block completely the mouse
?block_context_menu to prevent opening a right-click context menu
?hide_dialog_header_history to hide the "History" icon in the header of more-info dialogs
?hide_dialog_header_settings to hide the "Settings" icon in the header of more-info dialogs
?hide_dialog_header_overflow to hide the top right overflow menu in the header of more-info dialogs
?hide_dialog_header_action_items to hide all the action items from the header of more-info dialogs.
?hide_dialog_history to hide the "History" section in the more-info dialogs
?hide_dialog_history_show_more to hide the "Show more" link in the "History" section of more-info dialogs
?hide_dialog_logbook to hide the "Logbook" section in the more-info dialogs
?hide_dialog_logbook_show_more to hide the "Show more" link in the "Logbook" section of more-info dialogs
?hide_dialog_attributes to hide the "Attributes" section in the more-info dialogs
?hide_dialog_media_actions to hide the actions block in the more-info dialogs of media-player entities
?hide_dialog_update_actions to hide the actions block in the more-info dialogs of update entities
?hide_dialog_timer_actions to hide the actions block in the more-info dialogs of timer entities
?hide_dialog_climate_actions to hide all the actions in the more-info dialogs of climate entities
?hide_dialog_climate_temperature_actions to hide the temperature cotrol actions in the more-info dialogs of climate entities
?hide_dialog_climate_settings_actions to hide the mode and preset actions in the more-info dialogs of climate entities
?hide_dialog_light_actions to hide all the actions in the more-info dialogs of light entities
?hide_dialog_light_control_actions to hide the control actions in the more-info dialogs of light entities
?hide_dialog_light_color_actions to hide the favorite colors actions in the more-info dialogs of light entities
?hide_dialog_light_settings_actions to hide the settings actions in the more-info dialogs of light entities

Query String Caching

You save settings in a devices cache by using the cache keyword once on the device.
This will also make it so the options work on all views and dashboards.

Example: ?hide_header&cache makes all views & dashboards hide the header.
This works for all query strings except for the utility strings listed below.

Utility Query Strings

?clear_km_cache will clear all cached preferences
?disable_km will temporarily disable any modifications (unless ignore_disable_km has been used in one of the conditional configs)

Kiosk-mode demo

Make sure you have git installed
Make sure you have pnpm installed
Make sure you have Docker installed (Docker Desktop is a quick option)
Clone the repository git clone https://github.com/NemesisRE/kiosk-mode.git (or download it in a zip file)
Run Docker Desktop so you get docker daemon running
Enter in the repository folder
Run pnpm install
Run pnpm demo (pnpm demo:win on Windows environments)
Open http://localhost:8123/

Kiosk-mode complements

Some features are outside kiosk-mode scope and they would be hard to maintain and escalate over time, but they could be achieved by alternative methods. Check kiosk-mode complements for this.

Credit

This was originally based on and inspired by ciotlosm's kiosk mode gist and corrafig's fork of the same gist.

Big thank you to matt8707 for starting this project, allowing me to rewrite it, and transfering ownership.

Many thanks to KTibow as well, for the github release action and support.

And another big thanks to maykar for the original kiosk mode

Name		Name	Last commit message	Last commit date
Latest commit History 603 Commits
.github		.github
.hass/config		.hass/config
images		images
src		src
test-snapshots		test-snapshots
tests		tests
.gitignore		.gitignore
AUTHORS		AUTHORS
KIOSK-MODE-COMPLEMENTS.md		KIOSK-MODE-COMPLEMENTS.md
LICENSE		LICENSE
README.md		README.md
eslint.config.js		eslint.config.js
example.png		example.png
hacs.json		hacs.json
package.json		package.json
playwright.config.ts		playwright.config.ts
pnpm-lock.yaml		pnpm-lock.yaml
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

kiosk-mode

Installation

If you are in storage mode (default mode)

If you are in yaml mode

Important Info

Simple config example

Config Options

Options through screenshots

Conditional Lovelace Config

admin_settings:

non_admin_settings:

user_settings:

mobile_settings:

entity_settings:

Query Strings

Query String Caching

Kiosk-mode demo

Kiosk-mode complements

Related

Credit

About

Releases 38

Sponsor this project

Packages

Contributors 16

Languages

License

NemesisRE/kiosk-mode

Folders and files

Latest commit

History

Repository files navigation

kiosk-mode

Installation

If you are in storage mode (default mode)

If you are in yaml mode

Important Info

Simple config example

Config Options

Options through screenshots

Conditional Lovelace Config

admin_settings:

non_admin_settings:

user_settings:

mobile_settings:

entity_settings:

Query Strings

Query String Caching

Kiosk-mode demo

Kiosk-mode complements

Related

Credit

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 38

Sponsor this project

Packages 0

Contributors 16

Languages

Packages