aboutsummaryrefslogtreecommitdiff
path: root/ui/accessibility/BasicAccessibility/README.md
blob: 3f47ba50a2582b0185a6384a6e159b284cb73a9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

Android BasicAccessibility Sample
===================================

This sample demonstrates how to create an accessible application, using a mix of different widgets
demonstrating different ways of adding accessibility markup to a UI.

Introduction
------------

This sample demonstrates how to create an accessible application, showing
how to add accessibility to both framework and custom widgets.

To run this sample as intended you will need to turn on TalkBack (or another text to speach system)
on your Android device. Go to Settings > Accessibility > TalkBack to turn TalkBack on.

When you run the sample with TalkBack mode on, TalkBack will read aloud the
description of the in-focus widget.

Pre-requisites
--------------

- Android SDK v23
- Android Build Tools v22.0.1
- Android Support Repository

Screenshots
-------------

<img src="screenshots/main.png" height="400" alt="Screenshot"/> 

Getting Started
---------------

This sample uses the Gradle build system. To build this project, use the
"gradlew build" command or use "Import Project" in Android Studio.

Support
-------

- Google+ Community: https://plus.google.com/communities/105153134372062985968
- Stack Overflow: http://stackoverflow.com/questions/tagged/android

If you've found an error in this sample, please file an issue:
https://github.com/googlesamples/android-BasicAccessibility

Patches are encouraged, and may be submitted by forking this project and
submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.

License
-------

Copyright 2014 The Android Open Source Project, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements.  See the NOTICE file distributed with this work for
additional information regarding copyright ownership.  The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License.  You may obtain a copy of
the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
License for the specific language governing permissions and limitations under
the License.