A control that performs an action when triggered.
SDKs
Framework
struct Button<Label> where Label : View
The method of “triggering” the button may vary. For example, on iOS a button is triggered by tapping it onscreen, whereas on tvOS it’s triggered by pressing “select” on an external remote while the button is focused.
func frame(width: CGFloat?, height: CGFloat?, alignment: Alignment) -> ViewPositions this view within an invisible frame with the specified size.
func frame(minPositions this view within an invisible frame with the specified width and height characteristics.
func fixedFixes this view at its ideal size.
func fixedFixes this view at its ideal size in the specified dimensions.
func layoutSets the priority by which a parent layout should apportion space to this child.
func position(CGPoint) -> ViewFixes the center of this view at the specified point in its parent’s coordinate space.
func position(x: CGFloat, y: CGFloat) -> ViewFixes the center of this view at the specified coordinates in its parent’s coordinate space.
func offset(CGSize) -> ViewOffsets this view by the horizontal and vertical distances in the given size.
func offset(x: CGFloat, y: CGFloat) -> ViewOffsets this view by the specified horizontal and vertical distances.
func edgesExtends the view out of the safe area on the specified edges.
func alignmentReturns a view modified so that its value for the given guide is the result of passing the View of the underlying view to compute.
func alignmentReturns a view modified so that its value for the given guide is the result of passing the View of the underlying view to compute.
func padding(CGFloat) -> ViewPads this view along all edge insets by the amount you specify.
func padding(EdgePads this view using the edge insets you specify.
func padding(EdgePads this view using the edge insets you specify.
func overlay<Overlay>(Overlay, alignment: Alignment) -> ViewLayers a secondary view in front of this view.
func foregroundSet the foreground color within self.
func zSets the Z index for an item.
func border<S>(S, width: CGFloat) -> ViewAdds a border to this view with the specified style and width.
func border<S>(S, width: CGFloat, cornerAdds a border to this view with the given style, width, and corner radius.
func clipped(antialiased: Bool) -> ViewClips this view to its bounding rectangular frame.
func clipSets a clipping shape for this view.
func cornerClips this view to its bounding frame, with the specified corner radius.
func scaledScales this view to fill its parent.
func scaledScales this view to fit its parent.
func aspectConstrains this view’s dimensions to the specified aspect ratio.
func aspectConstrains this view’s dimensions to the aspect ratio of the given size.
func imageSet the image scale within self.
func font(Font?) -> ViewSets the default font for text in this view.
func lineSets the maximum number of lines that text can occupy in this view.
func lineSets the amount of space between lines of text in this view.
func minimumSets the minimum amount that text in this view scales down to fit in the available space.
func truncationSets the truncation mode for lines of text that are too long to fit in the available space.
func allowsSets whether text in this view can compress the space between characters when necessary to fit text in a line.
func flipsSets whether this view flips its contents horizontally when the layout direction is right-to-left.
func animation(Animation?) -> ViewApplies the given animation to all animatable values within this view.
func animation<V>(Animation?, value: V) -> ViewApplies the given animation to this view, whenever the specified value changes.
func transition(AnyAssociates a transition with self.
func itemProvides a closure that vends the drag representation to be used for a particular Dynamic.
func transaction((inout Transaction) -> Void) -> ViewApplies the given transaction mutation function to all transactions used within the view.
func onAdds an action to perform when this view appears.
func onAdds an action to perform when this view disappears.
func onAdds an action to perform when the user moves the pointer over or away from this view’s frame.
func focusable(Bool, onSets whether this view is focusable and, if so, adds an action to perform when the view comes into focus.
func onActivates this view as the source of a drag and drop operation.
func onDefines the destination for a drag and drop operation with the same size and position as this view, with behavior controlled by the given delegate.
func onDefines the destination for a drag and drop operation with the same size and position as this view, handling dropped content and the drop location with the given closure.
func onDefines the destination for a drag and drop operation, using the same size and position as this view, handling dropped content with the given closure.
func colorSets this view’s color scheme.
func accentSets the accent color for this view and the views it contains.
func blur(radius: CGFloat, opaque: Bool) -> ViewApplies a Gaussian blur to this view.
func shadow(color: Color, radius: CGFloat, x: CGFloat, y: CGFloat) -> ViewAdds a shadow to this view.
func opacity(Double) -> ViewSets the transparency of this view.
func brightness(Double) -> ViewBrightens this view by the specified amount.
func contrast(Double) -> ViewSets the contrast and separation between similar colors in this view.
func colorInverts the colors in this view.
func colorAdds a color multiplication effect to this view.
func blendSets the blend mode for compositing this view with overlapping views.
func compositingWraps this view in a compositing group.
func drawingComposites this view’s contents into an offscreen image before final display.
func saturation(Double) -> ViewAdjusts the color saturation of this view.
func grayscale(Double) -> ViewAdds a grayscale effect to this view.
func hueApplies a hue rotation effect to this view.
func luminanceAdds a luminance to alpha effect to this view.
func pickerSets the style for Picker within the environment of self.
func dateSets the style for Date within the environment of self
func textSets the style for Text within the environment of self.
func toggleSets the style for Toggle within the environment of self
func listSets the inset to be applied to self in a List.
func listSets the view to be placed behind self when placed in a List
func listSets the color to be apply to the system cell platter when self is placed in a List
func contextAttaches a Context and its children to self.
func contextAdds a contextual menu to this view.
func touchSets the Touch and its content to be shown in the Touch Bar when applicable
func touchPrincipal views have special significance to this TouchBar. Currently, that item will be placed in the center of the row.
func touchThe user-visible String identifying the view’s functionality. Visible during user customization.
func touchThe behavior of the view when being customized by the user. Views may be:
func hidden() -> ViewHides this view.
func disabled(Bool) -> ViewAdds a condition that controls whether users can interact with this view.
func deleteAdds a condition for whether the view hierarchy for self can be deleted.
func moveAdds a condition for whether the view hierarchy for self can be moved.
func preference<K>(key: KReturns a view producing value as the value of preference Key seen by its ancestors.
func transformReturns a view that applies callback(&value) to the value of preference Key that’s seen by its ancestors.
func onAdds an action to perform when the specified preference key’s value changes.
func backgroundReturns a view that reads the value of preference Key from self, uses that to produce another view which is displayed as as the background to self.
func overlayReturns a view that reads the value of preference Key from self, uses that to produce another view which is displayed as an overlay on self.
func environment<V>(WritableReturns a view wrapping self that sets a value for an environment key.
func transformReturns a view wrapping self that transforms the value of the environment key described by key by applying a transform function.
func contentReturns a new view that defines the content shape for hit-testing self as shape. eo defines whether the shape is interpreted using the even-odd winding number rule or not.
func previewOverrides the device for a preview.
func previewProvides a user visible name shown in the editor.
func previewOverrides the size of the container for the preview.
init(action: () -> Void, label: () -> Label)Creates an instance.
var label: LabelDeprecatedfunc defaultSets the default .wheel style Picker item height within self.
func digitalTracks Digital Crown rotations by updating the given binding.
func digitalTracks Digital Crown rotations by updating the given binding.
func tag<V>(V) -> ViewSets the tag of the view, used for selecting from a list of View options.
func trigger()DeprecatedBeta Software
This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.
Learn more about using Apple's beta software