Structure¶

ButtonStyleConfiguration¶

The properties of a button.¶

Declaration¶

struct ButtonStyleConfiguration

Overview¶

This property represents the view state of the Button that ButtonStyle modifies. ButtonStyleConfiguration consists of a label representing the button view, and isPressed, which indicates whether or not the button is currently being pressed.

Here, we create a custom MyButtonStyle, which has a RoundedRectangle background as well as a scaleEffect(_:anchor:) view modifier applied to the label which acts on the isPressed property.

struct MyButtonStyle: ButtonStyle {
    var background: some View {
        RoundedRectangle(cornerRadius: 10, style: .continuous)
            .fill(Color.orange)
            .opacity(0.3)
    }

    func makeBody(configuration: Configuration) -> some View {
        configuration.label
            .padding(20)
            .background(background)
            .scaleEffect(configuration.isPressed ? 0.95 : 1)
    }
}

This new ButtonStyle could then be applied to a Button within a View:

struct ContentView: View {
    var body: some View {
        Button("Press me!", action: { })
            .buttonStyle(MyButtonStyle())
    }
}

A gif displaying a gray button reading "Press Me!" that turns blue once pressed; the button is of a custom buttonstyle, which specifies the color change using .isPressed within the .background modifier.

Availability¶

iOS 13.0+

macOS 10.15+

tvOS 13.0+

watchOS 6.0+

Topics¶

Instance Property¶

isPressed A Boolean that indicates whether the user is currently pressing the button.

label A view that describes the effect of pressing the button.

Structure¶

Label A type-erased label of a button.