Accessibility

Here you’ll find a description of accessibility attributes

What is it?

This component enables accessibility elements, such as a text message that can be read by a screen reader.

Attributes	Type	Required	Definition
accessible	Boolean	✓	Indicates whether the component will be interpreted as accessible. Default is `true`.
accessibilityLabel	String		Contains a message that will be spoken by programs like `VoiceOver`.
isHeader	Boolean		Indicates whether the component is a header. Default is `false`.

If backend does not specify accessibility, the default values for each platform will be used.

Container(
    children = listOf(
        Image(
            path = ImagePath.Remote("https://i.ibb.co/rvRN9kv/logo.png")
        ).setAccessibility {
            accessible = true
            accessibilityLabel = "Image Label"
        }
    )
)

👉 Test this example on Web Playground

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified July 1, 2021: refactor: adjust ordem pages inside API (#695) (fc266566)