diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 87179cc..30950b5 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1 +1 @@
-github: [maykar]
+github: [myztillx]
diff --git a/README.md b/README.md
index 9640704..707b1bb 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,45 @@
# kiosk-mode
-[](https://github.com/custom-components/hacs) [](https://www.buymeacoffee.com/FgwNR2l)
+[](https://github.com/custom-components/hacs)
Hides the header and/or sidebar drawer in [Home Assistant](https://www.home-assistant.io/)
-# Installation
+## Installation
-*If you previously used [custom-header](https://github.com/maykar/custom-header) you need to uninstall it from [HACS](https://hacs.xyz/)*
+*If you previously used [custom-header](https://github.com/maykar/custom-header) you need to uninstall it from [HACS](https://hacs.xyz/)*
**Follow only one of two installation methods below, HACS or Manually:**
- Installation and tracking with HACS
-
+ Installation and Tracking with HACS
-* In the "Frontend" section of [HACS](https://github.com/hacs/integration) 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
+* In the "Frontend" section of [HACS](https://github.com/hacs/integration) hit the overflow menu and select "Custom Repositories".
+* Add ```https://github.com/myztillx/kiosk-mode``` as category Lovelace.
+* Hit the plus icon in the bottom right.
+* Search for `Kiosk Mode` and install it (make sure to choose the one from @myztillx)
+* 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](https://www.home-assistant.io/lovelace/dashboards-and-views/#adding-more-dashboards-with-yaml) file.
-Non-YAML mode, or Storage Mode, users can find resources in their sidebar under `"Configuration" > "Lovelace Dashboards" > "Resources"`
+YAML mode users will add it to their [configuration.yaml](https://www.home-assistant.io/dashboards/dashboards/) file.
+Non-YAML mode, or Storage Mode, users can find resources in their sidebar under `"Settings" > "Dashboards" > "Overflow Menu" > "Resources"`
```yaml
resources:
- url: /hacsfiles/kiosk-mode/kiosk-mode.js
type: module
```
-
+
- Manual installation
-
-
-* Download [kiosk-mode.js](https://github.com/matt8707/kiosk-mode/releases/latest) from the latest release and place it in your `www` folder
+ Manual Installation
+
+* Download [kiosk-mode.js](https://github.com/myztillx/kiosk-mode/releases/latest) from the latest release and place it in your `www` folder.
* Add the resource below
-YAML mode users add it to their [configuration.yaml](https://www.home-assistant.io/lovelace/dashboards-and-views/#adding-more-dashboards-with-yaml) file.
-Non-YAML mode, or Storage Mode, users can find resources in their sidebar under `"Configuration" > "Lovelace Dashboards" > "Resources"`
+YAML mode users add it to their [configuration.yaml](https://www.home-assistant.io/dashboards/dashboards/) file.
+Non-YAML mode, or Storage Mode, users can find resources in their sidebar under `"Settings" > "Dashboards" > "Overflow Menu" > "Resources"`
```yaml
resources:
@@ -47,7 +47,7 @@ resources:
- url: /local/kiosk-mode.js?v=1.2.1
type: module
```
-
+
*If you have trouble installing please [read this guide](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins)*
@@ -55,7 +55,7 @@ resources:
## 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.
+* Config is placed in the root of your Lovelace config: `kiosk_mode:` should not be indented and 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.
@@ -65,54 +65,62 @@ resources:
|:---------------|:---------------|:---------------|:----------|
|`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_sidebar:` | Boolean | false | Hides the sidebar, search, and overflow menu. 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.
|`ignore_entity_settings:` | Boolean | false | Useful for [conditional configs](#conditional-lovelace-config) and will cause `entity_settings` to be ignored.
|`ignore_mobile_settings:` | Boolean | false | Useful for [conditional configs](#conditional-lovelace-config) and will cause `mobile_settings` to be ignored.
## Simple config example
-```
+```yaml
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*
+
+*Note: `views:` is added in the example above to show where `kiosk_mode:` should be placed in your Lovelace config*
## 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:
+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 ).*
+### 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 ).*
+
+```yaml
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 ).*
+### 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 ).*
+
+```yaml
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 ).*
+### 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 ).*
+
+```yaml
kiosk_mode:
user_settings:
- users:
@@ -124,27 +132,30 @@ kiosk_mode:
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`.*
+### `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`.*
+
+```yaml
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`.*
+### 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).*
-```
+
+```yaml
kiosk_mode:
entity_settings:
- entity:
@@ -158,7 +169,7 @@ kiosk_mode:
kiosk: true
```
-```
+```yaml
kiosk_mode:
entity_settings:
# hide_sidebar has both true and false conditions to be a true override.
@@ -169,44 +180,49 @@ kiosk_mode:
input_boolean.hide_sidebar: 'off'
hide_sidebar: false
```
-
## Query Strings
+
Add a query string such as `?kiosk` to the end of your URL:
-```
+```http
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
+* `?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.
## 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.
+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.
-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
-
### Related
-* [Fully Kiosk Browser](https://www.fully-kiosk.com/) - Great for wall mounted tablets
-* [Applicationize](https://applicationize.me/) - Convert web apps into desktop apps
-* [KTibow/fullscreen-card](https://github.com/KTibow/fullscreen-card) - Make your Home Assistant browser fullscreen
-
+* [Fully Kiosk Browser](https://www.fully-kiosk.com/) - Great for wall mounted tablets.
+* [Browser Mod v2](https://github.com/thomasloven/hass-browser_mod) - Allows the setting of dashboards to specific users. This can also do a lot of the same things that Kiosk Mode can.
### Credit
+
+This was forked from [maykar](https://github.com/maykar) and the below are his credits.
+
This was originally based on and inspired by [ciotlosm's kiosk mode gist](https://gist.github.com/ciotlosm/1f09b330aa5bd5ea87b59f33609cc931) and [corrafig's fork](https://gist.github.com/corrafig/c8288df960e7f59e82c12d14de26fde8) of the same gist.
Big thank you to [matt8707](https://github.com/matt8707) for starting this project, allowing me to rewrite it, and transfering ownership.
diff --git a/hacs.json b/hacs.json
index 3f31427..0eceb16 100644
--- a/hacs.json
+++ b/hacs.json
@@ -1,4 +1,5 @@
{
"name": "Kiosk Mode",
- "render_readme": true
+ "render_readme": true,
+ "filename": "kiosk-mode.js"
}
\ No newline at end of file