kiosk-mode

Hides the header and/or sidebar drawer in Home Assistant

Installation

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

Installation and tracking with 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 below

YAML mode users will add it to their configuration.yaml file. Non-YAML mode, or Storage Mode, users can find resources in their sidebar under "Configuration" > "Lovelace Dashboards" > "Resources"

resources:
  - url: /hacsfiles/kiosk-mode/kiosk-mode.js
    type: module

Manual installation

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

YAML mode users add it to their configuration.yaml file. Non-YAML mode, or Storage Mode, users can find resources in their sidebar under "Configuration" > "Lovelace Dashboards" > "Resources"

resources:
  # You'll need to update the version number at the end of the url after every update.
  - url: /local/kiosk-mode.js?v=1.2.1
    type: module

If you have trouble installing please read this guide

Important Info

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 (located in the overflow menu that appears when one clicks on the top-right three-dots button). Once in Edit Dashboard mode, click again 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. Disables swipe to open.
`hide_menubutton:`	Boolean	false	Hides only the sidebar menu icon. Does not disable swipe to open.
`hide_overflow:`	Boolean	false	Hides the top right menu.
`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_edit_dashboard`	Boolean	false	Hides the "Edit dashboard" button inside the top right menu
`hide_refresh`	Boolean	false	Hides the "Refresh" button inside the top right menu in lovelace yaml mode
`hide_unused_entities`	Boolean	false	Hides the "Unused entities" button inside the top right menu in lovelace yaml mode
`hide_reload_resources`	Boolean	false	Hides the "Reload resources" button inside the top right menu in lovelace yaml mode
`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.
`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.

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

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_overflow to hide the top right menu
?hide_menubutton to hide sidebar menu button
?hide_account to hide the account icon
?hide_search to hide the search icon
?hide_assistant to hide the assistant icon
?hide_edit_dashboard to hide the "Edit dashboard" button inside the top right menu
?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 the "Reload resources" button inside the top right menu in lovelace yaml mode
?block_mouse to block completely the mouse

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

Kiosk-mode demo

Make sure you have git installed
Make sure you have yarn 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 yarn
Run yarn demo (yarn demo:win on Windows environments)
Open http://localhost:8123/
Create an account and complete the onboard

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 218 Commits
.github		.github
.hass/config		.hass/config
src		src
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
example.png		example.png
hacs.json		hacs.json
package.json		package.json
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

kiosk-mode

Installation

Important Info

Simple config example

Config Options

Conditional Lovelace Config

admin_settings:

non_admin_settings:

user_settings:

mobile_settings:

entity_settings:

Query Strings

Query String Caching

Kiosk-mode demo

Related

Credit

About

Releases

Packages

Languages

License

agarbato/kiosk-mode

Folders and files

Latest commit

History

Repository files navigation

kiosk-mode

Installation

Important Info

Simple config example

Config Options

Conditional Lovelace Config

admin_settings:

non_admin_settings:

user_settings:

mobile_settings:

entity_settings:

Query Strings

Query String Caching

Kiosk-mode demo

Related

Credit

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages