Toggle

A controlled native SwiftUI on/off switch.

#Import

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

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

<Host matchContents>
  <Toggle
    label="Notifications"
    isOn={notifications()}
    onIsOnChange={setNotifications}
  />
</Host>

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

Toggle(props: ToggleProps): NativeNode

testIDstring—

Stable identifier exposed to macOS accessibility and UI testing.

string

modifiersViewModifier[]—

SwiftUI modifiers, applied in array order.

ViewModifier[]

isOnboolean—

Controlled SwiftUI `isOn` value.

boolean

labelstring—

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

string

onIsOnChange(isOn: boolean, event: QuickGuiEvent) => void—

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

(isOn: boolean, event: QuickGuiEvent) => void

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

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

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