radish

package module

Go to main page

Versions in this module

v0

v0.2.0

Jun 11, 2026

Changes in this version

type InputModel

+ func (m *InputModel) SummaryFunc(fn func(value string) string) *InputModel

+ func (m *InputModel) Validate(fn func(string) error) *InputModel

type MultiSelectModel

+ func (m *MultiSelectModel) Hint(s string) *MultiSelectModel

+ func (m *MultiSelectModel) Preselect(labels ...string) *MultiSelectModel

+ func (m *MultiSelectModel) SummaryFunc(fn func(selected []string) string) *MultiSelectModel

type ScriptDriver

+ func (d *ScriptDriver) FrameEventIdx() []int

type SelectModel

+ func (m *SelectModel) SummaryFunc(fn func(selected string) string) *SelectModel

type Theme

+ Error *color.Color

v0.1.0

Jun 9, 2026

Changes in this version

+ var ErrNotInteractive = errors.New("radish: not an interactive terminal")

+ func DefaultMatcher(filter, label string) (bool, int)

+ func Run(model Model, src EventSource, sink FrameSink) (Result, Model, error)

+ func RunInput(m *InputModel, in *os.File, out io.Writer) (value string, ok bool, err error)

+ func RunMultiSelect(m *MultiSelectModel, in *os.File, out io.Writer) (values []string, ok bool, err error)

+ func RunSelect(m *SelectModel, in *os.File, out io.Writer) (value string, ok bool, err error)

+ func RunTerminal(model Model, in *os.File, out io.Writer) (Result, Model, error)

+ type Cmd int

+ const CmdCancel

+ const CmdNone

+ const CmdSubmit

+ type EchoMode int

+ const EchoMasked

+ const EchoNone

+ const EchoNormal

+ type Event struct

+ Mods Modifier

+ Rune rune

+ Type KeyType

+ func KeyEvent(t KeyType) Event

+ func Parse(b []byte) (events []Event, consumed int)

+ func ParseKeyName(name string) (ev Event, ok bool)

+ func RuneEvent(r rune) Event

+ func (e Event) String() string

+ type EventSource interface

+ Close func() error

+ Next func() (Event, error)

+ type FrameSink interface

+ Close func() error

+ Finish func(final string) error

+ Render func(frame string) error

+ type InputModel struct

+ func NewInput() *InputModel

+ func (m *InputModel) Echo(mode EchoMode) *InputModel

+ func (m *InputModel) KeyMap(k KeyMap) *InputModel

+ func (m *InputModel) Placeholder(s string) *InputModel

+ func (m *InputModel) Prompt(s string) *InputModel

+ func (m *InputModel) Summary() string

+ func (m *InputModel) Theme(t *Theme) *InputModel

+ func (m *InputModel) Title(s string) *InputModel

+ func (m *InputModel) Update(e Event) (Model, Cmd)

+ func (m *InputModel) Value() (string, bool)

+ func (m *InputModel) View() string

+ func (m *InputModel) Width(n int) *InputModel

+ type KeyMap struct

+ Cancel []KeyType

+ ClearFilter []KeyType

+ Down []KeyType

+ End []KeyType

+ Home []KeyType

+ Left []KeyType

+ PageDown []KeyType

+ PageUp []KeyType

+ Right []KeyType

+ Submit []KeyType

+ Toggle []KeyType

+ Up []KeyType

+ func DefaultKeyMap() KeyMap

+ type KeyType int

+ const KeyBackspace

+ const KeyCtrlC

+ const KeyCtrlD

+ const KeyCtrlU

+ const KeyDown

+ const KeyEnd

+ const KeyEnter

+ const KeyEsc

+ const KeyHome

+ const KeyLeft

+ const KeyNone

+ const KeyPageDown

+ const KeyPageUp

+ const KeyRight

+ const KeyRune

+ const KeyShiftTab

+ const KeyTab

+ const KeyUp

+ type Matcher func(filter, label string) (matched bool, rank int)

+ type Model interface

+ Update func(Event) (Model, Cmd)

+ View func() string

+ type Modifier uint8

+ const ModAlt

+ const ModCtrl

+ const ModNone

+ type MultiSelectModel struct

+ func NewMultiSelect() *MultiSelectModel

+ func (m *MultiSelectModel) Height(n int) *MultiSelectModel

+ func (m *MultiSelectModel) KeyMap(k KeyMap) *MultiSelectModel

+ func (m *MultiSelectModel) Matcher(fn Matcher) *MultiSelectModel

+ func (m *MultiSelectModel) Max(n int) *MultiSelectModel

+ func (m *MultiSelectModel) Min(n int) *MultiSelectModel

+ func (m *MultiSelectModel) Options(opts ...string) *MultiSelectModel

+ func (m *MultiSelectModel) Selected() []string

+ func (m *MultiSelectModel) Summary() string

+ func (m *MultiSelectModel) Theme(t *Theme) *MultiSelectModel

+ func (m *MultiSelectModel) Title(s string) *MultiSelectModel

+ func (m *MultiSelectModel) Update(e Event) (Model, Cmd)

+ func (m *MultiSelectModel) View() string

+ func (m *MultiSelectModel) Width(n int) *MultiSelectModel

+ type Result struct

+ Canceled bool

+ type ScriptDriver struct

+ func NewScriptDriver(events []Event) *ScriptDriver

+ func (d *ScriptDriver) Events() []Event

+ func (d *ScriptDriver) Frames() []string

+ func (d *ScriptDriver) Run(model Model) (Result, Model, error)

+ type SelectModel struct

+ func NewSelect() *SelectModel

+ func (m *SelectModel) Height(n int) *SelectModel

+ func (m *SelectModel) KeyMap(k KeyMap) *SelectModel

+ func (m *SelectModel) Matcher(fn Matcher) *SelectModel

+ func (m *SelectModel) Options(opts ...string) *SelectModel

+ func (m *SelectModel) Selected() (string, bool)

+ func (m *SelectModel) Summary() string

+ func (m *SelectModel) Theme(t *Theme) *SelectModel

+ func (m *SelectModel) Title(s string) *SelectModel

+ func (m *SelectModel) Update(e Event) (Model, Cmd)

+ func (m *SelectModel) View() string

+ func (m *SelectModel) Width(n int) *SelectModel

+ type Summarizer interface

+ Summary func() string

+ type TermDriver struct

+ func NewTermDriver(in *os.File, out io.Writer) (*TermDriver, error)

+ func (d *TermDriver) Close() error

+ func (d *TermDriver) Finish(final string) error

+ func (d *TermDriver) Next() (Event, error)

+ func (d *TermDriver) Render(frame string) error

+ type Theme struct

+ Cursor *color.Color

+ Filter *color.Color

+ Normal *color.Color

+ Placeholder *color.Color

+ ScrollHint *color.Color

+ Selected *color.Color

+ Title *color.Color

+ func DefaultTheme() *Theme

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL