Update panel_custom component configuration (#7423)

This commit is contained in:
Klaas Schoute 2018-11-08 09:08:11 +01:00 committed by Fabian Affolter
parent 411266e470
commit 699d9af012

View File

@ -33,15 +33,48 @@ panel_custom:
Store your custom panels in `<config>/www` to make them available in the frontend at the path `/local`.
</p>
Configuration variables:
- **name** (*Required*): Name of the web component that renders your panel.
- **sidebar_title** (*Optional*): Friendly title for the panel in the sidebar. Omitting it means no sidebar entry (but still accessible through the URL).
- **sidebar_icon** (*Optional*): Icon for entry. Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
- **url_path** (*Optional*): The URL your panel will be available on in the frontend. If omitted will default to the panel name.
- **js_url** (*Required*): The URL that contains the JavaScript of your panel. This is exclusive to `module_url` and `webcomponent_path`.
- **module_url** (*Optional*): The URL that contains the JavaScript module of your panel. Loaded as a JavaScript module instead of a script. This is exclusive to `js_url` and `webcomponent_path`.
- **config** (*Optional*): Configuration to be passed into your web component when being instantiated.
- **embed_iframe** (*Optional*): Set to `true` to embed panel in iframe. This is necessary if the panel is using the React framework or if it contains conflicting web components.
- **trust_external_script** (*Optional*): By default the user has to confirm before loading a script from an external source. Setting this to `true` will omit this confirmation.
- **webcomponent_path** (*Optional* *DEPRECATED*): The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html` This is exclusive to `js_url` and `module_url`.
{% configuration %}
name:
description: Name of the web component that renders your panel.
required: true
type: string
sidebar_title:
description: Friendly title for the panel in the sidebar. Omitting it means no sidebar entry (but still accessible through the URL).
required: false
type: string
sidebar_icon:
description: Icon for entry. Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
required: false
default: "mdi:bookmark"
type: icon
url_path:
description: The URL your panel will be available on in the frontend. If omitted will default to the panel name.
required: false
type: string
js_url:
description: The URL that contains the JavaScript of your panel. This is exclusive to `module_url` and `webcomponent_path`.
required: exclusive
type: string
module_url:
description: The URL that contains the JavaScript module of your panel. Loaded as a JavaScript module instead of a script. This is exclusive to `js_url` and `webcomponent_path`.
required: exclusive
type: string
config:
description: Configuration to be passed into your web component when being instantiated.
required: false
type: list
embed_iframe:
description: Set to `true` to embed panel in iframe. This is necessary if the panel is using the React framework or if it contains conflicting web components.
required: false
default: false
type: boolean
trust_external_script:
description: By default the user has to confirm before loading a script from an external source. Setting this to `true` will omit this confirmation.
required: false
default: false
type: boolean
webcomponent_path:
description: The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html` This is exclusive to `js_url` and `module_url`.
required: exclusive *DEPRECATED*
type: string
{% endconfiguration %}