KeyEquivalent

struct · iOS 14.0+ · SDK 27.1

struct KeyEquivalent

Key equivalents consist of a letter, punctuation, or function key that can be combined with an optional set of modifier keys to specify a keyboard shortcut. Key equivalents are used to establish keyboard shortcuts to app functionality. Any key can be used as a key equivalent as long as pressing it produces a single character value. Key equivalents are typically initialized using a single-character string literal, with constants for unprintable or hard-to-type values. The modifier keys necessary to type a key equivalent are factored in to the resulting keyboard shortcut. That is, a key equivalent whose raw value is the capitalized string "A" corresponds with the keyboard shortcut Command-Shift-A. The exact mapping may depend on the keyboard layout—for example, a key equivalent with the character value "}" produces a shortcut equivalent to Command-Shift-] on ANSI keyboards, but would produce a different shortcut for keyboard layouts where punctuation characters are in different locations.

Members (19)

static get rightArrow(): KeyEquivalent

static let rightArrow: KeyEquivalent

static get deleteForward(): KeyEquivalent

static let deleteForward: KeyEquivalent

static initExtendedGraphemeClusterLiteral(extendedGraphemeClusterLiteral: string): KeyEquivalent

init(extendedGraphemeClusterLiteral: Character)

static get end(): KeyEquivalent

static let end: KeyEquivalent

static get tab(): KeyEquivalent

static let tab: KeyEquivalent

static get home(): KeyEquivalent

static let home: KeyEquivalent

static get clear(): KeyEquivalent

static let clear: KeyEquivalent

static get space(): KeyEquivalent

static let space: KeyEquivalent

static get delete(): KeyEquivalent

static let delete: KeyEquivalent

static get escape(): KeyEquivalent

static let escape: KeyEquivalent

static get pageUp(): KeyEquivalent

static let pageUp: KeyEquivalent

static get return(): KeyEquivalent

static let `return`: KeyEquivalent

static get upArrow(): KeyEquivalent

static let upArrow: KeyEquivalent

static get pageDown(): KeyEquivalent

static let pageDown: KeyEquivalent

get character(): string

var character: Character

set character(value: string)

var character: Character

static get downArrow(): KeyEquivalent

static let downArrow: KeyEquivalent

static get leftArrow(): KeyEquivalent

static let leftArrow: KeyEquivalent

static init(character: string): KeyEquivalent

init(_ character: Character)

All SwiftUI types →