Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AccessibilityNode.label

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public string label;

Description

A short description of the accessibility node.


The node's label should provide a concise, human-readable description of the visual element represented by the node.

The label is essential to screen reader users because it provides the text that the screen reader announces when a user focuses on the node to communicate the purpose or content of the visual element that the node represents.

Generally, all accessibility nodes should have an appropriate label. Nodes with an empty label can cause unwanted screen reader behavior.

A good label is short, informative, and does not include the node's type. For example, the label for a Save button should be "Save", not "Save button". To ensure proper screen reader intonation, start the label with a capital letter and avoid ending it with a period.

The label works in tandem with other node properties to provide a comprehensive experience to the user. While the label provides the main identifier of the accessibility node, additional information can be supplied through properties such as the AccessibilityNode.value, AccessibilityNode.hint, AccessibilityNode.role and AccessibilityNode.state.