Button

A native SwiftUI button with text, SF Symbol, semantic role, and press handling.

#Import

Import Button from @quickgui/solid/swift-ui.

import { Host, Button } from "@quickgui/solid/swift-ui";

<Host matchContents>
  <Button
    label="Continue"
    systemImage="arrow.right"
    onPress={continueFlow}
  />
</Host>

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

Button(props: ButtonProps): NativeNode

testIDstring—

Stable identifier exposed to macOS accessibility and UI testing.

string

modifiersViewModifier[]—

SwiftUI modifiers, applied in array order.

ViewModifier[]

labelstring—

The text label for a simple button.

string

systemImagestring—

An SF Symbols name shown beside `label`.

string

roleButtonRole—

Semantic SwiftUI button role.

ButtonRole

onPress(event: QuickGuiEvent) => void—

Called when the native SwiftUI button is pressed.

(event: QuickGuiEvent) => void

targetstring—

Identifier reserved for widget and live-activity button targets.

string

childrenunknown—

Optional nested text used as the label when `label` is omitted.

unknown

ref((node: NativeNode) => void) | NativeNode—

Declares ref (optional). Reactive JSX expressions update this property in place.

((node: NativeNode) => void) | NativeNode