Field

将控件与标签、说明、验证状态和错误信息关联起来。

正在加载交互演示…

func FieldExample() *ui.Element {
	email, setEmail := ui.CreateSignal("")
	field := ui.NewField(ui.FieldRootProps{Required: true, Filled: func() bool {
		return email() != ""
	}})
	return field.Root().Children(
		field.Label().Child("Email"),
		field.Control(ui.FieldControlProps{InputPartProps: ui.InputPartProps{Value: email, Placeholder: "you@example.com", OnInput: func(event *native.Event) {
			setEmail(event.Value)
		}}}),
		field.Description().Child("Used for receipts"),
		field.Error().Child("Enter a valid email address"),
	)
}

#导入

从 github.com/egoist/quickgui/go/ui 导入 ui。

import (
	"github.com/egoist/quickgui/go/native"
	"github.com/egoist/quickgui/go/ui"
)

#用法

func FieldExample() *ui.Element {
	email, setEmail := ui.CreateSignal("")
	field := ui.NewField(ui.FieldRootProps{Required: true, Filled: func() bool {
		return email() != ""
	}})
	return field.Root().Children(
		field.Label().Child("Email"),
		field.Control(ui.FieldControlProps{InputPartProps: ui.InputPartProps{Value: email, Placeholder: "you@example.com", OnInput: func(event *native.Event) {
			setEmail(event.Value)
		}}}),
		field.Description().Child("Used for receipts"),
		field.Error().Child("Enter a valid email address"),
	)
}

#结构

field.Root
field.Item
field.Label
field.Control
field.Validity
field.Description
field.Error

#API 参考

展开条目查看说明和完整签名。短横线表示声明中未记录默认值。

`NewField`

查看源码

ui.NewField(props ...FieldRootProps) *FieldComponent

NewField declares a Field instance. Optional props provide initial settings.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

Invalidfunc() bool—

Projects invalid state to the field and its parts.

func() bool

查看源码

Requiredbool—

Marks the control as required for validation and accessibility.

bool

查看源码

Touchedfunc() bool—

Whether the user has interacted with the field.

func() bool

查看源码

Dirtyfunc() bool—

Whether the field value has changed from its initial value.

func() bool

查看源码

Filledfunc() bool—

Whether the associated control contains a value.

func() bool

查看源码

ValidationMessagefunc() string—

Bounded message exposed to error content and accessibility.

func() string

查看源码

ValidationModestring—

Selects which interaction boundary triggers validation.

string

查看源码

ValidationDebounceTimeany—

Delay before deferred validation runs after an edit.

any

查看源码

OnValidationChangefunc(FieldValidationDetails, *native.Event)—

Reports the validation trigger and timing selected by the core.

func(FieldValidationDetails, *native.Event)

查看源码

`Field.Disabled`

查看源码

field.Disabled(value any) *FieldComponent

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

`Field.Invalid`

查看源码

field.Invalid(value any) *FieldComponent

Projects invalid state to the field and its parts.

`Field.Required`

查看源码

field.Required(value bool) *FieldComponent

Marks the control as required for validation and accessibility.

`Field.Touched`

查看源码

field.Touched(value any) *FieldComponent

Whether the user has interacted with the field.

`Field.Dirty`

查看源码

field.Dirty(value any) *FieldComponent

Whether the field value has changed from its initial value.

`Field.Filled`

查看源码

field.Filled(value any) *FieldComponent

Whether the associated control contains a value.

`Field.ValidationMessage`

查看源码

field.ValidationMessage(value any) *FieldComponent

Bounded message exposed to error content and accessibility.

`Field.ValidationMode`

查看源码

field.ValidationMode(value string) *FieldComponent

Selects which interaction boundary triggers validation.

`Field.ValidationDebounceTime`

查看源码

field.ValidationDebounceTime(value any) *FieldComponent

Delay before deferred validation runs after an edit.

`Field.OnValidationChange`

查看源码

field.OnValidationChange(value func(FieldValidationDetails, *native.Event)) *FieldComponent

Reports the validation trigger and timing selected by the core.

`Field.Root`

查看源码

field.Root() *Element

Configures root for this part. The declared type and source define the accepted value.

`Field.Label`

查看源码

field.Label(options ...FieldLabelProps) *Element

Visible native SwiftUI control label.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

Passivebool—

Controls whether the surface is presented without activating its owner.

bool

查看源码

`Field.Control`

查看源码

field.Control(options ...FieldControlProps) *Element

Configures control for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

Typestring—

Input editing mode for this control.

string

查看源码

Valueany—

The current controlled value. Update application state from the change callback to accept a new value.

any

查看源码

Placeholderstring—

Hint displayed while the text value is empty.

string

查看源码

Multilinebool—

Allows multiple lines in the core text editor.

bool

查看源码

OnInputfunc(*native.Event)—

Receives edits from the text control. Write the new text into the controlled value.

func(*native.Event)

查看源码

OnChangefunc(*native.Event)—

Callback for change. The signature below lists the event payload.

func(*native.Event)

查看源码

OnSubmitfunc(*native.Event)—

Called when the control submits its current value.

func(*native.Event)

查看源码

ElementFieldControlElement—

Retained native element used by this component part.

FieldControlElement

查看源码

`Field.Description`

查看源码

field.Description(options ...PartProps) *Element

Configures description for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

`Field.Item`

查看源码

field.Item(options ...PartProps) *Element

Configures item for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

`Field.Validity`

查看源码

field.Validity(options ...FieldValidityProps) *Element

Configures validity for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

Visible*bool—

Whether the component is presented.

*bool

查看源码

`Field.Error`

查看源码

field.Error(options ...PartProps) *Element

Configures error for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

查看源码

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

查看源码

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

查看源码

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

查看源码

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

查看源码

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

查看源码

Groupany—

Names this element as a group for descendant interaction-state styling.

any

查看源码

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

查看源码

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

查看源码

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

查看源码

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

查看源码

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

查看源码

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

查看源码

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

查看源码

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

查看源码

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

查看源码

`Element`

查看源码

part.Child(content).Style(style)

Every part returns a fluent element. Strings, numbers, elements, and deferred child factories compose directly.

ChildChild(child any) *Element—

Child appends content and returns this element. Content can be an element, native node, scalar, accessor, or node-returning construction callback.

Child(child any) *Element

查看源码

ChildrenChildren(children ...any) *Element—

Children appends multiple children in order without replacing existing content. It also accepts []any, []*Element, and []*native.Node slices as arguments. Read the retained child nodes through element.Node.Children.

Children(children ...any) *Element

查看源码

StyleStyle(style StyleBuilder) *Element—

Style merges a reusable style. Scalar accessors retain independent native bindings.

Style(style StyleBuilder) *Element

查看源码

OnClickOnClick(handler func()) *Element—

OnClick handles a click without an unused event parameter.

OnClick(handler func()) *Element

查看源码

RefRef(handler func(*native.Node)) *Element—

Ref exposes the native handle once at this point in the declaration chain.

Ref(handler func(*native.Node)) *Element

查看源码