Skip to content

Commit

Permalink
Update A11y doc with Accessibility heading support (#579)
Browse files Browse the repository at this point in the history
Summary:
<!-- Thanks for submitting a pull request! We appreciate you taking the time to work on these
changes. Please provide enough information so that others can review your pull request. The three
fields below are mandatory. -->

I submitted the PR for accessibility headers support : #573 . Adding documentation now for the same.
<!-- Explain the **motivation** for making this change. What existing problem does the pull request
solve? -->

## Changelog

<!-- Help reviewers and the release process by writing your own changelog entry. This should just be
a brief oneline we can mention in our release notes: https://github.com/facebook/litho/releases -->
Pull Request resolved: #579

Test Plan:
<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, output of
the test runner and how you invoked it (you've added tests, right?), screenshots/videos if the pull
request changes UI. -->

Reviewed By: colriot

Differential Revision: D18725611

Pulled By: muraziz

fbshipit-source-id: 3373e6b99e20f83cde44852ea6e95e7d65f6a2d2
  • Loading branch information
anushreeag authored and facebook-github-bot committed Nov 27, 2019
1 parent 4508ea4 commit 4bb3b1d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/_docs/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,14 @@ static Component onCreateLayout(
}
```

## Accessibility Heading

Heading is an accessibility property and will help the users to choose to "Navigate by Headings" and ignore scrolling through each and every subitem under a heading. "Navigate based on Heading" can be selected from "Local Context Menu" when talkback is on. Talkback gesture for "Local Context Menu" is **Swipe up then right**.
Making any component an Accessibility Header is as simple as:

```java
Row.create(c)
.contentDescription("This is an accessibility heading")
.accessibilityHeading(true)
.build()
```

0 comments on commit 4bb3b1d

Please sign in to comment.