package interactive

Import Path
	gitlab.com/pcanilho/go-jira-cli/cmd/interactive (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 2 packages

Involved Source Files

	      issue_list.go
	      issue_project.go
	      main.go
	      menu.go
	      user.go
	      user_prompt.go
	      user_top.go
Package-Level Type Names (total 7, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Menu (interface)

		Methods (total 2, both are exported)
			( T) AttachController(controller internal.Controller)
			( T) Render() (int, string, error)
		Implemented By (at least 6, none are exported)
			/* 6+ unexporteds ... *//* 6+ unexporteds: */
			*issueList
			*issueProject
			*main
			*user
			*userPrompt
			*userTop
		As Outputs Of (at least 6, all are exported)
			func NewIssueListMenu(issues []jira.Issue, previous Menu) Menu
			func NewIssueProjectMenu(projects []jira.Project, previous Menu) Menu
			func NewMainMenu() Menu
			func NewUserMenu(u jira.User, previous Menu) Menu
			func NewUserPrompt(previous Menu) Menu
			func NewUserTopMenu(parent Menu) Menu
		As Inputs Of (at least 5, all are exported)
			func NewIssueListMenu(issues []jira.Issue, previous Menu) Menu
			func NewIssueProjectMenu(projects []jira.Project, previous Menu) Menu
			func NewUserMenu(u jira.User, previous Menu) Menu
			func NewUserPrompt(previous Menu) Menu
			func NewUserTopMenu(parent Menu) Menu

	/* 6 unexporteds ... *//* 6 unexporteds: */
	 type issueList (struct)

		Fields (total 19, in which 15 are exported)
			Select promptui.Select
			Select.CursorPos int
				CursorPos is the initial position of the cursor.

			Select.HideHelp bool
				HideHelp sets whether to hide help information.

			Select.HideSelected bool
				HideSelected sets whether to hide the text displayed after an item is successfully selected.

			Select.IsVimMode bool
				IsVimMode sets whether to use vim mode when using readline in the command prompt. Look at
				https://godoc.org/github.com/chzyer/readline#Config for more information on readline.

			Select.Items interface{}
				Items are the items to display inside the list. It expect a slice of any kind of values, including strings.

				If using a slice of strings, promptui will use those strings directly into its base templates or the
				provided templates. If using any other type in the slice, it will attempt to transform it into a string
				before giving it to its templates. Custom templates will override this behavior if using the dot notation
				inside the templates.

				For example, `{{ .Name }}` will display the name property of a struct.

			Select.Keys *promptui.SelectKeys
				Keys is the set of keys used in select mode to control the command line interface. See the SelectKeys docs for
				more info.

			Select.Label interface{}
				Label is the text displayed on top of the list to direct input. The IconInitial value "?" will be
				appended automatically to the label so it does not need to be added.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Select.Pointer promptui.Pointer
				A function that determines how to render the cursor

			Select.Searcher list.Searcher
				Searcher is a function that can be implemented to refine the base searching algorithm in selects.

				Search is a function that will receive the searched term and the item's index and should return a boolean
				for whether or not the terms are alike. It is unimplemented by default and search will not work unless
				it is implemented.

			Select.Size int
				Size is the number of items that should appear on the select before scrolling is necessary. Defaults to 5.

			Select.StartInSearchMode bool
				StartInSearchMode sets whether or not the select mode should start in search mode or selection mode.
				For search mode to work, the Search property must be implemented.

			Select.Stdin io.ReadCloser
			Select.Stdout io.WriteCloser
			Select.Templates *promptui.SelectTemplates
				Templates can be used to customize the select output. If nil is passed, the
				default templates are used. See the SelectTemplates docs for more info.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			controller internal.IssueController
			next Menu
			previous Menu
			Select.list *list.List
		Methods (total 10, in which 5 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (int, string, error)
				Run executes the select list. It displays the label and the list of items, asking the user to chose any
				value within to list. Run will keep the prompt alive until it has been canceled from
				the command prompt or it has received a valid value. It will return the value and an error if any
				occurred during the select's execution.

			(*T) RunCursorAt(cursorPos, scroll int) (int, string, error)
				RunCursorAt executes the select list, initializing the cursor to the given
				position. Invalid cursor positions will be clamped to valid values.  It
				displays the label and the list of items, asking the user to chose any value
				within to list. Run will keep the prompt alive until it has been canceled
				from the command prompt or it has received a valid value. It will return
				the value and an error if any occurred during the select's execution.

			(*T) ScrollPosition() int
				ScrollPosition returns the current scroll position.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) innerRun(cursorPos, scroll int, top rune) (int, string, error)
			(*T) prepareTemplates() error
			(*T) renderDetails(item interface{}) [][]byte
			(*T) renderHelp(b bool) []byte
			(*T) setKeys()
		Implements (at least one exported)
			*T : Menu

	 type issueProject (struct)

		Fields (total 19, in which 15 are exported)
			Select promptui.Select
			Select.CursorPos int
				CursorPos is the initial position of the cursor.

			Select.HideHelp bool
				HideHelp sets whether to hide help information.

			Select.HideSelected bool
				HideSelected sets whether to hide the text displayed after an item is successfully selected.

			Select.IsVimMode bool
				IsVimMode sets whether to use vim mode when using readline in the command prompt. Look at
				https://godoc.org/github.com/chzyer/readline#Config for more information on readline.

			Select.Items interface{}
				Items are the items to display inside the list. It expect a slice of any kind of values, including strings.

				If using a slice of strings, promptui will use those strings directly into its base templates or the
				provided templates. If using any other type in the slice, it will attempt to transform it into a string
				before giving it to its templates. Custom templates will override this behavior if using the dot notation
				inside the templates.

				For example, `{{ .Name }}` will display the name property of a struct.

			Select.Keys *promptui.SelectKeys
				Keys is the set of keys used in select mode to control the command line interface. See the SelectKeys docs for
				more info.

			Select.Label interface{}
				Label is the text displayed on top of the list to direct input. The IconInitial value "?" will be
				appended automatically to the label so it does not need to be added.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Select.Pointer promptui.Pointer
				A function that determines how to render the cursor

			Select.Searcher list.Searcher
				Searcher is a function that can be implemented to refine the base searching algorithm in selects.

				Search is a function that will receive the searched term and the item's index and should return a boolean
				for whether or not the terms are alike. It is unimplemented by default and search will not work unless
				it is implemented.

			Select.Size int
				Size is the number of items that should appear on the select before scrolling is necessary. Defaults to 5.

			Select.StartInSearchMode bool
				StartInSearchMode sets whether or not the select mode should start in search mode or selection mode.
				For search mode to work, the Search property must be implemented.

			Select.Stdin io.ReadCloser
			Select.Stdout io.WriteCloser
			Select.Templates *promptui.SelectTemplates
				Templates can be used to customize the select output. If nil is passed, the
				default templates are used. See the SelectTemplates docs for more info.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			controller internal.ProjectController
			next Menu
			previous Menu
			Select.list *list.List
		Methods (total 10, in which 5 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (int, string, error)
				Run executes the select list. It displays the label and the list of items, asking the user to chose any
				value within to list. Run will keep the prompt alive until it has been canceled from
				the command prompt or it has received a valid value. It will return the value and an error if any
				occurred during the select's execution.

			(*T) RunCursorAt(cursorPos, scroll int) (int, string, error)
				RunCursorAt executes the select list, initializing the cursor to the given
				position. Invalid cursor positions will be clamped to valid values.  It
				displays the label and the list of items, asking the user to chose any value
				within to list. Run will keep the prompt alive until it has been canceled
				from the command prompt or it has received a valid value. It will return
				the value and an error if any occurred during the select's execution.

			(*T) ScrollPosition() int
				ScrollPosition returns the current scroll position.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) innerRun(cursorPos, scroll int, top rune) (int, string, error)
			(*T) prepareTemplates() error
			(*T) renderDetails(item interface{}) [][]byte
			(*T) renderHelp(b bool) []byte
			(*T) setKeys()
		Implements (at least one exported)
			*T : Menu

	 type main (struct)

		Fields (total 18, in which 15 are exported)
			Select promptui.Select
			Select.CursorPos int
				CursorPos is the initial position of the cursor.

			Select.HideHelp bool
				HideHelp sets whether to hide help information.

			Select.HideSelected bool
				HideSelected sets whether to hide the text displayed after an item is successfully selected.

			Select.IsVimMode bool
				IsVimMode sets whether to use vim mode when using readline in the command prompt. Look at
				https://godoc.org/github.com/chzyer/readline#Config for more information on readline.

			Select.Items interface{}
				Items are the items to display inside the list. It expect a slice of any kind of values, including strings.

				If using a slice of strings, promptui will use those strings directly into its base templates or the
				provided templates. If using any other type in the slice, it will attempt to transform it into a string
				before giving it to its templates. Custom templates will override this behavior if using the dot notation
				inside the templates.

				For example, `{{ .Name }}` will display the name property of a struct.

			Select.Keys *promptui.SelectKeys
				Keys is the set of keys used in select mode to control the command line interface. See the SelectKeys docs for
				more info.

			Select.Label interface{}
				Label is the text displayed on top of the list to direct input. The IconInitial value "?" will be
				appended automatically to the label so it does not need to be added.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Select.Pointer promptui.Pointer
				A function that determines how to render the cursor

			Select.Searcher list.Searcher
				Searcher is a function that can be implemented to refine the base searching algorithm in selects.

				Search is a function that will receive the searched term and the item's index and should return a boolean
				for whether or not the terms are alike. It is unimplemented by default and search will not work unless
				it is implemented.

			Select.Size int
				Size is the number of items that should appear on the select before scrolling is necessary. Defaults to 5.

			Select.StartInSearchMode bool
				StartInSearchMode sets whether or not the select mode should start in search mode or selection mode.
				For search mode to work, the Search property must be implemented.

			Select.Stdin io.ReadCloser
			Select.Stdout io.WriteCloser
			Select.Templates *promptui.SelectTemplates
				Templates can be used to customize the select output. If nil is passed, the
				default templates are used. See the SelectTemplates docs for more info.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			controller internal.Controller
			next Menu
			Select.list *list.List
		Methods (total 10, in which 5 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (int, string, error)
				Run executes the select list. It displays the label and the list of items, asking the user to chose any
				value within to list. Run will keep the prompt alive until it has been canceled from
				the command prompt or it has received a valid value. It will return the value and an error if any
				occurred during the select's execution.

			(*T) RunCursorAt(cursorPos, scroll int) (int, string, error)
				RunCursorAt executes the select list, initializing the cursor to the given
				position. Invalid cursor positions will be clamped to valid values.  It
				displays the label and the list of items, asking the user to chose any value
				within to list. Run will keep the prompt alive until it has been canceled
				from the command prompt or it has received a valid value. It will return
				the value and an error if any occurred during the select's execution.

			(*T) ScrollPosition() int
				ScrollPosition returns the current scroll position.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) innerRun(cursorPos, scroll int, top rune) (int, string, error)
			(*T) prepareTemplates() error
			(*T) renderDetails(item interface{}) [][]byte
			(*T) renderHelp(b bool) []byte
			(*T) setKeys()
		Implements (at least one exported)
			*T : Menu

	 type user (struct)

		Fields (total 19, in which 15 are exported)
			Select promptui.Select
			Select.CursorPos int
				CursorPos is the initial position of the cursor.

			Select.HideHelp bool
				HideHelp sets whether to hide help information.

			Select.HideSelected bool
				HideSelected sets whether to hide the text displayed after an item is successfully selected.

			Select.IsVimMode bool
				IsVimMode sets whether to use vim mode when using readline in the command prompt. Look at
				https://godoc.org/github.com/chzyer/readline#Config for more information on readline.

			Select.Items interface{}
				Items are the items to display inside the list. It expect a slice of any kind of values, including strings.

				If using a slice of strings, promptui will use those strings directly into its base templates or the
				provided templates. If using any other type in the slice, it will attempt to transform it into a string
				before giving it to its templates. Custom templates will override this behavior if using the dot notation
				inside the templates.

				For example, `{{ .Name }}` will display the name property of a struct.

			Select.Keys *promptui.SelectKeys
				Keys is the set of keys used in select mode to control the command line interface. See the SelectKeys docs for
				more info.

			Select.Label interface{}
				Label is the text displayed on top of the list to direct input. The IconInitial value "?" will be
				appended automatically to the label so it does not need to be added.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Select.Pointer promptui.Pointer
				A function that determines how to render the cursor

			Select.Searcher list.Searcher
				Searcher is a function that can be implemented to refine the base searching algorithm in selects.

				Search is a function that will receive the searched term and the item's index and should return a boolean
				for whether or not the terms are alike. It is unimplemented by default and search will not work unless
				it is implemented.

			Select.Size int
				Size is the number of items that should appear on the select before scrolling is necessary. Defaults to 5.

			Select.StartInSearchMode bool
				StartInSearchMode sets whether or not the select mode should start in search mode or selection mode.
				For search mode to work, the Search property must be implemented.

			Select.Stdin io.ReadCloser
			Select.Stdout io.WriteCloser
			Select.Templates *promptui.SelectTemplates
				Templates can be used to customize the select output. If nil is passed, the
				default templates are used. See the SelectTemplates docs for more info.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			controller internal.Controller
			next Menu
			previous Menu
			Select.list *list.List
		Methods (total 10, in which 5 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (int, string, error)
				Run executes the select list. It displays the label and the list of items, asking the user to chose any
				value within to list. Run will keep the prompt alive until it has been canceled from
				the command prompt or it has received a valid value. It will return the value and an error if any
				occurred during the select's execution.

			(*T) RunCursorAt(cursorPos, scroll int) (int, string, error)
				RunCursorAt executes the select list, initializing the cursor to the given
				position. Invalid cursor positions will be clamped to valid values.  It
				displays the label and the list of items, asking the user to chose any value
				within to list. Run will keep the prompt alive until it has been canceled
				from the command prompt or it has received a valid value. It will return
				the value and an error if any occurred during the select's execution.

			(*T) ScrollPosition() int
				ScrollPosition returns the current scroll position.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) innerRun(cursorPos, scroll int, top rune) (int, string, error)
			(*T) prepareTemplates() error
			(*T) renderDetails(item interface{}) [][]byte
			(*T) renderHelp(b bool) []byte
			(*T) setKeys()
		Implements (at least one exported)
			*T : Menu

	 type userPrompt (struct)

		Fields (total 16, in which 13 are exported)
			Prompt promptui.Prompt
			Prompt.AllowEdit bool
				AllowEdit lets the user edit the default value. If false, any key press
				other than <Enter> automatically clears the default value.

			Prompt.Default string
				Default is the initial value for the prompt. This value will be displayed next to the prompt's label
				and the user will be able to view or change it depending on the options.

			Prompt.HideEntered bool
				HideEntered sets whether to hide the text after the user has pressed enter.

			Prompt.IsConfirm bool
				IsConfirm makes the prompt ask for a yes or no ([Y/N]) question rather than request an input. When set,
				most properties related to input will be ignored.

			Prompt.IsVimMode bool
				IsVimMode enables vi-like movements (hjkl) and editing.

			Prompt.Label interface{}
				Label is the value displayed on the command line prompt.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Prompt.Mask rune
				Mask is an optional rune that sets which character to display instead of the entered characters. This
				allows hiding private information like passwords.

			Prompt.Pointer promptui.Pointer
				the Pointer defines how to render the cursor.

			Prompt.Stdin io.ReadCloser
			Prompt.Stdout io.WriteCloser
			Prompt.Templates *promptui.PromptTemplates
				Templates can be used to customize the prompt output. If nil is passed, the
				default templates are used. See the PromptTemplates docs for more info.

			Prompt.Validate promptui.ValidateFunc
				Validate is an optional function that fill be used against the entered value in the prompt to validate it.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			controller internal.Controller
			next Menu
			previous Menu
		Methods (total 4, in which 3 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (string, error)
				Run executes the prompt. Its displays the label and default value if any, asking the user to enter a value.
				Run will keep the prompt alive until it has been canceled from the command prompt or it has received a valid
				value. It will return the value and an error if any occurred during the prompt's execution.

			/* one unexported ... *//* one unexported: */
			(*T) prepareTemplates() error
		Implements (at least one exported)
			*T : Menu

	 type userTop (struct)

		Fields (total 19, in which 15 are exported)
			Select promptui.Select
			Select.CursorPos int
				CursorPos is the initial position of the cursor.

			Select.HideHelp bool
				HideHelp sets whether to hide help information.

			Select.HideSelected bool
				HideSelected sets whether to hide the text displayed after an item is successfully selected.

			Select.IsVimMode bool
				IsVimMode sets whether to use vim mode when using readline in the command prompt. Look at
				https://godoc.org/github.com/chzyer/readline#Config for more information on readline.

			Select.Items interface{}
				Items are the items to display inside the list. It expect a slice of any kind of values, including strings.

				If using a slice of strings, promptui will use those strings directly into its base templates or the
				provided templates. If using any other type in the slice, it will attempt to transform it into a string
				before giving it to its templates. Custom templates will override this behavior if using the dot notation
				inside the templates.

				For example, `{{ .Name }}` will display the name property of a struct.

			Select.Keys *promptui.SelectKeys
				Keys is the set of keys used in select mode to control the command line interface. See the SelectKeys docs for
				more info.

			Select.Label interface{}
				Label is the text displayed on top of the list to direct input. The IconInitial value "?" will be
				appended automatically to the label so it does not need to be added.

				The value for Label can be a simple string or a struct that will need to be accessed by dot notation
				inside the templates. For example, `{{ .Name }}` will display the name property of a struct.

			Select.Pointer promptui.Pointer
				A function that determines how to render the cursor

			Select.Searcher list.Searcher
				Searcher is a function that can be implemented to refine the base searching algorithm in selects.

				Search is a function that will receive the searched term and the item's index and should return a boolean
				for whether or not the terms are alike. It is unimplemented by default and search will not work unless
				it is implemented.

			Select.Size int
				Size is the number of items that should appear on the select before scrolling is necessary. Defaults to 5.

			Select.StartInSearchMode bool
				StartInSearchMode sets whether or not the select mode should start in search mode or selection mode.
				For search mode to work, the Search property must be implemented.

			Select.Stdin io.ReadCloser
			Select.Stdout io.WriteCloser
			Select.Templates *promptui.SelectTemplates
				Templates can be used to customize the select output. If nil is passed, the
				default templates are used. See the SelectTemplates docs for more info.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			controller internal.Controller
			next Menu
			previous Menu
			Select.list *list.List
		Methods (total 10, in which 5 are exported)
			(*T) AttachController(controller internal.Controller)
			(*T) Render() (int, string, error)
			(*T) Run() (int, string, error)
				Run executes the select list. It displays the label and the list of items, asking the user to chose any
				value within to list. Run will keep the prompt alive until it has been canceled from
				the command prompt or it has received a valid value. It will return the value and an error if any
				occurred during the select's execution.

			(*T) RunCursorAt(cursorPos, scroll int) (int, string, error)
				RunCursorAt executes the select list, initializing the cursor to the given
				position. Invalid cursor positions will be clamped to valid values.  It
				displays the label and the list of items, asking the user to chose any value
				within to list. Run will keep the prompt alive until it has been canceled
				from the command prompt or it has received a valid value. It will return
				the value and an error if any occurred during the select's execution.

			(*T) ScrollPosition() int
				ScrollPosition returns the current scroll position.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) innerRun(cursorPos, scroll int, top rune) (int, string, error)
			(*T) prepareTemplates() error
			(*T) renderDetails(item interface{}) [][]byte
			(*T) renderHelp(b bool) []byte
			(*T) setKeys()
		Implements (at least one exported)
			*T : Menu


Package-Level Functions (total 6, all are exported)

	 func NewIssueListMenu(issues []jira.Issue, previous Menu) Menu
	 func NewIssueProjectMenu(projects []jira.Project, previous Menu) Menu
	 func NewMainMenu() Menu
	 func NewUserMenu(u jira.User, previous Menu) Menu
	 func NewUserPrompt(previous Menu) Menu
	 func NewUserTopMenu(parent Menu) Menu
Package-Level Variables (total 7, none are exported)

	/* 7 unexporteds ... *//* 7 unexporteds: */
	  var issueListTemplate *promptui.SelectTemplates
	  var issueProjectTemplate *promptui.SelectTemplates
	  var mainItems []string
	  var mainTemplate *promptui.SelectTemplates
	  var userTemplate *promptui.SelectTemplates
	  var userTopTemplate *promptui.SelectTemplates
	  var useTopItems []string
Package-Level Constants (total 8, in which 2 are exported)

	const PreviousMenu = "↑ up..."
	const PreviousSelected int = 0
	/* 6 unexporteds ... *//* 6 unexporteds: */
	const exitSelected int = 3
	const getByUsernameSelected = 2
	const issuesSelected int = 1
	const projectsSelected int = 2
	const searchBySelected = 1
	const usersSelected int = 0

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.