SwiftUI · IOS API REFERENCE

KeyPress

struct · iOS 17.0+ · SDK 27.1

struct KeyPress

Members (5)

get · iOS 17.0+

characters

TypeScript

get characters(): string

Swift declaration

let characters: String

The characters generated by the pressed key as if no modifier key applies.

get · iOS 17.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 17.0+

key

TypeScript

get key(): KeyEquivalent

Swift declaration

let key: KeyEquivalent

The key equivalent value for the pressed key.

get · iOS 17.0+

phase

TypeScript

get phase(): KeyPress_Phases

Swift declaration

let phase: KeyPress.Phases

The phase of the key-press event (`.down`, `.repeat`, or `.up`).

get · iOS 17.0+

modifiers

TypeScript

get modifiers(): _SwiftUICore_EventModifiers

Swift declaration

let modifiers: EventModifiers

The set of modifier keys the user held in addition to the pressed key.

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUI types →