Joomla! Issue Tracker | Joomla! CMS #37796 - Implement 'requireon' attribute to form fields for conditional requiredness

NPM Resource Changed ?

Closed
15 May 2022
Medium
Build: 4.2-dev
Draft PR
# 37796
Diff
stephan-ansems:4.2-dev-require-on

Success

Success continuous-integration/appveyor/pr AppVeyor build succeeded Details
Success Download Prebuilt packages are available for download. Details
Success continuous-integration/drone/pr Build is passing Details

User tests: Successful: Unsuccessful:

stephan-ansems
15 May 2022

Pull Request for a new Feature

Summary of Changes

Implementation for an new attribute requireon to the form field spec to that accepts conditional statements identical to that of the showon attribute. However the effect is to toggle the required attribute on form fields and show/hode the little star next to the label that indicates that the field is required.

Why is this useful?

Some argue that having to toggle the requiredness of a field is a design flaw in the form, however I believe that it is not. For example a form to specify OAuth2 settings could have a dropdown to indicate the grant type. Depending on the grant type chosen, the form can change quite drastically. Some fields are not relevant for certain grant types and can be hidden, others are no longer required. The problem with only showon is that you can hide these fields, but a hidden field still remains required and form validation will not pass succesfully.

Testing Instructions

Create a form with a listfield with two options and a field that has the new attribute, for example this content:

<?xml version="1.0" encoding="utf-8"?>
  <field
      name="foo"
      type="list"
      >
      <option value="1">MANDATORY</option>
      <option value="0">OPTIONAL</option>
  </field>
  <field
      name="bar"
      type="text"
      requireon="foo:1"
  />
</form>

Open the form and change the selection of the foo field and see the bar field become mandory or optional.

Actual result BEFORE applying this Pull Request

Any form field that uses the requireon attribute remain required or optiona depending on value of the required attribute.

Expected result AFTER applying this Pull Request

Any fields that are conditionally required will be required when the condition evaluates to true. The logic works the same as for the showon attribute.