Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate extra_module_url in frontend #13997

Merged
merged 2 commits into from
Jul 14, 2020
Merged

Deprecate extra_module_url in frontend #13997

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d209f4c
Deprecate extra_module_url
bramkragten Jul 14, 2020
5afb605
Update frontend.markdown
bramkragten Jul 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions source/_integrations/frontend.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ frontend:
required: true
type: [list, string]
extra_html_url:
description: "List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `latest` javascript mode."
description: "DEPRECATED List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `latest` javascript mode."
required: false
type: list
extra_module_url:
description: "List of additional javascript modules to load."
description: "List of additional javascript modules to load in `latest` javascript mode."
required: false
type: list
extra_js_url_es5:
Expand Down Expand Up @@ -120,23 +120,25 @@ When themes are enabled in the `configuration.yaml` file, a new option will show
Set a theme
</p>

## Loading extra HTML
## Loading extra JavaScript

Starting with version 0.53 you can specify extra HTML files to load, and starting with version 0.95 extra JS modules.
Starting with version 0.95 you can load extra custom JavaScript.

Example:

```yaml
# Example configuration.yaml entry
frontend:
extra_html_url:
- https://example.com/file1.html
- /local/file2.html
extra_module_url:
- /local/my_module.js
extra_js_url_es5:
- /local/my_es5.js
```

HTML will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on any page (states and panels), and modules via `<script type='module' scr='{{ extra_module }}'></script>`.
Modules will be loaded with `import({{ extra_module }})`, on devices that support it (`latest` mode).
For other devices (`es5` mode) you can use `extra_js_url_es5`, this will be loaded with `<script defer src='{{ extra_module }}'></script>`

The ES5 and module version will never both be loaded, depending on if the device supports `import` the module of ES5 version will be loaded.

### Manual Language Selection

Expand Down