2017-02-28 02:28:23 +00:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
|
|
*
|
2018-02-17 02:24:55 +00:00
|
|
|
* This source code is licensed under the MIT license found in the
|
|
|
|
* LICENSE file in the root directory of this source tree.
|
2017-02-28 02:28:23 +00:00
|
|
|
*
|
2018-05-11 02:06:46 +00:00
|
|
|
* @format
|
2018-08-08 17:39:16 +00:00
|
|
|
* @flow
|
2017-02-28 02:28:23 +00:00
|
|
|
*/
|
2018-05-11 02:06:46 +00:00
|
|
|
|
2017-02-28 02:28:23 +00:00
|
|
|
'use strict';
|
|
|
|
|
2018-03-03 23:04:46 +00:00
|
|
|
const NativeModules = require('NativeModules');
|
|
|
|
const RCTDeviceEventEmitter = require('RCTDeviceEventEmitter');
|
2018-07-19 00:13:56 +00:00
|
|
|
const UIManager = require('UIManager');
|
2017-02-28 02:28:23 +00:00
|
|
|
|
2018-03-03 23:04:46 +00:00
|
|
|
const RCTAccessibilityInfo = NativeModules.AccessibilityInfo;
|
2017-02-28 02:28:23 +00:00
|
|
|
|
2018-03-03 23:04:46 +00:00
|
|
|
const TOUCH_EXPLORATION_EVENT = 'touchExplorationDidChange';
|
2017-02-28 02:28:23 +00:00
|
|
|
|
|
|
|
type ChangeEventName = $Enum<{
|
|
|
|
change: string,
|
|
|
|
}>;
|
|
|
|
|
2018-03-03 23:04:46 +00:00
|
|
|
const _subscriptions = new Map();
|
2017-02-28 02:28:23 +00:00
|
|
|
|
Migrate to new documentation format
Summary:
Now that the Component and API docs are no longer auto-generated, we need to consolidate on a new format for our jsdoc comments. Any help from the community will be appreciated.
In this initial pull request, we'll be tackling the following docs:
- `AccessibilityInfo`, an API doc.
- `ActivityIndicator`, a Component doc.
- `View`, a Component doc.
This top comment will serve as a style guide, and when in doubt, please refer to the individual commits in this PR.
Each commit should update a single component or API, along with any relevant markdown files.
- Documentation in the JavaScript source files should be succinct. Any verbosity should be moved over to the markdown docs in the website...
- ...by adding a link to the relevant method/prop on the website to every comment block.
- Avoid markdown style links in JavaScript source files, opt for plain old URIs.
Let code document itself:
- If a method is Flow typed, the comment block does not need to repeat this information.
- If a param can be one of several values, and the type definition is easily determined from the code, the values should not be repeated in the comment block. Again, move this to the markdown doc if not present already.
Closes https://github.com/facebook/react-native/pull/16790
Differential Revision: D6353840
Pulled By: hramos
fbshipit-source-id: 9712c459acc33092aae9909f3dd0b58a00b26afc
2017-11-17 00:44:29 +00:00
|
|
|
/**
|
|
|
|
* Sometimes it's useful to know whether or not the device has a screen reader
|
|
|
|
* that is currently active. The `AccessibilityInfo` API is designed for this
|
2018-02-22 15:04:35 +00:00
|
|
|
* purpose. You can use it to query the current state of the screen reader as
|
|
|
|
* well as to register to be notified when the state of the screen reader
|
Migrate to new documentation format
Summary:
Now that the Component and API docs are no longer auto-generated, we need to consolidate on a new format for our jsdoc comments. Any help from the community will be appreciated.
In this initial pull request, we'll be tackling the following docs:
- `AccessibilityInfo`, an API doc.
- `ActivityIndicator`, a Component doc.
- `View`, a Component doc.
This top comment will serve as a style guide, and when in doubt, please refer to the individual commits in this PR.
Each commit should update a single component or API, along with any relevant markdown files.
- Documentation in the JavaScript source files should be succinct. Any verbosity should be moved over to the markdown docs in the website...
- ...by adding a link to the relevant method/prop on the website to every comment block.
- Avoid markdown style links in JavaScript source files, opt for plain old URIs.
Let code document itself:
- If a method is Flow typed, the comment block does not need to repeat this information.
- If a param can be one of several values, and the type definition is easily determined from the code, the values should not be repeated in the comment block. Again, move this to the markdown doc if not present already.
Closes https://github.com/facebook/react-native/pull/16790
Differential Revision: D6353840
Pulled By: hramos
fbshipit-source-id: 9712c459acc33092aae9909f3dd0b58a00b26afc
2017-11-17 00:44:29 +00:00
|
|
|
* changes.
|
|
|
|
*
|
|
|
|
* See http://facebook.github.io/react-native/docs/accessibilityinfo.html
|
|
|
|
*/
|
|
|
|
|
2018-03-03 23:04:46 +00:00
|
|
|
const AccessibilityInfo = {
|
2018-08-13 18:14:35 +00:00
|
|
|
/* $FlowFixMe(>=0.78.0 site=react_native_android_fb) This issue was found
|
|
|
|
* when making Flow check .android.js files. */
|
2017-02-28 02:28:23 +00:00
|
|
|
fetch: function(): Promise {
|
|
|
|
return new Promise((resolve, reject) => {
|
2018-05-11 02:06:46 +00:00
|
|
|
RCTAccessibilityInfo.isTouchExplorationEnabled(function(resp) {
|
|
|
|
resolve(resp);
|
|
|
|
});
|
2017-02-28 02:28:23 +00:00
|
|
|
});
|
|
|
|
},
|
|
|
|
|
2018-05-11 02:06:46 +00:00
|
|
|
addEventListener: function(
|
2017-02-28 02:28:23 +00:00
|
|
|
eventName: ChangeEventName,
|
2018-05-11 02:06:46 +00:00
|
|
|
handler: Function,
|
2017-02-28 02:28:23 +00:00
|
|
|
): void {
|
2018-03-03 23:04:46 +00:00
|
|
|
const listener = RCTDeviceEventEmitter.addListener(
|
2017-02-28 02:28:23 +00:00
|
|
|
TOUCH_EXPLORATION_EVENT,
|
2018-05-11 02:06:46 +00:00
|
|
|
enabled => {
|
2017-02-28 02:28:23 +00:00
|
|
|
handler(enabled);
|
2018-05-11 02:06:46 +00:00
|
|
|
},
|
2017-02-28 02:28:23 +00:00
|
|
|
);
|
|
|
|
_subscriptions.set(handler, listener);
|
|
|
|
},
|
|
|
|
|
|
|
|
removeEventListener: function(
|
|
|
|
eventName: ChangeEventName,
|
2018-05-11 02:06:46 +00:00
|
|
|
handler: Function,
|
2017-02-28 02:28:23 +00:00
|
|
|
): void {
|
2018-03-03 23:04:46 +00:00
|
|
|
const listener = _subscriptions.get(handler);
|
2017-02-28 02:28:23 +00:00
|
|
|
if (!listener) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
listener.remove();
|
|
|
|
_subscriptions.delete(handler);
|
|
|
|
},
|
2018-07-19 00:13:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set accessibility focus to a react component.
|
|
|
|
*
|
|
|
|
* See http://facebook.github.io/react-native/docs/accessibilityinfo.html#setaccessibilityfocus
|
|
|
|
*/
|
|
|
|
setAccessibilityFocus: function(reactTag: number): void {
|
|
|
|
UIManager.sendAccessibilityEvent(
|
|
|
|
reactTag,
|
|
|
|
UIManager.AccessibilityEventTypes.typeViewFocused,
|
|
|
|
);
|
|
|
|
},
|
2017-02-28 02:28:23 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
module.exports = AccessibilityInfo;
|