Modifiers
mask
Applies a mask to the view.
mask(shape, cornerRadius)
| Parameter | Type | Description |
|---|---|---|
shape | 'circle' | 'ellipse' | 'roundedRectangle' | 'capsule' | 'rectangle' | 'containerRelativeShape' | The masking shape. |
cornerRadius(optional) | number | Corner radius for rounded rectangle (default: 8). |
Applies a mask to the view.
Returns: ModifierConfig
See: Official SwiftUI documentation.
Works with
You can add mask to any view. It changes what you see on 38 of the 39 components.
- VStack
- HStack
- ZStack
- LazyVStack
- LazyHStack
- Group
- Divider
- Overlay
- ScrollView
- Button
- Toggle
- Checkbox
- Slider
- Picker
- DatePicker
- ColorPicker
- Link
- ControlGroup
- Menu
- ContextMenu
- TextField
- SecureField
- Text
- Label
- Image
- List
- Form
- Section
- DisclosureGroup
- SwipeActions
- BottomSheet
- Alert
- ConfirmationDialog
- Popover
- ProgressView
- Gauge
- TabView
- AccessoryWidgetBackground
No visible effect
These components accept it, but you see no change.
| Component | Why nothing happens |
|---|---|
| Spacer | It changes how the view is drawn, and Spacer draws nothing that you can see. |
Sources
The original Expo docs for this page:
- mask (Modifiers) (
source-of-truth/versions/v57.0.0/sdk/ui/swift-ui/modifiers.md)