panel_custom docs update (#13674)

This commit is contained in:
Paulus Schoutsen 2020-06-08 06:21:19 -07:00 committed by GitHub
parent 50221f6d54
commit 5db9407ab1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,7 +21,7 @@ panel_custom:
sidebar_title: TodoMVC
sidebar_icon: mdi:work
url_path: my-todomvc
js_url: /local/my-panel.js
module_url: /local/my-panel.js
config:
who: world
```
@ -51,12 +51,12 @@ url_path:
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
description: The URL that contains the JavaScript of your panel. If used together with `module_url`, will only be served to users that use the ES5 build of the frontend.
required: false
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
description: The URL that contains the JavaScript module of your panel. Loaded as a JavaScript module instead of a script. If used together with `module_url`, will only be served to users that use the "latest" build of the frontend.
required: false
type: string
config:
description: Configuration to be passed into your web component when being instantiated.
@ -78,7 +78,7 @@ trust_external_script:
default: false
type: boolean
webcomponent_path:
description: "*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`."
required: exclusive
description: "*DEPRECATED* The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html` This cannot be used in combination with either `js_url` and `module_url`."
required: false
type: string
{% endconfiguration %}