README.md
1# Accessibility
2
3- [Accessibility](#accessibility)
4 - [Introduction](#introduction)
5 - [Architecture](#architecture)
6 - [Directory Structure](#directory-structure)
7 - [Usage](#usage)
8 - [Repositories Involved](#repositories-involved)
9
10## Introduction<a name="intro"></a>
11
12The accessibility framework provides a standard mechanism for exchanging information between applications and accessibility applications and supports the development of accessibility applications to enhance the accessibility experience. The typical use cases are as follows:
13
141. Allow people with disabilities to use applications. For example, provide the screen reader for people with visual impairments.
151. Provide the capability to interact with applications. For example, offer the UI automatic test framework and the capability to develop accessibility applications based on UI responses.
16
17## Architecture
18
19
20**Application Layer**：
21
22- Use Accessibility-Extension-Ability to develop applications with accessible capabilities.
23- General applications are integrated into accessible target applications from ACE, and use accessible capabilities.
24- The system settings application allows you to turn on/off for accessible capabilities.
25
26**Application Framework Layer**：
27
28- AAkit： Accessible Ability development kit, which supports Native and TS language development, is used to build an accessible ability execution environment.
29
30- ASACkit：Accessibility System Ability Client development kit, which supports Native and TS language development, provides the ability to use accessible capabilities for applications.
31
32- ACkit：Accessibility Configuration development kit, which supports Native and TS language development and provides the ability to set accessible capability switches for system applications.
33
34**System Service Layer**：
35
36- AccessibilityService： Service is management of accessible-ability connections, and the server connected by the accessibility client (ASAKit), and connects other system layer services to provide accessibility input capability.
37
38## Directory Structure<a name="files"></a>
39
40```
41/foundation/barrierfree/accessibility
42├── common
43│ ├── interface # Accessibility-service interface
44│ └── log # Hilog adaption
45├── figures # Figures of README
46├── frameworks
47│ ├── aafwk # AccessibleAbility-Kit implementation code
48│ ├── acfwk # AccessibilityConfiguration-Kit implementation code
49│ ├── asacfwk # AccessibleAbilityClient-Kit implementation code
50│ └── common # Common data-types and constants
51├── interfaces
52│ ├── innerkits # Internal C/C++ APIs of Accessibility
53│ └── kits # Developer TS APIs of Accessibility
54│ ├── js # TS APIs
55│ └── napi # Implementation of TS APIs
56├── resources # Resource files of accessibility
57├── sa_profile # SA-Configuration files of accessibility
58└── services
59 ├── aams # Accessibility-service code
60 ├── etc # Configuration files of accessibility-service
61 └── test # Test-code of accessibility-service
62```
63
64## Usage<a name="usage"></a>
65
66[1. accessibility configuration](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-accessibility-config-sys.md)
67
68[2. accessibility extension](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-inner-application-accessibilityExtensionContext.md)
69
70[3. accessibility](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-accessibility.md)
71
72[4. accessibility extension ability](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-application-accessibilityExtensionAbility.md)
73
74[5. accessibility gesturePath](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-accessibility-GesturePath.md)
75
76[6. accessibility gesturePoint](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-accessibility-kit/js-apis-accessibility-GesturePoint.md)
77
78## Repositories Involved<a name="relevant"></a>
79
80**accessibility**
81
82[accessibility](https://gitee.com/openharmony/accessibility)
83
