package list

Import Path
	github.com/manifoldco/promptui/list (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	      list.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type List (struct)
		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.

		Fields (total 6, in which 1 are exported)
			Searcher Searcher
			/* 5 unexporteds ... *//* 5 unexporteds: */
			cursor int
				// cursor holds the index of the current selected item

			items []*interface{}
			scope []*interface{}
			size int
				// size is the number of visible options

			start int
		Methods (total 14, in which 13 are exported)
			(*T) CanPageDown() bool
				CanPageDown returns whether a list can still PageDown().

			(*T) CanPageUp() bool
				CanPageUp returns whether a list can still PageUp().

			(*T) CancelSearch()
				CancelSearch stops the current search and returns the list to its
				original order.

			(*T) Index() int
				Index returns the index of the item currently selected inside the searched list. If no item is selected,
				the NotFound (-1) index is returned.

			(*T) 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.

			(*T) 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.

			(*T) 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.

			(*T) 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.

			(*T) 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.

			(*T) Search(term string)
				Search allows the list to be filtered by a given term. The list must
				implement the searcher function signature for this functionality to work.

			(*T) SetCursor(i int)
				SetCursor sets the position of the cursor in the list. Values out of bounds
				will be clamped.

			(*T) SetStart(i int)
				SetStart sets the current scroll position. Values out of bounds will be
				clamped.

			(*T) Start() int
				Start returns the current render start position of the list.

			/* one unexported ... *//* one unexported: */
			(*T) search(term string)
		As Outputs Of (at least one exported)
			func New(items interface{}, size int) (*List, error)

	 type Searcher (func)
		Searcher is a base function signature that is used inside select when activating the search mode.
		If defined, it is called on each items of the select and should return a boolean for whether or not
		the item fits the searched term.


Package-Level Functions (only one, which is exported)

	 func New(items interface{}, size int) (*List, error)
		New creates and initializes a list of searchable items. The items attribute must be a slice type with a
		size greater than 0. Error will be returned if those two conditions are not met.


Package-Level Constants (only one, which is exported)

	const NotFound = -1
		NotFound is an index returned when no item was selected. This could
		happen due to a search without results.

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.