list

Documentation

Index

• type List
  • func New(items interface{}, size int) (*List, error)
  • func (l *List) CanPageDown() bool
  • func (l *List) CanPageUp() bool
  • func (l *List) Index() int
  • func (l *List) Items() ([]interface{}, int)
  • func (l *List) Next()
  • func (l *List) PageDown()
  • func (l *List) PageUp()
  • func (l *List) Prev()

Types

type List

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

List holds a collection of items that can be displayed with an N number of visible items. The list can be moved up, down by one item of time or an entire page (ie: visible size). It keeps track of the current selected item.

func New

func New(items interface{}, size int) (*List, error)

New creates and initializes a list. Items must be a slice type and size must be greater than 0.

func (*List) CanPageDown

func (l *List) CanPageDown() bool

CanPageDown returns whether a list can still PageDown().

func (*List) CanPageUp

func (l *List) CanPageUp() bool

CanPageUp returns whether a list can still PageUp().

func (*List) Index

func (l *List) Index() int

Index returns the index of the item currently selected.

func (*List) Items

func (l *List) Items() ([]interface{}, int)

Items returns a slice equal to the size of the list with the current visible items and the index of the active item in this list.

func (*List) Next

func (l *List) Next()

Next moves the visible list forward one item. If the selected item is out of view, the new select item becomes the first visible item. If the list is already at the bottom, nothing happens.

func (*List) PageDown

func (l *List) PageDown()

PageDown moves the visible list forward by x items. Where x is the size of the visible items on the list. The selected item becomes the first visible item.

func (*List) PageUp

func (l *List) PageUp()

PageUp moves the visible list backward by x items. Where x is the size of the visible items on the list. The selected item becomes the first visible item. If the list is already at the bottom, the selected item becomes the last visible item.

func (*List) Prev

func (l *List) Prev()

Prev moves the visible list back one item. If the selected item is out of view, the new select item becomes the last visible item. If the list is already at the top, nothing happens.