types

Sep 17, 2025

Changes in this version

type CreateMenuOptions

+ KeepConfirmKeybindings bool

Sep 6, 2025

Changes in this version

type CreateMenuOptions

+ AllowFilteringKeybindings bool

type IFilterableContext

+ FilterPrefix func(tr *i18n.TranslationSet) string

type IGuiCommon

+ Resume func() error

+ Suspend func() error

type Views

+ Prompt *gocui.View

Aug 1, 2025

Changes in this version

type Binding

+ DescriptionFunc func() string

+ ShortDescriptionFunc func() string

+ func (b *Binding) GetDescription() string

+ func (b *Binding) GetShortDescription() string

type IBaseContext

+ ClearAllAttachedControllerFunctions func()

type IController

+ GetOnFocus func() func(OnFocusOpts)

+ GetOnFocusLost func() func(OnFocusLostOpts)

+ GetOnRenderToMain func() func()

type IPopupHandler

+ ConfirmIf func(condition bool, opts ConfirmOpts) error

Jul 4, 2025

Changes in this version

type RunPtyTask

+ func NewRunPtyTaskWithPrefix(cmd *exec.Cmd, prefix string) *RunPtyTask

Jun 5, 2025

Changes in this version

type DisabledReason

+ AllowFurtherDispatching bool

+ type ErrKeybindingNotHandled struct

+ DisabledReason *DisabledReason

+ func (e ErrKeybindingNotHandled) Error() string

+ func (e ErrKeybindingNotHandled) Unwrap() error

May 22, 2025

Changes in this version

type IContextMgr

+ NextInStack func(context Context) Context

type IListContext

+ IndexForGotoBottom func() int

Apr 29, 2025

Changes in this version

type Context

+ FocusLine func()

type HasKeybindings

+ GetOnClickFocusedMainView func() func(mainViewName string, clickedLineIdx int) error

type IBaseContext

+ AddOnClickFocusedMainViewFn func(func(mainViewName string, clickedLineIdx int) error)

type IGuiCommon

+ GetViewBufferManagerForView func(view *gocui.View) *tasks.ViewBufferManager

type Model

+ HashPool *utils.StringPool

Jan 11, 2025

Changes in this version

type DiffableContext

+ RefForAdjustingLineNumberInDiff func() string

+ type ScreenMode int

Sep 6, 2024

Changes in this version

type IBaseContext

+ TotalContentHeight func() int

type IContextMgr

+ Activate func(context Context, opts OnFocusOpts)

+ CurrentPopup func() []Context

+ IsCurrentOrParent func(c Context) bool

type IGuiCommon

+ ResetKeybindings func() error

type Ref

+ ShortRefName func() string

+ type RefRange struct

+ From Ref

+ To Ref

Jul 13, 2024

Changes in this version

type CreateMenuOptions

+ Prompt string

type IBaseContext

+ ClearAllBindingsFn func()

+ NeedsRerenderOnHeightChange func() bool

type IGuiCommon

+ CurrentPopupContexts func() []Context

type IListContext

+ RenderOnlyVisibleLines func() bool

type ISearchableContext

+ ModelSearchResults func(searchStr string, caseSensitive bool) []gocui.SearchPosition

type IViewTrait

+ SetContentLineCount func(lineCount int)

+ SetViewPortContentAndClearEverythingElse func(content string)

type MenuItem

+ Widget MenuWidget

+ type MenuWidget int

+ const MenuWidgetCheckboxSelected

+ const MenuWidgetCheckboxUnselected

+ const MenuWidgetNone

+ const MenuWidgetRadioButtonSelected

+ const MenuWidgetRadioButtonUnselected

+ func MakeMenuCheckBox(value bool) MenuWidget

+ func MakeMenuRadioButton(value bool) MenuWidget

type Model

+ MainBranches *git_commands.MainBranches

+ type NeedsRerenderOnWidthChangeLevel int

+ const NEEDS_RERENDER_ON_WIDTH_CHANGE_NONE

+ const NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_SCREEN_MODE_CHANGES

+ const NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_WIDTH_CHANGES

May 19, 2024

Changes in this version

type CreatePopupPanelOpts

+ AllowEditSuggestion bool

+ HandleDeleteSuggestion func(int) error

type IGuiCommon

+ HandleGenericClick func(view *gocui.View) error

type IPopupHandler

+ ErrorHandler func(err error) error

type PromptOpts

+ AllowEditSuggestion bool

+ HandleDeleteSuggestion func(int) error

Mar 22, 2024

Changes in this version

type Binding

+ DisplayOnScreen bool

+ DisplayStyle *style.TextStyle

+ GetDisabledReason func() *DisabledReason

+ ShortDescription string

+ func (Binding *Binding) IsDisabled() bool

+ type DisabledReason struct

+ ShowErrorInPanel bool

+ Text string

+ type HasUrn interface

+ URN func() string

type IBaseContext

+ NeedsRerenderOnWidthChange func() bool

type IFilterableContext

+ ReApplyFilter func(bool)

type IGuiCommon

+ CallKeybindingHandler func(binding *Binding) error

+ RunningIntegrationTest func() bool

+ SaveAppStateAndLogError func()

+ WithInlineStatus func(item HasUrn, operation ItemOperation, contextKey ContextKey, ...) error

type IList

+ GetItem func(index int) HasUrn

type IListContext

+ GetSelectedItemIds func() ([]string, int, int)

+ IsItemVisible func(item HasUrn) bool

+ ModelIndexToViewIndex func(int) int

+ RangeSelectEnabled func() bool

+ ViewIndexToModelIndex func(int) int

type IListCursor

+ AreMultipleItemsSelected func() bool

+ CancelRangeSelect func()

+ ClampSelection func()

+ ExpandNonStickyRange func(int)

+ GetRangeStartIdx func() (int, bool)

+ GetSelectionRange func() (int, int)

+ IsSelectingRange func() bool

+ SetSelection func(value int)

+ ToggleStickyRange func()

type IListPanelState

+ SetSelection func(int)

type IPopupHandler

+ ErrorToast func(message string)

+ SetToastFunc func(func(string, ToastKind))

+ WithWaitingStatusSync func(message string, f func() error) error

+ type ISearchHistoryContext interface

+ GetSearchHistory func() *utils.HistoryBuffer[string]

type ISearchableContext

+ RenderSearchStatus func(int, int)

type IStateAccessor

+ ClearItemOperation func(item HasUrn)

+ GetItemOperation func(item HasUrn) ItemOperation

+ SetItemOperation func(item HasUrn, operation ItemOperation)

type IViewTrait

+ CancelRangeSelect func()

+ SetRangeSelectStart func(yIdx int)

+ type ItemOperation int

+ const ItemOperationCheckingOut

+ const ItemOperationDeleting

+ const ItemOperationFastForwarding

+ const ItemOperationFetching

+ const ItemOperationNone

+ const ItemOperationPulling

+ const ItemOperationPushing

type MenuItem

+ DisabledReason *DisabledReason

+ Section *MenuSection

+ func (self *MenuItem) ID() string

+ type MenuSection struct

+ Column int

+ Title string

type RefreshOptions

+ KeepBranchSelectionIndex bool

type SearchState

+ PrevSearchIndex int

type Suggestion

+ func (self *Suggestion) ID() string

+ type ToastKind int

+ const ToastKindError

+ const ToastKindStatus

+ type VersionNumber struct

+ Major int

+ Minor int

+ Patch int

+ func ParseVersionNumber(versionStr string) (*VersionNumber, error)

+ func (v *VersionNumber) IsOlderThan(otherVersion *VersionNumber) bool

type Views

+ StatusSpacer1 *gocui.View

+ StatusSpacer2 *gocui.View

Aug 5, 2023

Changes in this version

type IGuiCommon

+ ContextForKey func(key ContextKey) Context

+ InDemo func() bool

type Model

+ CheckedOutBranch string

+ Worktrees []*models.Worktree

type Modes

+ MarkedBaseCommit marked_base_commit.MarkedBaseCommit

type RefreshableView

+ const WORKTREES

type Views

+ Worktrees *gocui.View

Jul 23, 2023

Changes in this version

type Model

+ Authors map[string]*models.Author

type Mutexes

+ AuthorsMutex *deadlock.Mutex

Jul 20, 2023

Changes in this version

type Binding

+ Display bool

+ type ContextCommon struct

type CreateMenuOptions

+ ColumnAlignment []utils.Alignment

+ type DiffableContext interface

+ GetDiffTerminals func() []string

type HasKeybindings

+ GetOnFocus func() func(OnFocusOpts) error

+ GetOnFocusLost func() func(OnFocusLostOpts) error

+ GetOnRenderToMain func() func() error

type IBaseContext

+ AddOnFocusFn func(func(OnFocusOpts) error)

+ AddOnFocusLostFn func(func(OnFocusLostOpts) error)

+ AddOnRenderToMainFn func(func() error)

+ type IContextMgr interface

+ AllFilterable func() []IFilterableContext

+ AllList func() []IListContext

+ AllPatchExplorer func() []IPatchExplorerContext

+ AllSearchable func() []ISearchableContext

+ Current func() Context

+ CurrentSide func() Context

+ CurrentStatic func() Context

+ ForEach func(func(Context))

+ IsCurrent func(c Context) bool

+ Pop func() error

+ Push func(context Context, opts ...OnFocusOpts) error

+ Replace func(context Context) error

+ type IFileWatcher interface

+ AddFilesToFileWatcher func(files []*models.File) error

+ type IFilterableContext interface

+ ClearFilter func()

+ GetFilter func() string

+ IsFilterableContext func()

+ IsFiltering func() bool

+ SetFilter func(string)

type IGuiCommon

+ AfterLayout func(f func() error)

+ Context func() IContextMgr

+ CurrentSideContext func() Context

+ GetConfig func() config.AppConfigurer

+ GetInitialKeybindingsWithCustomCommands func() ([]*Binding, []*gocui.ViewMouseBinding)

+ Git func() *commands.GitCommand

+ GocuiGui func() *gocui.Gui

+ KeybindingsOpts func() KeybindingsOpts

+ Model func() *Model

+ Modes func() *Modes

+ Mutexes func() Mutexes

+ OS func() *oscommands.OSCommand

+ OnWorker func(f func(gocui.Task))

+ ReplaceContext func(context Context) error

+ ResetViewOrigin func(view *gocui.View)

+ SetViewContent func(view *gocui.View, content string)

+ State func() IStateAccessor

+ Views func() Views

type IListContext

+ IsListContext func()

+ type IModeMgr interface

+ IsAnyModeActive func() bool

type IPatchExplorerContext

+ IsPatchExplorerContext func()

+ type IRepoStateAccessor interface

+ GetCurrentPopupOpts func() *CreatePopupPanelOpts

+ GetScreenMode func() WindowMaximisation

+ GetSearchState func() *SearchState

+ GetSplitMainPanel func() bool

+ GetStartupStage func() StartupStage

+ GetViewsSetup func() bool

+ GetWindowViewNameMap func() *utils.ThreadSafeMap[string, string]

+ InSearchPrompt func() bool

+ SetCurrentPopupOpts func(*CreatePopupPanelOpts)

+ SetScreenMode func(WindowMaximisation)

+ SetSplitMainPanel func(bool)

+ SetStartupStage func(stage StartupStage)

+ type ISearchableContext interface

+ ClearSearchString func()

+ GetSearchString func() string

+ IsSearchableContext func()

+ IsSearching func() bool

+ SetSearchString func(string)

+ type IStateAccessor interface

+ GetIgnoreWhitespaceInDiffView func() bool

+ GetIsRefreshingFiles func() bool

+ GetRepoPathStack func() *utils.StringStack

+ GetRepoState func() IRepoStateAccessor

+ GetRetainOriginalDir func() bool

+ GetShowExtrasWindow func() bool

+ GetUpdating func() bool

+ SetIgnoreWhitespaceInDiffView func(value bool)

+ SetIsRefreshingFiles func(bool)

+ SetRetainOriginalDir func(bool)

+ SetShowExtrasWindow func(bool)

+ SetUpdating func(bool)

type Mutexes

+ RefreshingBranchesMutex *deadlock.Mutex

type RefreshableView

+ const SUB_COMMITS

+ type SearchState struct

+ Context Context

+ func NewSearchState() *SearchState

+ func (self *SearchState) SearchType() SearchType

+ type SearchType int

+ const SearchTypeFilter

+ const SearchTypeNone

+ const SearchTypeSearch

+ type StartupStage int

+ const COMPLETE

+ const INITIAL

type ViewUpdateOpts

+ SubTitle string

+ type Views struct

+ AppStatus *gocui.View

+ Branches *gocui.View

+ CommitDescription *gocui.View

+ CommitFiles *gocui.View

+ CommitMessage *gocui.View

+ Commits *gocui.View

+ Confirmation *gocui.View

+ Extras *gocui.View

+ Files *gocui.View

+ Information *gocui.View

+ Limit *gocui.View

+ Main *gocui.View

+ Menu *gocui.View

+ MergeConflicts *gocui.View

+ Options *gocui.View

+ PatchBuilding *gocui.View

+ PatchBuildingSecondary *gocui.View

+ ReflogCommits *gocui.View

+ RemoteBranches *gocui.View

+ Remotes *gocui.View

+ Search *gocui.View

+ SearchPrefix *gocui.View

+ Secondary *gocui.View

+ Snake *gocui.View

+ Staging *gocui.View

+ StagingSecondary *gocui.View

+ Stash *gocui.View

+ Status *gocui.View

+ SubCommits *gocui.View

+ Submodules *gocui.View

+ Suggestions *gocui.View

+ Tags *gocui.View

+ Tooltip *gocui.View

+ type WindowMaximisation int

+ const SCREEN_FULL

+ const SCREEN_HALF

+ const SCREEN_NORMAL

May 1, 2023

Changes in this version

type IGuiCommon

+ ActivateContext func(context Context) error

+ RemoveContexts func([]Context) error

type Model

+ WorkingTreeStateAtLastCommitRefresh enums.RebaseMode

type Mutexes

+ SubCommitsMutex *deadlock.Mutex

Nov 14, 2022

Changes in this version

type ConfirmOpts

+ Editable bool

+ FindSuggestionsFunc func(string) []*Suggestion

+ HasLoader bool

+ Mask bool

type ContextKind

+ const DISPLAY_CONTEXT

type IBaseContext

+ GetView func() *gocui.View

+ GetViewTrait func() IViewTrait

+ HasControlledBounds func() bool

type IGuiCommon

+ CurrentStaticContext func() Context

+ IsCurrentContext func(Context) bool

+ MainViewPairs func() MainViewPairs

+ RenderToMainViews func(opts RefreshMainOpts) error

+ type IPatchExplorerContext interface

+ Focus func() error

+ GetContentToRender func(isFocused bool) string

+ GetIncludedLineIndices func() []int

+ GetMutex func() *deadlock.Mutex

+ GetState func() *patch_exploring.State

+ NavigateTo func(isFocused bool, selectedLineIdx int) error

+ Render func(isFocused bool) error

+ RenderAndFocus func(isFocused bool) error

+ SetState func(*patch_exploring.State)

type IViewTrait

+ SetHighlight func(bool)

+ type MainContextPair struct

+ Main Context

+ Secondary Context

+ func NewMainContextPair(main Context, secondary Context) MainContextPair

+ type MainViewPairs struct

+ MergeConflicts MainContextPair

+ Normal MainContextPair

+ PatchBuilding MainContextPair

+ Staging MainContextPair

+ type Mutexes struct

+ LocalCommitsMutex *deadlock.Mutex

+ PopupMutex *deadlock.Mutex

+ PtyMutex *deadlock.Mutex

+ RefreshingFilesMutex *deadlock.Mutex

+ RefreshingStatusMutex *deadlock.Mutex

+ SubprocessMutex *deadlock.Mutex

+ SyncMutex *deadlock.Mutex

+ type OnFocusLostOpts struct

+ NewContextKey ContextKey

type OnFocusOpts

+ ClickedWindowName string

+ type RefreshMainOpts struct

+ Main *ViewUpdateOpts

+ Pair MainContextPair

+ Secondary *ViewUpdateOpts

type RefreshableView

+ const COMMIT_FILES

+ const MERGE_CONFLICTS

+ const PATCH_BUILDING

+ const STAGING

+ type RenderStringTask struct

+ Str string

+ func NewRenderStringTask(str string) *RenderStringTask

+ func (t *RenderStringTask) IsUpdateTask()

+ type RenderStringWithScrollTask struct

+ OriginX int

+ OriginY int

+ Str string

+ func NewRenderStringWithScrollTask(str string, originX int, originY int) *RenderStringWithScrollTask

+ func (t *RenderStringWithScrollTask) IsUpdateTask()

+ type RenderStringWithoutScrollTask struct

+ Str string

+ func NewRenderStringWithoutScrollTask(str string) *RenderStringWithoutScrollTask

+ func (t *RenderStringWithoutScrollTask) IsUpdateTask()

+ type RunCommandTask struct

+ Cmd *exec.Cmd

+ Prefix string

+ func NewRunCommandTask(cmd *exec.Cmd) *RunCommandTask

+ func NewRunCommandTaskWithPrefix(cmd *exec.Cmd, prefix string) *RunCommandTask

+ func (t *RunCommandTask) IsUpdateTask()

+ type RunPtyTask struct

+ Cmd *exec.Cmd

+ Prefix string

+ func NewRunPtyTask(cmd *exec.Cmd) *RunPtyTask

+ func (t *RunPtyTask) IsUpdateTask()

+ type UpdateTask interface

+ IsUpdateTask func()

+ type ViewUpdateOpts struct

+ Task UpdateTask

+ Title string

Jul 18, 2022

Changes in this version

+ type Binding struct

+ Alternative string

+ Contexts []string

+ Description string

+ Handler func() error

+ Key Key

+ Modifier gocui.Modifier

+ OpensMenu bool

+ Tag string

+ Tooltip string

+ ViewName string

+ type CheckoutRefOptions struct

+ EnvVars []string

+ OnRefNotFound func(ref string) error

+ WaitingStatus string

+ type ConfirmOpts struct

+ HandleClose func() error

+ HandleConfirm func() error

+ HandlersManageFocus bool

+ Prompt string

+ Title string

+ type Context interface

+ HandleFocus func(opts ...OnFocusOpts) error

+ HandleFocusLost func() error

+ HandleRender func() error

+ HandleRenderToMain func() error

+ type ContextKey string

+ type ContextKind int

+ const EXTRAS_CONTEXT

+ const GLOBAL_CONTEXT

+ const MAIN_CONTEXT

+ const PERSISTENT_POPUP

+ const SIDE_CONTEXT

+ const TEMPORARY_POPUP

+ type CreateMenuOptions struct

+ HideCancel bool

+ Items []*MenuItem

+ Title string

+ type CreatePopupPanelOpts struct

+ Editable bool

+ FindSuggestionsFunc func(string) []*Suggestion

+ HandleClose func() error

+ HandleConfirm func() error

+ HandleConfirmPrompt func(string) error

+ HandlersManageFocus bool

+ HasLoader bool

+ Mask bool

+ Prompt string

+ Title string

+ type GitArg string

+ const GitArgBranch

+ const GitArgLog

+ const GitArgNone

+ const GitArgStash

+ const GitArgStatus

+ type Guard func(func() error) func() error

+ type HasKeybindings interface

+ GetKeybindings func(opts KeybindingsOpts) []*Binding

+ GetMouseKeybindings func(opts KeybindingsOpts) []*gocui.ViewMouseBinding

+ GetOnClick func() func() error

+ type HelperCommon struct

+ type IBaseContext interface

+ AddKeybindingsFn func(KeybindingsFn)

+ AddMouseKeybindingsFn func(MouseKeybindingsFn)

+ AddOnClickFn func(func() error)

+ GetKey func() ContextKey

+ GetKind func() ContextKind

+ GetOptionsMap func() map[string]string

+ GetViewName func() string

+ GetWindowName func() string

+ IsFocusable func() bool

+ IsTransient func() bool

+ SetWindowName func(string)

+ Title func() string

+ type IController interface

+ Context func() Context

+ type IGuiCommon interface

+ CurrentContext func() Context

+ GetAppState func() *config.AppState

+ LogAction func(action string)

+ LogCommand func(cmdStr string, isCommandLine bool)

+ OnUIThread func(f func() error)

+ OpenSearch func()

+ PopContext func() error

+ PostRefreshUpdate func(Context) error

+ PushContext func(context Context, opts ...OnFocusOpts) error

+ Refresh func(RefreshOptions) error

+ Render func()

+ RunSubprocess func(cmdObj oscommands.ICmdObj) (bool, error)

+ RunSubprocessAndRefresh func(oscommands.ICmdObj) error

+ SaveAppState func() error

+ type IList interface

+ Len func() int

+ type IListContext interface

+ FocusLine func()

+ GetList func() IList

+ GetSelectedItemId func() string

+ GetViewTrait func() IViewTrait

+ OnSearchSelect func(selectedLineIdx int) error

+ type IListCursor interface

+ GetSelectedLineIdx func() int

+ MoveSelectedLine func(delta int)

+ RefreshSelectedIdx func()

+ SetSelectedLineIdx func(value int)

+ type IListPanelState interface

+ GetSelectedLineIdx func() int

+ SetSelectedLineIdx func(int)

+ type IPopupHandler interface

+ Alert func(title string, message string) error

+ Confirm func(opts ConfirmOpts) error

+ Error func(err error) error

+ ErrorMsg func(message string) error

+ GetPromptInput func() string

+ Menu func(opts CreateMenuOptions) error

+ Prompt func(opts PromptOpts) error

+ Toast func(message string)

+ WithLoaderPanel func(message string, f func() error) error

+ WithWaitingStatus func(message string, f func() error) error

+ type IViewTrait interface

+ FocusPoint func(yIdx int)

+ PageDelta func() int

+ ScrollDown func()

+ ScrollLeft func()

+ ScrollRight func()

+ ScrollUp func()

+ SelectedLineIdx func() int

+ SetContent func(content string)

+ SetFooter func(value string)

+ SetOriginX func(value int)

+ SetViewPortContent func(content string)

+ ViewPortYBounds func() (int, int)

+ type Key interface

+ type KeybindingGuards struct

+ NoPopupPanel Guard

+ OutsideFilterMode Guard

+ type KeybindingsFn func(opts KeybindingsOpts) []*Binding

+ type KeybindingsOpts struct

+ Config config.KeybindingConfig

+ GetKey func(key string) Key

+ Guards KeybindingGuards

+ type ListItem interface

+ Description func() string

+ ID func() string

+ type MenuItem struct

+ Key Key

+ Label string

+ LabelColumns []string

+ OnPress func() error

+ OpensMenu bool

+ Tooltip string

+ type Model struct

+ BisectInfo *git_commands.BisectInfo

+ Branches []*models.Branch

+ CommitFiles []*models.CommitFile

+ Commits []*models.Commit

+ Files []*models.File

+ FilesTrie *patricia.Trie

+ FilteredReflogCommits []*models.Commit

+ ReflogCommits []*models.Commit

+ RemoteBranches []*models.RemoteBranch

+ Remotes []*models.Remote

+ StashEntries []*models.StashEntry

+ SubCommits []*models.Commit

+ Submodules []*models.SubmoduleConfig

+ Tags []*models.Tag

+ type Modes struct

+ CherryPicking *cherrypicking.CherryPicking

+ Diffing diffing.Diffing

+ Filtering filtering.Filtering

+ type MouseKeybindingsFn func(opts KeybindingsOpts) []*gocui.ViewMouseBinding

+ type OnFocusOpts struct

+ ClickedViewLineIdx int

+ ClickedViewName string

+ type ParentContexter interface

+ GetParentContext func() (Context, bool)

+ SetParentContext func(Context)

+ type PromptOpts struct

+ FindSuggestionsFunc func(string) []*Suggestion

+ HandleClose func() error

+ HandleConfirm func(string) error

+ InitialContent string

+ Mask bool

+ Title string

+ type Ref interface

+ Description func() string

+ FullRefName func() string

+ ParentRefName func() string

+ RefName func() string

+ type RefreshMode int

+ const ASYNC

+ const BLOCK_UI

+ const SYNC

+ type RefreshOptions struct

+ Mode RefreshMode

+ Scope []RefreshableView

+ Then func()

+ type RefreshableView int

+ const BISECT_INFO

+ const BRANCHES

+ const COMMITS

+ const FILES

+ const REBASE_COMMITS

+ const REFLOG

+ const REMOTES

+ const STASH

+ const STATUS

+ const SUBMODULES

+ const TAGS

+ type StartArgs struct

+ FilterPath string

+ GitArg GitArg

+ func NewStartArgs(filterPath string, gitArg GitArg) StartArgs

Dec 24, 2020

Changes in this version

+ type Suggestion struct

+ Label string

+ Value string