TimeField

A segmented, keyboard-editable time field with hour, minute, second, and period parts.

Loading interactive demo…

func TimeFieldExample() *ui.Element {
	field := ui.NewTimeField().DefaultValue("09:30").Hour12(true)
	segments := make([]*ui.Element, 0, 3)
	for _, segment := range []string{"hour", "minute", "period"} {
		segments = append(segments, field.Segment(segment))
	}
	return field.Root().Children(segments)
}

#Import

Import ui from github.com/egoist/quickgui/go/ui.

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

#Usage

func TimeFieldExample() *ui.Element {
	field := ui.NewTimeField().DefaultValue("09:30").Hour12(true)
	segments := make([]*ui.Element, 0, 3)
	for _, segment := range []string{"hour", "minute", "period"} {
		segments = append(segments, field.Segment(segment))
	}
	return field.Root().Children(segments)
}

#Anatomy

timeField.Root
timeField.Segment

#API reference

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

`NewTimeField`

View source

ui.NewTimeField(props ...TimeFieldRootProps) *TimeFieldComponent

NewTimeField declares a TimeField 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)

View source

Styleany—

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

any

View source

ChildrenPartChildren—

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

PartChildren

View source

Disabledany—

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

any

View source

Rolestring—

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

string

View source

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

View source

Groupany—

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

any

View source

AriaLabelany—

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

any

View source

TabIndex*float64—

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

*float64

View source

OnClickfunc(*native.Event)—

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

func(*native.Event)

View source

OnDoubleClickfunc(*native.Event)—

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

func(*native.Event)

View source

OnContextMenufunc(*native.Event)—

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

func(*native.Event)

View source

OnPointerfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseEnterfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseLeavefunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseDownfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseUpfunc(*native.Event)—

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

func(*native.Event)

View source

OnKeyDownfunc(*native.Event)—

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

func(*native.Event)

View source

OnKeyUpfunc(*native.Event)—

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

func(*native.Event)

View source

OnFocusfunc(*native.Event)—

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

func(*native.Event)

View source

OnBlurfunc(*native.Event)—

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

func(*native.Event)

View source

Valuefunc() *string—

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

func() *string

View source

DefaultValuestring—

Initial value for uncontrolled state. Use Value when the application should own subsequent changes.

string

View source

Minstring—

Lower bound of the accepted value.

string

View source

Maxstring—

Upper bound of the accepted value.

string

View source

OnValueChangefunc(*string, *native.Event)—

Reports an accepted value change. Use the callback payload to update controlled state.

func(*string, *native.Event)

View source

Hour12bool—

Uses a twelve-hour clock with an AM/PM segment.

bool

View source

ShowSecondsbool—

Mounts a seconds segment.

bool

View source

`TimeField.Disabled`

View source

timeField.Disabled(value any) *TimeFieldComponent

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

`TimeField.Value`

View source

timeField.Value(value any) *TimeFieldComponent

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

`TimeField.DefaultValue`

View source

timeField.DefaultValue(value string) *TimeFieldComponent

Initial value for uncontrolled state. Use Value when the application should own subsequent changes.

`TimeField.Min`

View source

timeField.Min(value string) *TimeFieldComponent

Lower bound of the accepted value.

`TimeField.Max`

View source

timeField.Max(value string) *TimeFieldComponent

Upper bound of the accepted value.

`TimeField.OnValueChange`

View source

timeField.OnValueChange(value func(*string, *native.Event)) *TimeFieldComponent

Reports an accepted value change. Use the callback payload to update controlled state.

`TimeField.Hour12`

View source

timeField.Hour12(value bool) *TimeFieldComponent

Uses a twelve-hour clock with an AM/PM segment.

`TimeField.ShowSeconds`

View source

timeField.ShowSeconds(value bool) *TimeFieldComponent

Mounts a seconds segment.

`TimeField.Root`

View source

timeField.Root() *Element

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

`TimeField.Segment`

View source

timeField.Segment(value string, options ...TimeFieldSegmentProps) *Element

Date or time segment represented by this editable part.

`TimeField.SegmentWith`

View source

timeField.SegmentWith(props TimeFieldSegmentProps) *Element

SegmentWith supplies explicit properties for this part.

Reffunc(*native.Node)—

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

func(*native.Node)

View source

Styleany—

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

any

View source

ChildrenPartChildren—

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

PartChildren

View source

Disabledany—

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

any

View source

Rolestring—

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

string

View source

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

View source

Groupany—

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

any

View source

AriaLabelany—

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

any

View source

TabIndex*float64—

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

*float64

View source

OnClickfunc(*native.Event)—

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

func(*native.Event)

View source

OnDoubleClickfunc(*native.Event)—

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

func(*native.Event)

View source

OnContextMenufunc(*native.Event)—

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

func(*native.Event)

View source

OnPointerfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseEnterfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseLeavefunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseDownfunc(*native.Event)—

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

func(*native.Event)

View source

OnMouseUpfunc(*native.Event)—

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

func(*native.Event)

View source

OnKeyDownfunc(*native.Event)—

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

func(*native.Event)

View source

OnKeyUpfunc(*native.Event)—

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

func(*native.Event)

View source

OnFocusfunc(*native.Event)—

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

func(*native.Event)

View source

OnBlurfunc(*native.Event)—

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

func(*native.Event)

View source

Segmentstring—

Date or time segment represented by this editable part.

string

View source

`Element`

View source

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

View source

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

View source

StyleStyle(style StyleBuilder) *Element—

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

Style(style StyleBuilder) *Element

View source

OnClickOnClick(handler func()) *Element—

OnClick handles a click without an unused event parameter.

OnClick(handler func()) *Element

View source

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

View source