render

type Align ¶

type Align uint8

Align is horizontal text alignment.

const (
	AlignStart Align = iota
	AlignCenter
	AlignEnd
)

type Box ¶

type Box struct {
	Tag         uint32
	Background  uint32
	Radius      float32
	BorderWidth float32
	BorderColor uint32
	Opacity     float32 // 0..1
	Clip        bool
	Label       string // accessibility label
	TestID      string // accessibilityIdentifier / view tag, for tests
	Href        string // where a pressable leads (the web host makes it a link)
}

Box is the visual style every view kind shares.

func (m *Box) AppendWire(b []byte) []byte

func (m *Box) ReadWire(r *wire.Reader)

type Changed ¶

type Changed struct {
	Tag  uint32
	Text string
}

Changed reports an input's new text.

func (m *Changed) AppendWire(b []byte) []byte

func (m *Changed) ReadWire(r *wire.Reader)

type Children ¶

type Children struct {
	Tag      uint32
	Children []uint32
}

Children sets a view's child views, in order. Views of Tag not listed are removed. For a scroll view the children go in its content.

func (m *Children) AppendWire(b []byte) []byte

func (m *Children) ReadWire(r *wire.Reader)

type Chrome ¶

type Chrome struct {
	Dark       bool
	Background uint32 // screens, modals, the root
	Text       uint32
	TextMuted  uint32 // unselected tabs
	Accent     uint32 // back buttons, selected tabs
	Bar        uint32 // navigation and tab bar backgrounds
	BarText    uint32 // titles on bars
	Border     uint32 // bar separators
}

Chrome is the theme for what the host draws itself: navigation and tab bars, screen and modal backgrounds, the status bar. Sent when it changes.

func (m *Chrome) AppendWire(b []byte) []byte

func (m *Chrome) ReadWire(r *wire.Reader)

type Commit ¶

type Commit struct {
	Seq  uint64
	Root uint32 // the root view's tag, when it changes; 0 otherwise
	Ops  []Op

	// Where the time went in Go, for diagnostics.
	BuildNs  uint64 // components and reconciliation
	LayoutNs uint64 // flexbox, including text measurement
	Measures uint32 // text measurements that reached the host
}

Commit is one render: apply its ops in order, in one UI-thread pass.

func (m *Commit) AppendWire(b []byte) []byte

func (m *Commit) ReadWire(r *wire.Reader)

type Create ¶

type Create struct {
	Tag  uint32
	Kind Kind
}

Create makes a view for Tag. It is not shown until a Children op places it.

func (m *Create) AppendWire(b []byte) []byte

func (m *Create) ReadWire(r *wire.Reader)

type Destroy ¶

type Destroy struct{ Tags []uint32 }

Destroy forgets views (and removes them from their parents).

func (m *Destroy) AppendWire(b []byte) []byte

func (m *Destroy) ReadWire(r *wire.Reader)

type Dismissed ¶

type Dismissed struct{ Tag uint32 }

Dismissed reports that the user closed a modal (swipe down, back button).

func (m *Dismissed) AppendWire(b []byte) []byte

func (m *Dismissed) ReadWire(r *wire.Reader)

type Fit ¶

type Fit uint8

Fit is how an image fills its frame.

const (
	FitCover Fit = iota
	FitContain
	FitStretch
)

type Font ¶

type Font struct {
	Size   float32
	Weight uint16 // 100..900; 0 means 400
}

Font is shared by text, inputs and measurement.

func (m *Font) AppendWire(b []byte) []byte

func (m *Font) ReadWire(r *wire.Reader)

type Frame ¶

type Frame struct {
	Tag        uint32
	X, Y, W, H float32
}

Frame places a view relative to its parent (scroll views: their content).

func (m *Frame) AppendWire(b []byte) []byte

func (m *Frame) ReadWire(r *wire.Reader)

type Image ¶

type Image struct {
	Tag uint32
	URL string
	Fit Fit
}

func (m *Image) AppendWire(b []byte) []byte

func (m *Image) ReadWire(r *wire.Reader)

type Input ¶

type Input struct {
	Tag         uint32
	Value       string
	Placeholder string
	Font        Font
	Color       uint32
	Secure      bool
	Keyboard    Keyboard
	Multiline   bool // wraps and grows with Return making new lines
}

Input sets a text field. The host replaces the field's text only when it differs, so typing is never interrupted.

func (m *Input) AppendWire(b []byte) []byte

func (m *Input) ReadWire(r *wire.Reader)

type Keyboard ¶

type Keyboard uint8

Keyboard is the soft keyboard an input asks for.

const (
	KeyboardText Keyboard = iota
	KeyboardNumber
	KeyboardEmail
	KeyboardURL
)

type Kind ¶

type Kind uint8

Kind is the native view a tag stands for.

const (
	KindView Kind = iota
	KindText
	KindImage
	KindPressable
	KindScroll
	KindInput
	KindSpinner
	// KindStack is a navigation stack: its children are screens, shown one
	// at a time under a native bar, with native push / pop transitions.
	KindStack
	// KindTabs is a tab bar: its children are the tabs' root views, one
	// shown at a time above the native tab bar.
	KindTabs
	// KindModal is a view presented over everything (a sheet on iOS). It is
	// not placed by a Children op: Present shows it, Destroy dismisses it.
	KindModal
	// KindSwitch is an on/off toggle: UISwitch, Android's Switch.
	KindSwitch
)

type MeasureText ¶

type MeasureText struct {
	Text     string
	Font     Font
	MaxWidth float32 // < 0: no limit
	Lines    uint32
}

MeasureText asks the host for a text's size (synchronous host call).

func (m *MeasureText) AppendWire(b []byte) []byte

func (m *MeasureText) ReadWire(r *wire.Reader)

type Message ¶

type Message interface {
	// contains filtered or unexported methods
}

Message is any top-level message in this schema.

func Decode(b []byte) (Message, error)

func ReadMessage(r *wire.Reader) Message

type Op ¶

type Op interface {
	// contains filtered or unexported methods
}

Op changes one native view.

func ReadOp(r *wire.Reader) Op

type PluginAck ¶

type PluginAck struct{ Err string }

PluginAck answers PluginCall: Err is empty when the call started.

func (m *PluginAck) AppendWire(b []byte) []byte

func (m *PluginAck) ReadWire(r *wire.Reader)

type PluginCall ¶

type PluginCall struct {
	ID     uint64
	Plugin string
	Method string
	Args   string
}

PluginCall asks a native plugin to run a method (synchronous host call). The host answers at once with PluginAck and sends the outcome later as a PluginResult with the same ID. Args and results are JSON.

func (m *PluginCall) AppendWire(b []byte) []byte

func (m *PluginCall) ReadWire(r *wire.Reader)

type PluginResult ¶

type PluginResult struct {
	ID    uint64
	Value string
	Code  string
	Err   string
}

PluginResult is a plugin call's outcome. A failure has a Code ("unavailable", "cancelled", "denied", "not_found", "failed") and Err.

func (m *PluginResult) AppendWire(b []byte) []byte

func (m *PluginResult) ReadWire(r *wire.Reader)

type Popped ¶

type Popped struct {
	Tag   uint32
	Depth uint32
}

Popped reports that the user went back in a stack (back button, swipe or system back), leaving Depth screens.

func (m *Popped) AppendWire(b []byte) []byte

func (m *Popped) ReadWire(r *wire.Reader)

type Present ¶

type Present struct{ Tag uint32 }

Present shows a KindModal view over the app, with the platform's transition.

func (m *Present) AppendWire(b []byte) []byte

func (m *Present) ReadWire(r *wire.Reader)

type Press ¶

type Press struct{ Tag uint32 }

Press reports a tap on a pressable.

func (m *Press) AppendWire(b []byte) []byte

func (m *Press) ReadWire(r *wire.Reader)

type Reattach ¶

type Reattach struct{ Reason string }

Reattach reports a new native view hierarchy for a runtime that is already running (an Android activity created again): Go sends every view again, and the UI carries on with its state.

func (m *Reattach) AppendWire(b []byte) []byte

func (m *Reattach) ReadWire(r *wire.Reader)

type Refresh ¶

type Refresh struct{ Tag uint32 }

Refresh reports that the user pulled a refreshable scroll view.

func (m *Refresh) AppendWire(b []byte) []byte

func (m *Refresh) ReadWire(r *wire.Reader)

type Resized ¶

type Resized struct {
	Tag    uint32
	W, H   float32
	Bottom float32
}

Resized reports the size a stack or tab bar gives its screens. Bottom is how much of that height a bar covers (iOS tabs run under the tab bar); content should keep clear of it.

func (m *Resized) AppendWire(b []byte) []byte

func (m *Resized) ReadWire(r *wire.Reader)

type Screen ¶

type Screen struct {
	Tag   uint32
	Title string
}

Screen sets a stack screen's title. Tag is the screen's root view, a child of a KindStack view.

func (m *Screen) AppendWire(b []byte) []byte

func (m *Screen) ReadWire(r *wire.Reader)

type Scroll ¶

type Scroll struct {
	Tag        uint32
	W, H       float32
	Horizontal bool
	Report     bool
	// Refreshable shows pull to refresh; pulling sends Refresh. Refreshing
	// keeps the indicator showing until Go clears it.
	Refreshable bool
	Refreshing  bool
}

Scroll sets a scroll view's content size. With Report, the host sends Scrolled whenever the view scrolls (lists need it to know what to show).

func (m *Scroll) AppendWire(b []byte) []byte

func (m *Scroll) ReadWire(r *wire.Reader)

type Scrolled ¶

type Scrolled struct {
	Tag  uint32
	X, Y float32
	W, H float32
}

Scrolled reports a scroll view's offset and visible size (only for views whose Scroll op asked for it).

func (m *Scrolled) AppendWire(b []byte) []byte

func (m *Scrolled) ReadWire(r *wire.Reader)

type Selected ¶

type Selected struct {
	Tag   uint32
	Index uint32
}

Selected reports that the user picked the tab at Index.

func (m *Selected) AppendWire(b []byte) []byte

func (m *Selected) ReadWire(r *wire.Reader)

type Spinner ¶

type Spinner struct {
	Tag   uint32
	Color uint32
}

func (m *Spinner) AppendWire(b []byte) []byte

func (m *Spinner) ReadWire(r *wire.Reader)

type Switch ¶

type Switch struct {
	Tag     uint32
	On      bool
	Enabled bool
	Tint    uint32 // the on color; 0 is the platform's
}

Switch sets a toggle's state.

func (m *Switch) AppendWire(b []byte) []byte

func (m *Switch) ReadWire(r *wire.Reader)

type TabItem ¶

type TabItem struct {
	Tag   uint32
	Title string
	Icon  string
}

TabItem sets a tab's title and icon (an SF Symbol name on iOS). Tag is the tab's root view, a child of a KindTabs view.

func (m *TabItem) AppendWire(b []byte) []byte

func (m *TabItem) ReadWire(r *wire.Reader)

type TabSelect ¶

type TabSelect struct {
	Tag   uint32
	Index uint32
}

TabSelect shows the tab at Index.

func (m *TabSelect) AppendWire(b []byte) []byte

func (m *TabSelect) ReadWire(r *wire.Reader)

type Text ¶

type Text struct {
	Tag   uint32
	Text  string
	Font  Font
	Color uint32
	Align Align
	Lines uint32 // 0 = unlimited; truncated with an ellipsis
}

Text sets a text view's content and style.

func (m *Text) AppendWire(b []byte) []byte

func (m *Text) ReadWire(r *wire.Reader)

type TextSize ¶

type TextSize struct{ W, H float32 }

TextSize answers MeasureText.

func (m *TextSize) AppendWire(b []byte) []byte

func (m *TextSize) ReadWire(r *wire.Reader)

type Toggled ¶

type Toggled struct {
	Tag uint32
	On  bool
}

Toggled reports that the user flipped a switch.

func (m *Toggled) AppendWire(b []byte) []byte

func (m *Toggled) ReadWire(r *wire.Reader)

type Viewport ¶

type Viewport struct {
	W, H                float32
	Scale               float32 // pixels per point / dp
	SafeTop, SafeBottom float32
	SafeLeft, SafeRight float32
	Platform            string // "ios" | "android"
	Dark                bool
	// Keyboard is how far the on-screen keyboard covers the root view from
	// its bottom edge; 0 when hidden or when the window already shrank.
	Keyboard float32
}

Viewport is the space the root fills; hosts send it at start and whenever it changes.

func (m *Viewport) AppendWire(b []byte) []byte

func (m *Viewport) ReadWire(r *wire.Reader)