core

Documentation

Index

• Variables
• func RunTemplate(tmpl string, data interface{}) (string, error)
• func WriteAnswer(t interface{}, name string, v interface{}) (err error)
• type Renderer
  • func (r *Renderer) Error(invalid error) error
  • func (r *Renderer) NewCursor() *terminal.Cursor
  • func (r *Renderer) NewRuneReader() *terminal.RuneReader
  • func (r *Renderer) Render(tmpl string, data interface{}) error
  • func (r *Renderer) Stdio() terminal.Stdio
  • func (r *Renderer) WithStdio(stdio terminal.Stdio)
• Bugs

Variables

var (
	HelpInputRune = '?'

	ErrorIcon    = "✘"
	HelpIcon     = "ⓘ"
	QuestionIcon = "?"

	MarkedOptionIcon   = "◉"
	UnmarkedOptionIcon = "◯"

	SelectFocusIcon = "❯"
)

var DisableColor = false

var ErrorTemplate = `{{color "red"}}{{ ErrorIcon }} Sorry, your reply was invalid: {{.Error}}{{color "reset"}}
`

var TemplateFuncs = map[string]interface{}{

	"color": func(color string) string {
		if DisableColor {
			return ""
		}
		return ansi.ColorCode(color)
	},
	"HelpInputRune": func() string {
		return string(HelpInputRune)
	},
	"ErrorIcon": func() string {
		return ErrorIcon
	},
	"HelpIcon": func() string {
		return HelpIcon
	},
	"QuestionIcon": func() string {
		return QuestionIcon
	},
	"MarkedOptionIcon": func() string {
		return MarkedOptionIcon
	},
	"UnmarkedOptionIcon": func() string {
		return UnmarkedOptionIcon
	},
	"SelectFocusIcon": func() string {
		return SelectFocusIcon
	},
}

Functions

func RunTemplate

func RunTemplate(tmpl string, data interface{}) (string, error)

func WriteAnswer

func WriteAnswer(t interface{}, name string, v interface{}) (err error)

Types

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

func (*Renderer) Error

func (r *Renderer) Error(invalid error) error

func (*Renderer) NewCursor

func (r *Renderer) NewCursor() *terminal.Cursor

func (*Renderer) NewRuneReader

func (r *Renderer) NewRuneReader() *terminal.RuneReader

func (*Renderer) Render

func (r *Renderer) Render(tmpl string, data interface{}) error

func (*Renderer) Stdio

func (r *Renderer) Stdio() terminal.Stdio

func (*Renderer) WithStdio

func (r *Renderer) WithStdio(stdio terminal.Stdio)

Notes

Bugs

• the current implementation might cause weird conflicts if there are two fields with same name that only differ by casing.