<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -",
    "macCatalyst: 17.0.0 -",
    "macOS: 14.0.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "SwiftUI",
  "identifier" : "/documentation/SwiftUI/View/onKeyPress(_:action:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "SwiftUI"
    ],
    "preciseIdentifier" : "s:7SwiftUI4ViewPAAE10onKeyPress_6actionQrAA0E10EquivalentV_AA0eF0V6ResultOyctF"
  },
  "title" : "onKeyPress(_:action:)"
}
-->

# onKeyPress(_:action:)

Performs an action if the user presses a key on a hardware keyboard
while the view has focus.

```
nonisolated func onKeyPress(_ key: KeyEquivalent, action: @escaping () -> KeyPress.Result) -> some View
```

## Parameters

`key`

The key to match against incoming hardware keyboard events.

`action`

The action to perform. Return `.handled` to consume the
event and prevent further dispatch, or `.ignored` to allow dispatch
to continue.

## Return Value

A modified view that binds hardware keyboard input
when focused.

## Discussion

SwiftUI performs the action for key-down and key-repeat events.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)