From 16c9deb95f1f70472c47873971e7552e8412a91a Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 16 Jun 2018 17:29:02 -0400 Subject: [PATCH] Add docs for experimental UI --- docs/frontend_experiment_index.md | 54 +++++++++++++++++++++++++++++++ website/i18n/en.json | 2 ++ website/sidebars.json | 3 ++ 3 files changed, 59 insertions(+) create mode 100644 docs/frontend_experiment_index.md diff --git a/docs/frontend_experiment_index.md b/docs/frontend_experiment_index.md new file mode 100644 index 00000000..7432b7de --- /dev/null +++ b/docs/frontend_experiment_index.md @@ -0,0 +1,54 @@ +--- +title: "Experimental UI" +sidebar_label: Introduction +--- + +Starting with Home Assistant 0.72, we're experimenting with a way of defining your user interface. The aproach is fundamentally different from the current approach. + +The current approach will look at your groups and entities and will sort them on the fly. With our experimental UI, it is purely based on configuration that is provided by the user, defined in `/experimental-ui.yaml`. + +## Trying it out + +Create `/experimental-ui.yaml`: + +```yaml +views: +- cards: + - type: entities + title: Example + entities: + - input_boolean.switch_ac_kitchen + - input_boolean.switch_ac_livingroom + - input_boolean.switch_tv + - type: entity-filter + filter: + domain: input_boolean + state: 'on' + card_config: + title: Input booleans that are on + theme: dark-mode +``` + +Add to your `configuration.yaml`: + +```yaml +input_boolean: + switch_ac_kitchen: + name: AC kitchen + switch_ac_livingroom: + name: AC living room + switch_tv: + name: TV +``` + +Now restart Home Assistant, navigate to `/experimental-ui`. When you make changes to `experimental-ui.yaml`, you don't have to restart Home Assistant or refresh the page. Just hit the refresh button at the top of the UI. + +## Current limitations + +This is the very very early version aimed at gathering feedback. Discussion and suggestions are welcome in the [ui-schema repository](https://github.com/home-assistant/ui-schema). + +## Change log + +**Home Assistant 0.72** + +- Initial release diff --git a/website/i18n/en.json b/website/i18n/en.json index 4921ff9f..e860f800 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -91,6 +91,7 @@ "frontend_creating_custom_ui": "Creating custom UI", "frontend_development": "Frontend development", "Development": "Development", + "frontend_experiment_index": "Experimental UI", "frontend_index": "Home Assistant Frontend", "hassio_addon_communication": "Add-On Communication", "hassio_addon_config": "Add-On Configuration", @@ -127,6 +128,7 @@ "Entity Registry": "Entity Registry", "Extending the frontend": "Extending the frontend", "Custom UI": "Custom UI", + "Experimental UI": "Experimental UI", "Developing a feature": "Developing a feature", "Development 101": "Development 101", "Creating Platforms": "Creating Platforms", diff --git a/website/sidebars.json b/website/sidebars.json index 4f02b948..acc06082 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -55,6 +55,9 @@ "Custom UI": [ "frontend_creating_custom_ui", "frontend_creating_custom_panels" + ], + "Experimental UI": [ + "frontend_experiment_index" ] }, "Extending HASS": {