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.

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

add docs for custom_javascript_files #910

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions source/reference/files/ondemand-d-ymls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,27 @@ Configuration Properties with profile support

custom_css_files: ["/myfolder/navigation.css", "/myfolder/pinned_apps.css"]

.. describe:: custom_javascript_files (Array<String>, [])

List of relative URLs to custom javascript files to include in all Dashboard pages.
These javascript files can be used to customize the behavior of the Dashboard.

The relative path will be prefixed with the value of the ``public_url`` property.

Default
Empty list, no custom javascript files will be included.

.. code-block:: yaml

custom_javascript_files: []

Example
Add two custom Javascript files: ``/myfolder/navigation.js`` and ``/myfolder/pinned_apps.js`` to the Dashboard.

.. code-block:: yaml

custom_javascript_files: ["/myfolder/navigation.js", "/myfolder/pinned_apps.js"]

.. describe:: dashboard_title (String, 'Open OnDemand')

The text to use as the main navigation logo. If the ``dashboard_header_img_logo`` property is defined,
Expand Down