function ElementsLabelsTest::testFormLabels

Tests form element rendering.

This method provides test coverage for:

• Form label rendering with different form elements.
• Rendering of the "Required" field marker.
• Prefix and suffix render element placement.
• Form element title attributes.

File

core/modules/system/tests/src/Functional/Form/ElementsLabelsTest.php, line 46

Class

ElementsLabelsTest

Tests form element labels, required markers and associated output.

Namespace

Code

protected function testFormLabels() : void {
  $this->drupalGet('form_test/form-labels');
  // Check that the checkbox/radio processing is not interfering with
  // basic placement.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-checkboxes-test-third-checkbox"]/following-sibling::label[@for="edit-form-checkboxes-test-third-checkbox" and @class="option"]');
  // Make sure the label is rendered for checkboxes.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-checkboxes-test-0"]/following-sibling::label[@for="edit-form-checkboxes-test-0" and @class="option"]');
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-radios-test-second-radio"]/following-sibling::label[@for="edit-form-radios-test-second-radio" and @class="option"]');
  // Make sure the label is rendered for radios.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-radios-test-0"]/following-sibling::label[@for="edit-form-radios-test-0" and @class="option"]');
  // Exercise various defaults for checkboxes and modifications to ensure
  // appropriate override and correct behavior.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-checkbox-test"]/following-sibling::label[@for="edit-form-checkbox-test" and @class="option"]');
  // Exercise various defaults for textboxes and modifications to ensure
  // appropriate override and correct behavior.
  // Verify that label precedes textfield, with required marker inside label.
  $this->assertSession()
    ->elementExists('xpath', '//label[@for="edit-form-textfield-test-title-and-required" and @class="js-form-required form-required"]/following-sibling::input[@id="edit-form-textfield-test-title-and-required"]');
  // Verify that label tag with required marker precedes required textfield
  // with no title.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-textfield-test-no-title-required"]/preceding-sibling::label[@for="edit-form-textfield-test-no-title-required" and @class="js-form-required form-required"]');
  // Verify that label preceding field and label class is visually-hidden.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-textfield-test-title-invisible"]/preceding-sibling::label[@for="edit-form-textfield-test-title-invisible" and @class="visually-hidden"]');
  // Verify that no required marker on non-required field.
  $this->assertSession()
    ->elementNotExists('xpath', '//input[@id="edit-form-textfield-test-title"]/preceding-sibling::span[@class="js-form-required form-required"]');
  // Verify that label after field and label option class correct for text
  // field.
  $this->assertSession()
    ->elementExists('xpath', '//input[@id="edit-form-textfield-test-title-after"]/following-sibling::label[@for="edit-form-textfield-test-title-after" and @class="option"]');
  // Verify that no label tag exists when title set not to display.
  $this->assertSession()
    ->elementNotExists('xpath', '//label[@for="edit-form-textfield-test-title-no-show"]');
  // Verify that field class is form-no-label when there is no label.
  $this->assertSession()
    ->elementExists('xpath', '//div[contains(@class, "js-form-item-form-textfield-test-title-invisible") and contains(@class, "form-no-label")]');
  // Check #field_prefix and #field_suffix placement.
  $this->assertSession()
    ->elementExists('xpath', '//span[@class="field-prefix"]/following-sibling::div[@id="edit-form-radios-test"]');
  $this->assertSession()
    ->elementExists('xpath', '//span[@class="field-suffix"]/preceding-sibling::div[@id="edit-form-radios-test"]');
  // Check #prefix and #suffix placement. Both elements placed before the form
  // item.
  $this->assertSession()
    ->elementExists('xpath', '//div[@id="form-test-textfield-title-prefix"]/following-sibling::div[contains(@class, \'js-form-item-form-textfield-test-title\')]');
  $this->assertSession()
    ->elementExists('xpath', '//div[@id="form-test-textfield-title-suffix"]/preceding-sibling::div[contains(@class, \'js-form-item-form-textfield-test-title\')]');
  // Check title attribute for radios and checkboxes.
  $this->assertSession()
    ->elementAttributeContains('css', '#edit-form-checkboxes-title-attribute', 'title', 'Checkboxes test (Required)');
  $this->assertSession()
    ->elementAttributeContains('css', '#edit-form-radios-title-attribute', 'title', 'Radios test (Required)');
  // Check Title/Label not displayed when 'visually-hidden' attribute is set
  // in checkboxes.
  $this->assertSession()
    ->elementExists('xpath', '//fieldset[@id="edit-form-checkboxes-title-invisible--wrapper"]/legend/span[contains(@class, "visually-hidden")]');
  // Check Title/Label not displayed when 'visually-hidden' attribute is set
  // in radios.
  $this->assertSession()
    ->elementExists('xpath', '//fieldset[@id="edit-form-radios-title-invisible--wrapper"]/legend/span[contains(@class, "visually-hidden")]');
}