add support for iOS "Darker System Colors" (Increase Contrast) setting into AccessibilityInfo (#46826)

Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/46826

This change adds `isDarkerSystemColorsEnabled()` to `AccessibilityInfo` to enable access to iOS's "Increase Contrast" setting option. It also adds a new event, `darkerSystemColorsChanged`, to enable listeners to subscribe to changes on this setting.

## Changelog

[iOS][Added] - Added `isDarkerSystemColorsEnabled()` to `AccessibilityInfo` to read "Increase Contrast" setting value

Reviewed By: cipolleschi

Differential Revision: D63880393

fbshipit-source-id: a476f8fc4d7354826bc344876b359eb1a3485f0d
This commit is contained in:
Ariel Lin
2024-10-04 11:46:10 -07:00
committed by Facebook GitHub Bot
parent 7bb12ebbea
commit af3bee6511
7 changed files with 74 additions and 0 deletions
@@ -17,6 +17,7 @@ type AccessibilityChangeEventName =
| 'invertColorsChanged' // iOS-only Event
| 'reduceMotionChanged'
| 'highTextContrastChanged' // Android-only Event
| 'darkerSystemColorsChanged' // iOS-only Event
| 'screenReaderChanged'
| 'reduceTransparencyChanged'; // iOS-only Event
@@ -77,6 +78,13 @@ export interface AccessibilityInfoStatic {
*/
isHighTextContrastEnabled: () => Promise<boolean>;
/**
* Query whether darker system colors is currently enabled.
*
* @platform ios
*/
isDarkerSystemColorsEnabled: () => Promise<boolean>;
/**
* Query whether reduce motion and prefer cross-fade transitions settings are currently enabled.
*
@@ -31,6 +31,7 @@ type AccessibilityEventDefinitionsIOS = {
grayscaleChanged: [boolean],
invertColorsChanged: [boolean],
reduceTransparencyChanged: [boolean],
darkerSystemColorsChanged: [boolean],
};
type AccessibilityEventDefinitions = {
@@ -64,6 +65,7 @@ const EventNames: Map<
['reduceMotionChanged', 'reduceMotionChanged'],
['reduceTransparencyChanged', 'reduceTransparencyChanged'],
['screenReaderChanged', 'screenReaderChanged'],
['darkerSystemColorsChanged', 'darkerSystemColorsChanged'],
]);
/**
@@ -200,6 +202,32 @@ const AccessibilityInfo = {
});
},
/**
* Query whether dark system colors is currently enabled. iOS only.
*
* Returns a promise which resolves to a boolean.
* The result is `true` when dark system colors is enabled and `false` otherwise.
*/
isDarkerSystemColorsEnabled(): Promise<boolean> {
return new Promise((resolve, reject) => {
if (Platform.OS === 'android') {
return Promise.resolve(false);
} else {
if (
NativeAccessibilityManagerIOS?.getCurrentDarkerSystemColorsState !=
null
) {
NativeAccessibilityManagerIOS.getCurrentDarkerSystemColorsState(
resolve,
reject,
);
} else {
reject(null);
}
}
});
},
/**
* Query whether reduce motion and prefer cross-fade transitions settings are currently enabled.
*
@@ -340,6 +368,9 @@ const AccessibilityInfo = {
* - `announcement`: The string announced by the screen reader.
* - `success`: A boolean indicating whether the announcement was
* successfully made.
* - `darkerSystemColorsChanged`: iOS-only event. Fires when the state of the dark system colors
* toggle changes. The argument to the event handler is a boolean. The boolean is `true` when
* dark system colors is enabled and `false` otherwise.
*
* These events are only supported on Android:
*
@@ -1583,6 +1583,7 @@ type AccessibilityEventDefinitionsIOS = {
grayscaleChanged: [boolean],
invertColorsChanged: [boolean],
reduceTransparencyChanged: [boolean],
darkerSystemColorsChanged: [boolean],
};
type AccessibilityEventDefinitions = {
...AccessibilityEventDefinitionsAndroid,
@@ -1598,6 +1599,7 @@ declare const AccessibilityInfo: {
isInvertColorsEnabled(): Promise<boolean>,
isReduceMotionEnabled(): Promise<boolean>,
isHighTextContrastEnabled(): Promise<boolean>,
isDarkerSystemColorsEnabled(): Promise<boolean>,
prefersCrossFadeTransitions(): Promise<boolean>,
isReduceTransparencyEnabled(): Promise<boolean>,
isScreenReaderEnabled(): Promise<boolean>,
@@ -24,6 +24,7 @@ extern NSString *const RCTAccessibilityManagerDidUpdateMultiplierNotification; /
@property (nonatomic, assign) BOOL isGrayscaleEnabled;
@property (nonatomic, assign) BOOL isInvertColorsEnabled;
@property (nonatomic, assign) BOOL isReduceMotionEnabled;
@property (nonatomic, assign) BOOL isDarkerSystemColorsEnabled;
@property (nonatomic, assign) BOOL prefersCrossFadeTransitions;
@property (nonatomic, assign) BOOL isReduceTransparencyEnabled;
@property (nonatomic, assign) BOOL isVoiceOverEnabled;
@@ -76,6 +76,11 @@ RCT_EXPORT_MODULE()
name:UIAccessibilityReduceMotionStatusDidChangeNotification
object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(darkerSystemColorsDidChange:)
name:UIAccessibilityDarkerSystemColorsStatusDidChangeNotification
object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(reduceTransparencyStatusDidChange:)
name:UIAccessibilityReduceTransparencyStatusDidChangeNotification
@@ -91,6 +96,7 @@ RCT_EXPORT_MODULE()
_isGrayscaleEnabled = UIAccessibilityIsGrayscaleEnabled();
_isInvertColorsEnabled = UIAccessibilityIsInvertColorsEnabled();
_isReduceMotionEnabled = UIAccessibilityIsReduceMotionEnabled();
_isDarkerSystemColorsEnabled = UIAccessibilityDarkerSystemColorsEnabled();
_isReduceTransparencyEnabled = UIAccessibilityIsReduceTransparencyEnabled();
_isVoiceOverEnabled = UIAccessibilityIsVoiceOverRunning();
}
@@ -169,6 +175,20 @@ RCT_EXPORT_MODULE()
}
}
- (void)darkerSystemColorsDidChange:(__unused NSNotification *)notification
{
BOOL newDarkerSystemColorsEnabled = UIAccessibilityDarkerSystemColorsEnabled();
if (_isDarkerSystemColorsEnabled != newDarkerSystemColorsEnabled) {
_isDarkerSystemColorsEnabled = newDarkerSystemColorsEnabled;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
[[_moduleRegistry moduleForName:"EventDispatcher"] sendDeviceEventWithName:@"darkerSystemColorsChanged"
body:@(_isDarkerSystemColorsEnabled)];
#pragma clang diagnostic pop
}
}
- (void)reduceTransparencyStatusDidChange:(__unused NSNotification *)notification
{
BOOL newReduceTransparencyEnabled = UIAccessibilityIsReduceTransparencyEnabled();
@@ -354,6 +374,13 @@ RCT_EXPORT_METHOD(getCurrentReduceMotionState
onSuccess(@[ @(_isReduceMotionEnabled) ]);
}
RCT_EXPORT_METHOD(getCurrentDarkerSystemColorsState
: (RCTResponseSenderBlock)onSuccess onError
: (__unused RCTResponseSenderBlock)onError)
{
onSuccess(@[ @(_isDarkerSystemColorsEnabled) ]);
}
RCT_EXPORT_METHOD(getCurrentPrefersCrossFadeTransitionsState
: (RCTResponseSenderBlock)onSuccess onError
: (__unused RCTResponseSenderBlock)onError)
+1
View File
@@ -152,6 +152,7 @@ jest
isInvertColorsEnabled: jest.fn(() => Promise.resolve(false)),
isReduceMotionEnabled: jest.fn(() => Promise.resolve(false)),
isHighTextContrastEnabled: jest.fn(() => Promise.resolve(false)),
isDarkerSystemColorsEnabled: jest.fn(() => Promise.resolve(false)),
prefersCrossFadeTransitions: jest.fn(() => Promise.resolve(false)),
isReduceTransparencyEnabled: jest.fn(() => Promise.resolve(false)),
isScreenReaderEnabled: jest.fn(() => Promise.resolve(false)),
@@ -29,6 +29,10 @@ export interface Spec extends TurboModule {
onSuccess: (isReduceMotionEnabled: boolean) => void,
onError: (error: Object) => void,
) => void;
+getCurrentDarkerSystemColorsState?: (
onSuccess: (isDarkerSystemColorsEnabled: boolean) => void,
onError: (error: Object) => void,
) => void;
+getCurrentPrefersCrossFadeTransitionsState?: (
onSuccess: (prefersCrossFadeTransitions: boolean) => void,
onError: (error: Object) => void,