Documentation
¶
Overview ¶
Package message contains shared messages which are used to communicate between bubbletea components
Index ¶
- func DisplayNotification(targetComponentName, text string, titledModel titledUIModel) tea.Cmd
- func TeaCmd(msg any) func() tea.Msg
- type ErrorOccurred
- type ExitWithError
- type GroupSelect
- type HideUINotification
- type HostCreate
- type HostSSHConfigLoadComplete
- type HostSelect
- type HostUpdate
- type InitComplete
- type RunProcessErrorOccurred
- type RunProcessSSHConnect
- type RunProcessSSHCopyID
- type RunProcessSSHLoadConfig
- type RunProcessSuccess
- type TerminalSizePolling
- type ViewGroupListClose
- type ViewGroupListOpen
- type ViewHostEditClose
- type ViewHostEditOpen
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DisplayNotification ¶ added in v1.4.0
DisplayNotification - dispatches UI event to display a notification in the UI for a specific component.
Types ¶
type ErrorOccurred ¶ added in v1.3.0
type ErrorOccurred struct{ Err error }
ErrorOccurred - is dispatched when an error occurs.
type ExitWithError ¶ added in v1.5.0
type ExitWithError struct{ Err error }
ExitWithError - indicates that something bad happened and we need to close the application.
type GroupSelect ¶ added in v1.5.0
type GroupSelect struct{ Name string }
GroupSelect - is dispatched when select a group in group list view.
type HideUINotification ¶ added in v1.4.0
type HideUINotification struct{ ComponentName string }
HideUINotification - is dispatched when it's time to hide UI notification and display normal component's title.
type HostCreate ¶ added in v1.5.0
HostCreate - is dispatched when a new host was added to the database.
type HostSSHConfigLoadComplete ¶ added in v1.5.0
HostSSHConfigLoadComplete triggers when app loads a host config using ssh -G <hostname>. The config is stored in main model: m.appState.HostSSHConfig.
type HostSelect ¶ added in v1.5.0
type HostSelect struct{ HostID int }
HostSelect is required to let host list know that it's time to update title.
type HostUpdate ¶ added in v1.5.0
HostUpdate - is dispatched when host model is updated.
type InitComplete ¶
type InitComplete struct{}
InitComplete - is a message which is sent when bubbletea models are initialized.
type RunProcessErrorOccurred ¶ added in v1.1.0
type RunProcessErrorOccurred struct {
ProcessType constant.ProcessType
StdOut string // Even if process fails, it may have some output.
StdErr string
}
RunProcessErrorOccurred fires when there is an error executing an external process.
type RunProcessSSHConnect ¶ added in v1.2.0
RunProcessSSHConnect is dispatched when user wants to connect to a host.
type RunProcessSSHCopyID ¶ added in v1.2.0
RunProcessSSHCopyID is dispatched when user wants to copy SSH key to a remote host.
type RunProcessSSHLoadConfig ¶ added in v1.2.0
RunProcessSSHLoadConfig is dispatched it's required to read .ssh/config file for a certain host.
type RunProcessSuccess ¶ added in v1.1.0
type RunProcessSuccess struct {
ProcessType constant.ProcessType
StdOut string
StdErr string // Even if process succeeds, it may have some output.
}
RunProcessSuccess fires when external process exits normally.
type TerminalSizePolling ¶ added in v0.2.0
type TerminalSizePolling struct{ Width, Height int }
TerminalSizePolling - is a message which is sent when terminal width and/or height changes.
type ViewGroupListClose ¶ added in v1.5.0
type ViewGroupListClose struct{}
ViewGroupListClose - dispatched when it's required to close group list view.
type ViewGroupListOpen ¶ added in v1.5.0
type ViewGroupListOpen struct{}
ViewGroupListOpen - dispatched when it's required to open group list view.
type ViewHostEditClose ¶ added in v1.5.0
type ViewHostEditClose struct{}
ViewHostEditClose triggers when users exits from edit form without saving results.
type ViewHostEditOpen ¶ added in v1.5.0
type ViewHostEditOpen struct{ HostID int }
ViewHostEditOpen fires when user press edit button on a selected host.