Main content

textbox

Characteristics

Superclass Role:

  • input

Related Concepts:

  • XForms input
  • HTML textarea
  • HTML input[type="text"]

Supported States and Properties:

  • aria-activedescendant
  • aria-autocomplete
  • aria-multiline
  • aria-readonly
  • aria-required

Inherited States and Properties:

  • aria-atomic
  • aria-busy (state)
  • aria-controls
  • aria-describedby
  • aria-disabled (state)
  • aria-dropeffect
  • aria-flowto
  • aria-grabbed (state)
  • aria-haspopup
  • aria-hidden (state)
  • aria-invalid (state)
  • aria-label
  • aria-labelledby
  • aria-live
  • aria-owns
  • aria-relevant

Name From:

  • author

Accessible Name Required:

  • True

Input that allows free-form text as its value.

A textbox role is assigned to the element which allows the user to type some text into the field. In normal HTML semantics, this is achieved using input type="text". If this information is not intimated to the user in a different way and screen readers do not recognize it, the textbox role can be used.

Usually a textbox provides a possibility to have a single line of text and on hitting Enter submits the form. To have more lines of text input, type="textarea" is used. The same can be achieved with multiline property of aria. Set aria-multiline to true.

If the aria-multiline attribute is true, the widget accepts line breaks within the input, as in an HTML textarea. Otherwise, this is a simple text box. The intended use is for languages that do not have a text input element, or cases in which an element with different semantics is repurposed as a text field.

Note: In most user agent implementations, the default behavior of the Enter or Return key is different between the single-line and multi-line text fields in HTML. When user has focus in a single-line input type="text" element, the keystroke usually submits the form. When user has focus in a multi-line textarea element, the keystroke inserts a line break. The aria textbox role differentiates these types of boxes with the aria-multiline attribute, so authors are advised to be aware of this distinction when designing the field.

Microsoft Active Accessibility accRole Property: 

  • ROLE_SYSTEM_TEXT

UI Automation ControlType Property: 

  • Document

UI Automation AriaRole Property: 

  • textbox
More in this category: « timer tabpanel »