UIView: accessibilityHint property
The accessibilityHint property is the hint VoiceOver reads after the name: it says what happens when the user activates this element, such as "Opens the order details".
VoiceOver is the screen reader built into iOS; see isAccessibilityElement.
Value
A string, or null.
- Readable and writable.
- On
UIViewthe default isnull. - Writing
nullorundefinedclears it, and it readsnull. Other values are converted withString(). - When VoiceOver stops on an element, it reads the label, value, and traits, pauses briefly, then reads the hint. Users can turn hints off in the system settings; then the hint is not read. Both points come from Apple's documentation and are not verified on a device.
- There is no change event: only the app's own code changes it.
Examples
js
const row = new UIView();
row.isAccessibilityElement = true;
row.accessibilityLabel = 'Order 1024, awaiting shipment';
row.accessibilityHint = 'Opens the order details';
console.log(row.accessibilityHint);Effect: The console prints Opens the order details. VoiceOver stops on this row, reads "Order 1024, awaiting shipment", and a moment later reads "Opens the order details". How VoiceOver reads it is not verified on a device.
Corresponding iOS API
accessibilityHint. In iOS it belongs to the UIAccessibility protocol and every object has it; in JS it exists only on UIView and its subclasses.
See also
- Making VoiceOver read your interface correctly: what to put in a hint
accessibilityLabel,accessibilityValue