---
title: preferredPencilSqueezeAction
framework: swiftui
role: symbol
role_heading: Instance Property
path: swiftui/environmentvalues/preferredpencilsqueezeaction
---

# preferredPencilSqueezeAction

The action that the user prefers to perform when squeezing their Apple Pencil, as selected in the Settings app.

## Declaration

```swift
var preferredPencilSqueezeAction: PencilPreferredAction { get }
```

## Discussion

Discussion You can read this value by creating a property with the Environment property wrapper and using it inside the action closure of the onPencilSqueeze(perform:) view modifier as an indication of what to do when the user squeezes their Apple Pencil: @Environment(\.preferredPencilSqueezeAction) private var preferredAction

var body: some View {     MyDrawingCanvas()         .onPencilSqueeze { phase in             switch (phase, preferredAction) {                 ...             }         } } In macOS, this value cannot be changed by users and is always set to showContextualPalette.

## See Also

### Recognizing Apple Pencil gestures

- [onPencilDoubleTap(perform:)](swiftui/view/onpencildoubletap(perform:).md)
- [onPencilSqueeze(perform:)](swiftui/view/onpencilsqueeze(perform:).md)
- [preferredPencilDoubleTapAction](swiftui/environmentvalues/preferredpencildoubletapaction.md)
- [PencilPreferredAction](swiftui/pencilpreferredaction.md)
- [PencilDoubleTapGestureValue](swiftui/pencildoubletapgesturevalue.md)
- [PencilSqueezeGestureValue](swiftui/pencilsqueezegesturevalue.md)
- [PencilSqueezeGesturePhase](swiftui/pencilsqueezegesturephase.md)
- [PencilHoverPose](swiftui/pencilhoverpose.md)