text

Documentation

Index

• Variables
• func New(ctx context.Context, settings ...Setting) *taro.Program
• func WithReverse(ctx context.Context, t *Text)
• type AcceptedEvent
• type Setting
  • func WithAnimation(image image.Image, creator anim.Creator) Setting
  • func WithInline(location, size geom.Vec2) Setting
  • func WithParams(params *params.Parameters) Setting
  • func WithPlaceholder(placeholder string) Setting
  • func WithPreset(preset string) Setting
  • func WithPrompt(prompt string) Setting
  • func WithResult(result chan<- interface{}) Setting
• type Text
  • func (t *Text) Init() taro.Cmd
  • func (t *Text) Update(msg tea.Msg) (taro.Model, tea.Cmd)
  • func (t *Text) View(state *tty.State)

Variables

var BottomRight stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	location := geom.DEFAULT_SIZE
	location.C -= 1
	location.R -= 1
	return New(
		ctx,
		WithInline(location, geom.DEFAULT_SIZE),
	), nil
}

var FullBottom stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	f := New(
		ctx,
	)
	return f, nil
}

var FullTop stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	f := New(
		ctx,
	)
	return f, nil
}

var Placeholder stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	f := New(
		ctx,
		WithPlaceholder("placeholder"),
		WithPrompt("placeholder example"),
	)
	return f, nil
}

var Preset stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	f := New(
		ctx,
		WithPreset("preset text"),
		WithPrompt("preset example"),
	)
	return f, nil
}

var TopLeft stories.InitFunc = func(ctx context.Context) (mux.Screen, error) {
	return New(
		ctx,
		WithInline(geom.Size{}, geom.DEFAULT_SIZE),
	), nil
}

Functions

func New

func New(
	ctx context.Context,
	settings ...Setting,
) *taro.Program

func WithReverse

func WithReverse(ctx context.Context, t *Text)

Types

type AcceptedEvent

type AcceptedEvent struct {
	Text string
}

type Setting

type Setting func(context.Context, *Text)

func WithAnimation

func WithAnimation(image image.Image, creator anim.Creator) Setting

func WithInline

func WithInline(location, size geom.Vec2) Setting

WithInline displays Text as a small window at the provided location on the screen.

func WithParams

func WithParams(params *params.Parameters) Setting

WithParams provides parameters this Text will use for rendering.

func WithPlaceholder

func WithPlaceholder(placeholder string) Setting

WithPlaceholder controls the string that is shown when the input is empty.

func WithPreset

func WithPreset(preset string) Setting

WithPreset prefills the text input with a string.

func WithPrompt

func WithPrompt(prompt string) Setting

WithPrompt controls the prompt text shown below (or above) the text input.

func WithResult

func WithResult(result chan<- interface{}) Setting

type Text

type Text struct {
	util.Lifetime
	// contains filtered or unexported fields
}

func (*Text) Init

func (t *Text) Init() taro.Cmd

func (*Text) Update

func (t *Text) Update(msg tea.Msg) (taro.Model, tea.Cmd)

func (*Text) View

func (t *Text) View(state *tty.State)