diff --git a/core/includes/form.inc b/core/includes/form.inc index 5a24e98..9a9ae58 100644 --- a/core/includes/form.inc +++ b/core/includes/form.inc @@ -2710,7 +2710,11 @@ function template_preprocess_form_element(&$variables) { $variables['description'] = NULL; if (!empty($element['#description'])) { - $description_attributes = array('class' => 'description'); + $variables['description_display'] = $element['#description_display']; + $description_attributes = array('class' => array('description')); + if ($element['#description_display'] === 'invisible') { + $description_attributes['class'][] = 'visually-hidden'; + } if (!empty($element['#id'])) { $description_attributes['id'] = $element['#id'] . '--description'; } diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php index 6aeeffd..5d5b985 100644 --- a/core/lib/Drupal/Core/Form/FormBuilder.php +++ b/core/lib/Drupal/Core/Form/FormBuilder.php @@ -703,6 +703,7 @@ public function doBuildForm($form_id, &$element, FormStateInterface &$form_state '#required' => FALSE, '#attributes' => array(), '#title_display' => 'before', + '#description_display' => 'after', '#errors' => NULL, ); diff --git a/core/modules/system/src/Tests/Form/ElementsLabelsTest.php b/core/modules/system/src/Tests/Form/ElementsLabelsTest.php index 970f299..766386a 100644 --- a/core/modules/system/src/Tests/Form/ElementsLabelsTest.php +++ b/core/modules/system/src/Tests/Form/ElementsLabelsTest.php @@ -94,4 +94,29 @@ function testFormLabels() { $elements = $this->xpath('//div[@id="edit-form-radios-title-attribute"]'); $this->assertEqual($elements[0]['title'], 'Radios test' . ' (' . t('Required') . ')', 'Title attribute found.'); } + + /** + * Test description of form elements with different placement options. + */ + function testFormDescriptions() { + $test = $this->drupalGet('form_test/form-descriptions'); + + // Check #description placement with #description_display='after'. + $field_id = 'edit-form-textfield-test-description-after'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//input[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]/following-sibling::div[@id="' . $description_id . '"]'); + $this->assertTrue(isset($elements[0]), t('Properly places the #description element after the form item.')); + + // Check #description placement with #description_display='before'. + $field_id = 'edit-form-textfield-test-description-before'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//input[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]/preceding-sibling::div[@id="' . $description_id . '"]'); + $this->assertTrue(isset($elements[0]), t('Properly places the #description element before the form item.')); + + // Check #description placement with #description_display='invisible'. + $field_id = 'edit-form-textfield-test-description-invisible'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//input[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]/following-sibling::div[contains(@class, "visually-hidden")]'); + $this->assertTrue(isset($elements[0]), t('Properly renders the #description element visually-hidden.')); + } } diff --git a/core/modules/system/templates/form-element.html.twig b/core/modules/system/templates/form-element.html.twig index ea4d90f..bdd66a3 100644 --- a/core/modules/system/templates/form-element.html.twig +++ b/core/modules/system/templates/form-element.html.twig @@ -30,6 +30,12 @@ * - content: A description of the form element, may not be set. * - attributes: (optional) A list of HTML attributes to apply to the * description content wrapper. Will only be set when description is set. + * - description_display: Description display setting. It can have these values: + * - before: The description is output before the element. + * - after: The description is output after the element. This is the default + * value. + * - invisible: The description is output after the element, hidden visually but + * available to screen readers. * * @see template_preprocess_form_element() * @@ -43,6 +49,11 @@ {% if prefix is not empty %} {{ prefix }} {% endif %} + {% if description_display == 'before' and description.content %} + + {{ description.content }} + + {% endif %} {{ children }} {% if suffix is not empty %} {{ suffix }} @@ -50,7 +61,7 @@ {% if label_display == 'after' %} {{ label }} {% endif %} - {% if description.content %} + {% if description_display in ['after', 'invisible'] and description.content %} {{ description.content }} diff --git a/core/modules/system/tests/modules/form_test/form_test.routing.yml b/core/modules/system/tests/modules/form_test/form_test.routing.yml index 86d7fc0..109d8f3 100644 --- a/core/modules/system/tests/modules/form_test/form_test.routing.yml +++ b/core/modules/system/tests/modules/form_test/form_test.routing.yml @@ -378,6 +378,14 @@ form_test.button_class: requirements: _access: 'TRUE' +form_test.description_display: + path: '/form_test/form-descriptions' + defaults: + _form: '\Drupal\form_test\Form\FormTestDescriptionForm' + _title: 'Form description test' + requirements: + _access: 'TRUE' + form_test.group_details: path: '/form-test/group-details' defaults: