Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 78cf4b9.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Nov 20, 2024
1 parent 8f260ce commit 28911bf
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 1 deletion.
11 changes: 11 additions & 0 deletions develop/_sources/how-tos/app-development/interactive/form.rst.txt
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 develop/_sources/release-notes/v4.0-release-notes.rst.txt
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
10 changes: 10 additions & 0 deletions develop/how-tos/app-development/interactive/form.html
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,16 @@
My App</em> from the list of sandbox apps.</p>
<p>You should now see the HTML form used to gather the user-defined attributes for
building and launching the <code class="docutils literal notranslate"><span class="pre">my_app</span></code> Interactive App session.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Since 4.0 HTML IDs of the form items are always lowercase. The examples above
show lowercase configurations of <code class="docutils literal notranslate"><span class="pre">account</span></code>. Specifying <code class="docutils literal notranslate"><span class="pre">Account</span></code>,
or <code class="docutils literal notranslate"><span class="pre">ACCOUNT</span></code> or any variation of uppercase and lowercase will result in
the same behhavior as specifying <code class="docutils literal notranslate"><span class="pre">account</span></code> (all lower case).</p>
<p>If you write your own <code class="docutils literal notranslate"><span class="pre">form.js</span></code> take care to note that HTML IDs of these
form items will <strong>always</strong> be lowercase regardless of how they’re defined in
the YAML file.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can include dynamically generated content in the form by renaming the
Expand Down
18 changes: 18 additions & 0 deletions develop/release-notes/v4.0-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,24 @@ <h4>Announcements are dismissable by default.<a class="headerlink" href="#announ
themselves are <code class="docutils literal notranslate"><span class="pre">dismissable</span></code> by default.</p>
<p>The documentation for <a class="reference internal" href="../customizations.html#configure-announcements"><span class="std std-ref">Announcements</span></a> has been updated with this new feature.</p>
</div>
<div class="section" id="batch-connect-form-ids-are-now-lowercase">
<h4>Batch connect form ids are now lowercase.<a class="headerlink" href="#batch-connect-form-ids-are-now-lowercase" title="Permalink to this headline"></a></h4>
<p>To resolve some bugs with <a class="reference internal" href="../how-tos/app-development/interactive/dynamic-form-widgets.html#dynamic-bc-apps"><span class="std std-ref">Dynamic Form Widgets</span></a>, 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.</p>
<p>This is an example of defining a form item with uppercase keys like <code class="docutils literal notranslate"><span class="pre">My_Cool_Form_Item</span></code>.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
<span class="nt">form</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">My_Cool_Form_Item</span><span class="w"></span>
</pre></div>
</div>
<p>In this example <code class="docutils literal notranslate"><span class="pre">My_Cool_Form_Item</span></code> has uppercase characters, however the HTML
id of the form item will be lowercase as shown below.</p>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span>id=&quot;batch_connect_session_context_my_cool_form_item&quot;
</pre></div>
</div>
</div>
</div>
<div class="section" id="dependency-updates">
<h3>Dependency updates<a class="headerlink" href="#dependency-updates" title="Permalink to this headline"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 28911bf

Please sign in to comment.