list

Documentation

Index

• Variables
• type Item
  • func Items[T interface{ ... }](items []T) []Item
• type List
  • func New(items []Item, opts ...Option) *List
  • func (l *List) Model() *list.Model
  • func (l *List) Select() (Item, error)
• type Option
  • func WithStyle(s charm.Style) Option

Variables

var (
	// ListDefaultStyle is the default list style.
	ListDefaultStyle = charm.NewStyle(lipgloss.NewStyle().Margin(1, 1))
)

Types

type Item

type Item list.Item

func Items

func Items[T interface{ Item }](items []T) []Item

Items converts a slice of items into a []Item type slice.

type List

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

List is a component used to select an item from a list.

func New

func New(items []Item, opts ...Option) *List

New creates a new list.

func (*List) Model

func (l *List) Model() *list.Model

Model returns the underlying list.Model.

func (*List) Select

func (l *List) Select() (Item, error)

Select displays the list and prompts the user to select an item.

type Option

type Option func(*List)

func WithStyle

func WithStyle(s charm.Style) Option