Skip to content

Commit 5ac6765

Browse files
committed
Add default accessibility parameters to send alongside each request
1 parent 85311a7 commit 5ac6765

File tree

2 files changed

+45
-4
lines changed

2 files changed

+45
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,27 @@ TelemetryDeck.signal("Database.updated", parameters: ["numberOfDatabaseEntries":
7474

7575
TelemetryDeck will automatically send base parameters, such as:
7676

77+
- TelemetryDeck.Accessibility.isBoldTextEnabled
78+
- TelemetryDeck.Accessibility.isDarkerSystemColorsEnabled
79+
- TelemetryDeck.Accessibility.isInvertColorsEnabled
80+
- TelemetryDeck.Accessibility.isReduceMotionEnabled
81+
- TelemetryDeck.Accessibility.isReduceTransparencyEnabled
82+
- TelemetryDeck.Accessibility.isSwitchControlEnabled
83+
- TelemetryDeck.Accessibility.isVoiceOverEnabled
84+
- TelemetryDeck.Accessibility.preferredContentSizeCategory
85+
- TelemetryDeck.Accessibility.shouldDifferentiateWithoutColor
86+
- TelemetryDeck.Accessibility.userInterfaceLayoutDirection
7787
- TelemetryDeck.AppInfo.buildNumber
7888
- TelemetryDeck.AppInfo.version
7989
- TelemetryDeck.Device.architecture
8090
- TelemetryDeck.Device.modelName
8191
- TelemetryDeck.Device.operatingSystem
82-
- TelemetryDeck.Device.platform
8392
- TelemetryDeck.Device.orientation
93+
- TelemetryDeck.Device.platform
8494
- TelemetryDeck.Device.screenResolutionHeight
8595
- TelemetryDeck.Device.screenResolutionWidth
86-
- TelemetryDeck.Device.systemMajorVersion
8796
- TelemetryDeck.Device.systemMajorMinorVersion
97+
- TelemetryDeck.Device.systemMajorVersion
8898
- TelemetryDeck.Device.systemVersion
8999
- TelemetryDeck.Device.timeZone
90100
- TelemetryDeck.RunContext.isAppStore
@@ -94,9 +104,9 @@ TelemetryDeck will automatically send base parameters, such as:
94104
- TelemetryDeck.RunContext.language
95105
- TelemetryDeck.RunContext.targetEnvironment
96106
- TelemetryDeck.SDK.version
97-
- TelemetryDeck.UserPreference.region
98-
- TelemetryDeck.UserPreference.language
99107
- TelemetryDeck.UserPreference.colorScheme
108+
- TelemetryDeck.UserPreference.language
109+
- TelemetryDeck.UserPreference.region
100110

101111
See our [Grand Renaming article](https://telemetrydeck.com/docs/articles/grand-rename/?source=github) for a full list.
102112

Sources/TelemetryDeck/Signals/Signal.swift

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ public struct DefaultSignalPayload: Encodable {
9999
"TelemetryDeck.UserPreference.colorScheme": Self.colorScheme
100100
]
101101

102+
parameters.merge(self.accessibilityParameters, uniquingKeysWith: { $1 })
103+
102104
if let extensionIdentifier = Self.extensionIdentifier {
103105
// deprecated name
104106
parameters["extensionIdentifier"] = extensionIdentifier
@@ -114,6 +116,35 @@ public struct DefaultSignalPayload: Encodable {
114116
// MARK: - Helpers
115117

116118
extension DefaultSignalPayload {
119+
@MainActor
120+
static var accessibilityParameters: [String: String] {
121+
var a11yParams: [String: String] = [:]
122+
123+
#if os(iOS) || os(tvOS)
124+
a11yParams["TelemetryDeck.Accessibility.isVoiceOverEnabled"] = "\(UIAccessibility.isVoiceOverRunning)"
125+
a11yParams["TelemetryDeck.Accessibility.isReduceMotionEnabled"] = "\(UIAccessibility.isReduceMotionEnabled)"
126+
a11yParams["TelemetryDeck.Accessibility.isBoldTextEnabled"] = "\(UIAccessibility.isBoldTextEnabled)"
127+
a11yParams["TelemetryDeck.Accessibility.isInvertColorsEnabled"] = "\(UIAccessibility.isInvertColorsEnabled)"
128+
a11yParams["TelemetryDeck.Accessibility.isDarkerSystemColorsEnabled"] = "\(UIAccessibility.isDarkerSystemColorsEnabled)"
129+
a11yParams["TelemetryDeck.Accessibility.isReduceTransparencyEnabled"] = "\(UIAccessibility.isReduceTransparencyEnabled)"
130+
if #available(iOS 13.0, *) {
131+
a11yParams["TelemetryDeck.Accessibility.shouldDifferentiateWithoutColor"] = "\(UIAccessibility.shouldDifferentiateWithoutColor)"
132+
}
133+
a11yParams["TelemetryDeck.Accessibility.preferredContentSizeCategory"] = UIApplication.shared.preferredContentSizeCategory.rawValue
134+
a11yParams["TelemetryDeck.Accessibility.preferredContentSizeCategory"] = UIApplication.shared.preferredContentSizeCategory.rawValue
135+
a11yParams["TelemetryDeck.Accessibility.userInterfaceLayoutDirection"] = UIApplication.shared.userInterfaceLayoutDirection == .leftToRight ? "leftToRight" : "rightToLeft"
136+
a11yParams["TelemetryDeck.Accessibility.isSwitchControlEnabled"] = "\(UIAccessibility.isSwitchControlRunning)"
137+
#elseif os(macOS)
138+
a11yParams["TelemetryDeck.Accessibility.isVoiceOverEnabled"] = "\(NSWorkspace.shared.isVoiceOverEnabled)"
139+
if let systemPrefs = UserDefaults.standard.persistentDomain(forName: "com.apple.universalaccess") {
140+
a11yParams["TelemetryDeck.Accessibility.isReduceMotionEnabled"] = "\(systemPrefs["reduceMotion"] as? Bool ?? false)"
141+
a11yParams["TelemetryDeck.Accessibility.isInvertColorsEnabled"] = "\(systemPrefs["InvertColors"] as? Bool ?? false)"
142+
}
143+
#endif
144+
145+
return a11yParams
146+
}
147+
117148
static var isSimulatorOrTestFlight: Bool {
118149
isSimulator || isTestFlight
119150
}

0 commit comments

Comments
 (0)