textinput

Documentation

Overview

Package textinput provides a text-inputting controller. This package is experimental and the API might be changed in the future.

This package is supported by macOS and Web browsers so far.

Index

• func Start(x, y int) (states chan State, close func())
• type State

Functions

func Start

func Start(x, y int) (states chan State, close func())

Start starts text inputting. Start returns a channel to send the state repeatedly, and a function to end the text inputting.

Start returns nil and nil if the current environment doesn't support this package.

Types

type State

type State struct {
	// Text represents the current inputting text.
	Text string

	// CompositionSelectionStartInBytes represents the start position of the selection in bytes.
	CompositionSelectionStartInBytes int

	// CompositionSelectionStartInBytes represents the end position of the selection in bytes.
	CompositionSelectionEndInBytes int

	// Committed reports whether the current Text is the settled text.
	Committed bool
}

State represents the current state of text inputting.