Video examples
iOS Voiceover
Android Talkback
iOS
Developer notes
- Screen reader focus moves to the picker when it opens
- “Picker item, adjustable” “swipe up or down to adjust the value” for custom actions on the picker are the common announcements
- Swipe right or left navigates to other columns in picker
- Done button closes picker and screen reader focus should return to the button that opened the picker
Name
- Programmatic name describes the purpose of the control that opens the picker.
- If visible text label exists, the programmatic name should match the visible text label.
- Note: Setting a programmatic name while a visible text label exists may cause VoiceOver to duplicate the announcement of the name. If this happens, hide the visible text label from VoiceOver recognization.
-
Placeholder text or value is not the programmatic name
- UIKit
- You can programmatically set the visible label with
setTitle()
.- The date picker’s title will overwrite the date picker’s
accessibilityLabel
.
- The date picker’s title will overwrite the date picker’s
- If a visible label is not applicable in this case, set the date picker’s
accessibilityLabel
to the label of your choice.- To do this in Interface Builder, set the label using the Identity Inspector
- To hide labels from VoiceOver programmatically, set the label’s
isAccessibilityElement
property tofalse
- To hide labels from VoiceOver using Interface Builder, uncheck
Accessibility Enabled
in the Identity Inspector.
- You can programmatically set the visible label with
- SwiftUI
- If no visible label, use view modifier
accessibilityLabel(_:)
.
- If no visible label, use view modifier
Role
- UIKit
- Use
UIPickerView
- Use
- SwiftUI
- Use native
Picker
view withWheelPickerStyle
- If applicable, use view modifier
accessibilityRemoveTraits(:)
to remove unwanted traits.
- Use native
Groupings
- UIKit
- Ensure that the child elements of the overarching view you want to group in has their
isAccessibilityElement
properties set to false. - Set
isAccessibilityElement
totrue
for the parent view. Then, adjustaccessibilityLabel
andaccessibilityTraits
accordingly.- If frame does not exist due to custom button, use
accessibilityFrameInContainer
to set the custom control’s frame to the parent view’s container or view of your choice.- You can also unionize two frames with
frame.union
(i.e.titleLabel.frame.union(subtitleLabel.frame)
).
- You can also unionize two frames with
- Use
shouldGroupAccessibilityElement
for a precise order if the native order should be disrupted. - Use
shouldGroupAccessibilityChildren
to indicate whether VoiceOver must group its children views. This allows making unique vocalizations or define a particular reading order for a part of the page.
- If frame does not exist due to custom button, use
- Ensure that the child elements of the overarching view you want to group in has their
- SwiftUI
- Use view modifier
accessibilityElement(children: .combine)
to merge the child accessibility element’s properties into the new accessibilityElement.
- Use view modifier
State
- UIKit
- For enabled: Set
isEnabled
totrue
. - For disabled: Set
isEnabled
tofalse
.- Announcement for disabled is “Dimmed”.
- If necessary, you may change the accessibility trait of the button to
notEnabled
, but this may overwrite the current accessibility role of the button.
- For enabled: Set
- SwiftUI
- For disabled, use view modifier
disabled()
.
- For disabled, use view modifier
Focus
- Use the device’s default focus functionality.
- External keyboard tab order often follows the screen reader focus, but sometimes this functionality requires additional development to manage focus.
-
When the date picker is closed, the focus should return to the triggering element.
- UIKit
- If VoiceOver is not reaching a particular element, set the element’s
isAccessibilityElement
totrue
- Note: You may need to adjust the programmatic name, role, state, and/or value after doing this, as this action may overwrite previously configured accessibility.
- Use
accessibilityViewIsModal
to contain the screen reader focus inside the modal. - To move screen reader focus to newly revealed content, use
UIAccessibility.post(notification:argument:)
that takes in.screenChanged
and the newly revealed content as the parameter arguments. - To NOT move focus, but dynamically announce new content: use
UIAccessibility.post(notification:argument:)
that takes in.announcement
and the announcement text as the parameter arguments. UIAccessibilityContainer
protocol: Have a table of elements that defines the reading order of the elements.
- If VoiceOver is not reaching a particular element, set the element’s
- SwiftUI
- For general focus management that impacts both screen readers and non-screen readers, use the property wrapper
@FocusState
to assign an identity of a focus state.- Use the property wrapper
@FocusState
in conjunction with the view modifierfocused(_:)
to assign focus on a view with@FocusState
as the source of truth. - Use the property wrapper
@FocusState
in conjunction with the view modifierfocused(_:equals:)
to assign focus on a view, when the view is equal to a specific value.
- Use the property wrapper
- If necessary, use property wrapper
@AccessibilityFocusState
to assign identifiers to specific views to manually shift focus from one view to another as the user interacts with the screen with VoiceOver on.
- For general focus management that impacts both screen readers and non-screen readers, use the property wrapper
Announcement examples (Contacts - date)
- “Add birthday, button” (button name and role that opens picker)
- Often, “collapsed or expanded” states are added to the button that opens the picker
- “February, picker item, adjustable, swipe up or down with one finger to adjust the value” (focus is on first picker item or previously selected item)
- Native pickers do not always show a Done button on the keyboard. So, swiping backwards to edit another field closes the picker
Android
Developer notes
- Time pickers are modal and cover the main content
- Users can select hours, minutes, or periods of time
- The clock or time picker toggles between two displays, the clock and a text input
- The TalkBack user should be confined in the modal
- The native component supplies all the announcements for conformance
- Done button closes picker and screen reader focus should return to the button that opened the picker
Name
- Name describes the purpose of the control
- Android Views
android:text
XML attribute- Use
contentDescription
, depending on type of view and for elements (icons) without a visible label contentDescription
overridesandroid:text
- Use
labelFor
attribute to associate the visible label with the control
- Jetpack Compose
- By default, the programmatic name is the visible text label of the segment
- Compose uses semantics properties to pass information to accessibility services
- Optional: use
contentDescription
for a more descriptive name to override the default text label - Example specification of contentDescription in compose:
modifier = Modifier.semantics { contentDescription = "" }
Role
- Follow native component role
- Android Views
- TimePickerDialog
- Jetpack Compose
TimePicker
TimePickerDialog
Groupings
- N/A
- Android Views
- Follow native component grouping
- Jetpack Compose
- Follow native component grouping
State
- Android Views
- Active:
android:enabled=true
- Disabled:
android:enabled=false
. Announcement: disabled
- Active:
- Jetpack Compose
- Active: default state is active and enabled. Use
Tab(enabled = true)
to specify explicitly - Disabled:
Tab(enabled = false)
announces as disabled - Alternatively can use
modifier = Modifier.semantics { disabled() }
to announce as disabled
- Active: default state is active and enabled. Use
Focus
- Only manage focus when needed. Primarily, let the device manage default focus
- Consider how focus should be managed between child elements and their parent views
- External keyboard tab order often follows the screen reader focus, but sometimes needs focus management
- When the time picker is closed, the focus should return to the triggering element.
- Android Views
importantForAccessibility
makes the element visible to the Accessibility APIandroid:focusable
android=clickable
- Implement an
onClick( )
event handler for keyboard, as well asonTouch( )
nextFocusDown
nextFocusUp
nextFocusRight
nextFocusLeft
accessibilityTraversalBefore
(or after)- To move screen reader focus to newly revealed content:
Type_View_Focused
- To NOT move focus, but dynamically announce new content:
accessibilityLiveRegion
(set to polite or assertive) - To hide controls:
importantForAccessibility=false
- For a
ViewGroup
, setscreenReaderFocusable=true
and each inner object’s attribute to keyboard focus (focusable=false
)
- Jetpack Compose
Modifier.focusTarget()
makes the component focusableModifier.focusOrder()
needs to be used in combination with FocusRequesters to define focus orderModifier.onFocusEvent()
,Modifier.onFocusChanged()
can be used to observe the changes to focus stateFocusRequester
allows to request focus to individual elements with in a group of merged descendant views- Example: To customize the focus events
- step 1: define the focus requester prior.
val (first, second) = FocusRequester.createRefs()
- step 2: update the modifier to set the order.
modifier = Modifier.focusOrder(first) { this.down = second }
- focus order accepts following values: up, down, left, right, previous, next, start, end
- step 3: use
second.requestFocus()
to gain focus
- step 1: define the focus requester prior.
Code Example
- Jetpack Compose
Announcement examples
- “Hour, Minutes and Period, Select Hours, Hour displayed, Double tap to select hours” Then swipe to the hours on the clock. Double tap on your selection. Swipe back to the minutes display
- “Minute, Double tap to select minutes” Then swipe to the clock. Swipe around the clock to select the minute. Swipe back to the AM/PM display
- “Selected, PM, Radio button, 2 of 2, Double tap to select” Selected PM option
- “Not selected, AM, Radio button, 1 of 2, Double tap to select”
- “Switch to text input mode for the time input, button, Double tap to activate” Set time modal is displayed (Toggled option is “clock mode”)
- “Set time” Heading for the text input modal
- “Type in time” Visible text label for hour/minute text input
- “Hour, Edit box for hour, Double tap to edit text” Hour input. User explores by touch until the keyboard is found and enters the text for the minutes and hours
- “Colon” Colon is announced to communicate a visible time display
- “Minutes, Edit box for minute, Double tap to edit text” “Hour” and “Minute” are announced because it is visually displayed
- “Dropdown list, PM, Double tap to change”
- “Pop up window, checked, AM, In list, Double tap to select” Pop up list
- “Cancel, button, double tap to activate” CTA (OK is other option)