Skip to content
Documentation
Components
Composite
Toggle Field

Toggle Field

A toggle field combines a toggle with a label, a supporting text and an error text, like the other form fields. Use it for on/off settings in forms.

Toggle Field

func view(wnd core.Window) core.View {
    newsletter := core.AutoState[bool](wnd).Init(func() bool { return true })
    tracking := core.AutoState[bool](wnd)

    return VStack(
        ToggleField("Newsletter", newsletter.Get()).
            InputValue(newsletter).
            SupportingText("Receive product news once a month"),
        ToggleField("Usage statistics", tracking.Get()).
            InputValue(tracking).
            ErrorText("Required by your organization"),
    ).Alignment(Leading).Gap(L16)
}

Constructors 

func ToggleField(label string, value bool) TToggleField

A ToggleField aggregates a toggle together with form field typical labels, hints and error texts.

Methods

MethodDescription
AccessibilityLabel(label string) DecoredViewAccessibilityLabel sets the accessibility label for screen readers.
Border(border Border) DecoredViewBorder sets the border styling of the toggle field.
Disabled(disabled bool) TToggleFieldDisabled sets the disabled state of the toggle field
ErrorText(text string) TToggleFieldErrorText sets the error message displayed when validation fails.
Frame(frame Frame) DecoredViewFrame sets the layout frame of the toggle field.
ID(id string) TToggleFieldID sets the ID of the toggle field
InputValue(inputValue *core.State[bool]) TToggleFieldInputValue binds the toggle field to a reactive state for two-way binding.
Label(label string) TToggleFieldLabel sets the label above the field.
Padding(padding Padding) DecoredViewPadding sets the inner padding of the toggle field.
SupportingText(text string) TToggleFieldSupportingText sets optional supporting text displayed below the field.
Value(value bool) TToggleFieldValue sets the current value.
Visible(visible bool) DecoredViewVisible controls the visibility of the toggle field.
WithFrame(fn func(Frame) Frame) DecoredViewWithFrame modifies the layout frame using the provided function.

Related