Skip to content

Commit

Permalink
add RNs on lowercasing bc ids (#1017)
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom authored Nov 20, 2024
1 parent 056eea4 commit 78cf4b9
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
11 changes: 11 additions & 0 deletions source/how-tos/app-development/interactive/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,17 @@ My App* from the list of sandbox apps.
You should now see the HTML form used to gather the user-defined attributes for
building and launching the ``my_app`` Interactive App session.

.. warning::

Since 4.0 HTML IDs of the form items are always lowercase. The examples above
show lowercase configurations of ``account``. Specifying ``Account``,
or ``ACCOUNT`` or any variation of uppercase and lowercase will result in
the same behhavior as specifying ``account`` (all lower case).

If you write your own ``form.js`` take care to note that HTML IDs of these
form items will **always** be lowercase regardless of how they're defined in
the YAML file.

.. tip::

You can include dynamically generated content in the form by renaming the
Expand Down
23 changes: 23 additions & 0 deletions source/release-notes/v4.0-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,29 @@ themselves are ``dismissable`` by default.

The documentation for :ref:`configure_announcements` has been updated with this new feature.

Batch connect form ids are now lowercase.
*****************************************

To resolve some bugs with :ref:`dynamic-bc-apps`, batch connect form
items will now force lowercase HTML IDs. This may break some javascript
at centers expecting the HTML id of the form item to be a mix of uppercase
and lowercase.

This is an example of defining a form item with uppercase keys like ``My_Cool_Form_Item``.

.. code-block:: yaml
---
form:
My_Cool_Form_Item
In this example ``My_Cool_Form_Item`` has uppercase characters, however the HTML
id of the form item will be lowercase as shown below.

.. code-block:: html

id="batch_connect_session_context_my_cool_form_item"

Dependency updates
..................

Expand Down

0 comments on commit 78cf4b9

Please sign in to comment.