diff --git a/core/includes/form.inc b/core/includes/form.inc index eb028e3..c66f07b 100644 --- a/core/includes/form.inc +++ b/core/includes/form.inc @@ -229,9 +229,22 @@ function template_preprocess_details(&$variables) { $variables['summary_attributes']['aria-pressed'] = $variables['summary_attributes']['aria-expanded']; } $variables['title'] = (!empty($element['#title'])) ? $element['#title'] : ''; - $variables['description'] = (!empty($element['#description'])) ? $element['#description'] : ''; $variables['children'] = (isset($element['#children'])) ? $element['#children'] : ''; $variables['value'] = (isset($element['#value'])) ? $element['#value'] : ''; + + $variables['description'] = NULL; + if (!empty($element['#description'])) { + $variables['description_display'] = isset($element['#description_display']) ? $element['#description_display'] : 'before'; + $description_attributes = []; + if ($variables['description_display'] === 'invisible') { + $description_attributes['class'][] = 'visually-hidden'; + } + if (!empty($element['#id'])) { + $description_attributes['id'] = $element['#id'] . '--description'; + } + $variables['description']['attributes'] = new Attribute($description_attributes); + $variables['description']['content'] = $element['#description']; + } } /** diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php index 4b995c1..490a4f7 100644 --- a/core/lib/Drupal/Core/Form/FormBuilder.php +++ b/core/lib/Drupal/Core/Form/FormBuilder.php @@ -708,11 +708,12 @@ public function doBuildForm($form_id, &$element, FormStateInterface &$form_state $element['#defaults_loaded'] = TRUE; } // Assign basic defaults common for all form elements. + // NOTE: description_display is below by default, excepted for details. $element += array( '#required' => FALSE, '#attributes' => array(), '#title_display' => 'before', - '#description_display' => 'after', + '#description_display' => (isset($element['#type']) && $element['#type'] == 'details') ? 'before' : 'after', '#errors' => NULL, ); diff --git a/core/modules/system/src/Tests/Form/ElementsDetailsTest.php b/core/modules/system/src/Tests/Form/ElementsDetailsTest.php new file mode 100644 index 0000000..c7df48f --- /dev/null +++ b/core/modules/system/src/Tests/Form/ElementsDetailsTest.php @@ -0,0 +1,58 @@ +drupalGet('form-test/group-details'); + + // Check #description default placement. + $field_id = 'edit-details'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//details[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]//details[@id="edit-meta"]/preceding-sibling::div[@id="' . $description_id . '"]'); + $this->assertTrue(isset($elements[0]), t('Properly places by default the #description element before the form item within details group.')); + + // Check #description placement with #description_display='before'. + $field_id = 'edit-details-before'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//details[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]//div[@id="edit-meta-before"]/preceding-sibling::div[@id="' . $description_id . '"]'); + $this->assertTrue(isset($elements[0]), t('Properly places the #description element before the form item within details group.')); + + // Check #description placement with #description_display='after'. + $field_id = 'edit-details-after'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//details[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]//div[@id="edit-meta-after"]/following-sibling::div[@id="' . $description_id . '"]'); + $this->assertTrue(isset($elements[0]), t('Properly places the #description element after the form item within details group.')); + + // Check if the class is 'visually-hidden' on the form details description + // for the option with #description_display='invisible' and also check that + // the description is placed after the form element. + $field_id = 'edit-details-invisible'; + $description_id = $field_id . '--description'; + $elements = $this->xpath('//details[@id="' . $field_id . '" and @aria-describedby="' . $description_id . '"]//div[@id="edit-meta-invisible"]/following-sibling::div[contains(@class, "visually-hidden")]'); + $this->assertTrue(isset($elements[0]), t('Properly renders the #description element visually-hidden within details group.')); + } +} diff --git a/core/modules/system/templates/details.html.twig b/core/modules/system/templates/details.html.twig index 42dd4c2..7d9e749 100644 --- a/core/modules/system/templates/details.html.twig +++ b/core/modules/system/templates/details.html.twig @@ -7,6 +7,12 @@ * - attributes: A list of HTML attributes for the details element. * - title: (optional) The title of the element, may not be set. * - description: (optional) The description of the element, may not be set. + * - description_display: (optional) Description display setting. It can have these values: + * - before: The description is output before the element. This is the default + * value. + * - after: The description is output after the element. + * - invisible: The description is output after the element, hidden visually + * but available to screen readers. * - children: (optional) The children of the element, may not be set. * - value: (optional) The value of the element, may not be set. * @@ -19,15 +25,22 @@ {%- if title -%} {{ title }} {%- endif -%} -
- {%- if description -%} -
{{ description }}
- {%- endif -%} +
+ {% if description_display == 'before' and description.content %} + + {{ description.content }} +
+ {% endif %} {%- if children -%} {{ children }} {%- endif -%} {%- if value -%} {{ value }} {%- endif -%} + {% if description_display in ['after', 'invisible'] and description.content %} + + {{ description.content }} +
+ {% endif %} diff --git a/core/modules/system/tests/modules/form_test/src/Form/FormTestGroupDetailsForm.php b/core/modules/system/tests/modules/form_test/src/Form/FormTestGroupDetailsForm.php index d8f5925..fc0ad84 100644 --- a/core/modules/system/tests/modules/form_test/src/Form/FormTestGroupDetailsForm.php +++ b/core/modules/system/tests/modules/form_test/src/Form/FormTestGroupDetailsForm.php @@ -29,6 +29,7 @@ public function buildForm(array $form, FormStateInterface $form_state) { $form['details'] = array( '#type' => 'details', '#title' => 'Root element', + '#description' => 'Details test for default description position.', '#open' => TRUE, ); $form['meta'] = array( @@ -41,6 +42,54 @@ public function buildForm(array $form, FormStateInterface $form_state) { '#type' => 'textfield', '#title' => 'Nest in details element', ); + + $form['details_before'] = array( + '#type' => 'details', + '#title' => 'Details test for description before element', + '#description' => 'Details test for description before element.', + '#description_display' => 'before', + ); + $form['meta_before'] = array( + '#type' => 'container', + '#title' => 'Group element', + '#group' => 'details_before', + ); + $form['meta_before']['element'] = array( + '#type' => 'textfield', + '#title' => 'Nest in container element', + ); + + $form['details_after'] = array( + '#type' => 'details', + '#title' => 'Details test for description after element', + '#description' => 'Details test for description after element.', + '#description_display' => 'after', + ); + $form['meta_after'] = array( + '#type' => 'container', + '#title' => 'Group element', + '#group' => 'details_after', + ); + $form['meta_after']['element'] = array( + '#type' => 'textfield', + '#title' => 'Nest in container element', + ); + + $form['details_invisible'] = array( + '#type' => 'details', + '#title' => 'Details test for visually-hidden description', + '#description' => 'Details test for visually-hidden description.', + '#description_display' => 'invisible', + ); + $form['meta_invisible'] = array( + '#type' => 'container', + '#title' => 'Group element', + '#group' => 'details_invisible', + ); + $form['meta_invisible']['element'] = array( + '#type' => 'textfield', + '#title' => 'Nest in container element', + ); return $form; } diff --git a/core/themes/classy/templates/form/details.html.twig b/core/themes/classy/templates/form/details.html.twig index 9b149d7..61b30f4 100644 --- a/core/themes/classy/templates/form/details.html.twig +++ b/core/themes/classy/templates/form/details.html.twig @@ -7,6 +7,12 @@ * - attributes: A list of HTML attributes for the details element. * - title: (optional) The title of the element, may not be set. * - description: (optional) The description of the element, may not be set. + * - description_display: (optional) Description display setting. It can have these values: + * - before: The description is output before the element. This is the default + * value. + * - after: The description is output after the element. + * - invisible: The description is output after the element, hidden visually + * but available to screen readers. * - children: (optional) The children of the element, may not be set. * - value: (optional) The value of the element, may not be set. * @@ -18,14 +24,21 @@ {{ title }} {%- endif -%}
- {%- if description -%} -
{{ description }}
- {%- endif -%} + {% if description_display == 'before' and description.content %} + + {{ description.content }} +
+ {% endif %} {%- if children -%} {{ children }} {%- endif -%} {%- if value -%} {{ value }} {%- endif -%} + {% if description_display in ['after', 'invisible'] and description.content %} + + {{ description.content }} + + {% endif %}