Skip to content

Add VoiceOver accessibility labels to keyboard keys #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost wants to merge 1 commit into from
+19 −0
Closed

Add VoiceOver accessibility labels to keyboard keys #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Sources/Keyboard/KeyboardKey.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,21 @@ public struct KeyboardKey: View {
var text: String
var isActivatedExternally: Bool

/// Accessibility label that expands symbols to spoken words (e.g. "C 4", "F sharp 3")
var accessibilityNoteLabel: String {
let note = pitch.note(in: .C)
let letter = note.noteClass.letter.description
let octave = note.octave
switch note.accidental {
case .sharp:
return "\(letter) sharp \(octave)"
case .flat:
return "\(letter) flat \(octave)"
default:
return "\(letter) \(octave)"
}
}

var keyColor: Color {
if isActivatedExternally || isActivated {
return pressedColor
Expand Down Expand Up @@ -121,6 +136,10 @@ public struct KeyboardKey: View {
.foregroundColor(textColor)
.padding(relativeFontSize(in: proxy.size) / 3.0)
}
.accessibilityElement(children: .ignore)
.accessibilityLabel(accessibilityNoteLabel)
.accessibilityAddTraits(.isButton)
.accessibilityValue(isActivated || isActivatedExternally ? "pressed" : "not pressed")
}
}
}
Loading