git.iko.soy/crush
on main help sign in
feat(ui): status: add status bar with info messages and help toggle
17e6616Ayman Bagabas
internal/ui/model/status.gonew file+106
compare with main
unifiedsplit
@@ -0,0 +1,106 @@
1+package model
2+
3+import (
4+ "time"
5+
6+ "charm.land/bubbles/v2/help"
7+ tea "charm.land/bubbletea/v2"
8+ "charm.land/lipgloss/v2"
9+ "github.com/charmbracelet/crush/internal/ui/common"
10+ "github.com/charmbracelet/crush/internal/uiutil"
11+ uv "github.com/charmbracelet/ultraviolet"
12+ "github.com/charmbracelet/x/ansi"
13+)
14+
15+// DefaultStatusTTL is the default time-to-live for status messages.
16+const DefaultStatusTTL = 5 * time.Second
17+
18+// Status is the status bar and help model.
19+type Status struct {
20+ com *common.Common
21+ help help.Model
22+ helpKm help.KeyMap
23+ msg uiutil.InfoMsg
24+}
25+
26+// NewStatus creates a new status bar and help model.
27+func NewStatus(com *common.Common, km help.KeyMap) *Status {
28+ s := new(Status)
29+ s.com = com
30+ s.help = help.New()
31+ s.help.Styles = com.Styles.Help
32+ s.helpKm = km
33+ return s
34+}
35+
36+// SetInfoMsg sets the status info message.
37+func (s *Status) SetInfoMsg(msg uiutil.InfoMsg) {
38+ s.msg = msg
39+}
40+
41+// ClearInfoMsg clears the status info message.
42+func (s *Status) ClearInfoMsg() {
43+ s.msg = uiutil.InfoMsg{}
44+}
45+
46+// SetWidth sets the width of the status bar and help view.
47+func (s *Status) SetWidth(width int) {
48+ s.help.SetWidth(width)
49+}
50+
51+// ShowingAll returns whether the full help view is shown.
52+func (s *Status) ShowingAll() bool {
53+ return s.help.ShowAll
54+}
55+
56+// ToggleHelp toggles the full help view.
57+func (s *Status) ToggleHelp() {
58+ s.help.ShowAll = !s.help.ShowAll
59+}
60+
61+// Draw draws the status bar onto the screen.
62+func (s *Status) Draw(scr uv.Screen, area uv.Rectangle) {
63+ helpView := s.com.Styles.Status.Help.Render(s.help.View(s.helpKm))
64+ uv.NewStyledString(helpView).Draw(scr, area)
65+
66+ // Render notifications
67+ if s.msg.IsEmpty() {
68+ return
69+ }
70+
71+ var indStyle lipgloss.Style
72+ var msgStyle lipgloss.Style
73+ switch s.msg.Type {
74+ case uiutil.InfoTypeError:
75+ indStyle = s.com.Styles.Status.ErrorIndicator
76+ msgStyle = s.com.Styles.Status.ErrorMessage
77+ case uiutil.InfoTypeWarn:
78+ indStyle = s.com.Styles.Status.WarnIndicator
79+ msgStyle = s.com.Styles.Status.WarnMessage
80+ case uiutil.InfoTypeUpdate:
81+ indStyle = s.com.Styles.Status.UpdateIndicator
82+ msgStyle = s.com.Styles.Status.UpdateMessage
83+ case uiutil.InfoTypeInfo:
84+ indStyle = s.com.Styles.Status.InfoIndicator
85+ msgStyle = s.com.Styles.Status.InfoMessage
86+ case uiutil.InfoTypeSuccess:
87+ indStyle = s.com.Styles.Status.SuccessIndicator
88+ msgStyle = s.com.Styles.Status.SuccessMessage
89+ }
90+
91+ ind := indStyle.String()
92+ messageWidth := area.Dx() - lipgloss.Width(ind)
93+ msg := ansi.Truncate(s.msg.Msg, messageWidth, "…")
94+ info := msgStyle.Width(messageWidth).Render(msg)
95+
96+ // Draw the info message over the help view
97+ uv.NewStyledString(ind+info).Draw(scr, area)
98+}
99+
100+// clearInfoMsgCmd returns a command that clears the info message after the
101+// given TTL.
102+func clearInfoMsgCmd(ttl time.Duration) tea.Cmd {
103+ return tea.Tick(ttl, func(time.Time) tea.Msg {
104+ return uiutil.ClearStatusMsg{}
105+ })
106+}
internal/ui/model/ui.go+25−20
@@ -82,7 +82,7 @@ type UI struct {
82 keyenh tea.KeyboardEnhancementsMsg
82 keyenh tea.KeyboardEnhancementsMsg
83
83
84 dialog *dialog.Overlay
84 dialog *dialog.Overlay
85− help help.Model
85+ status *Status
86
86
87 // header is the last cached header logo
87 // header is the last cached header logo
88 header string
88 header string
@@ -137,13 +137,14 @@ func New(com *common.Common) *UI {
137 com: com,
137 com: com,
138 dialog: dialog.NewOverlay(),
138 dialog: dialog.NewOverlay(),
139 keyMap: DefaultKeyMap(),
139 keyMap: DefaultKeyMap(),
140− help: help.New(),
141 focus: uiFocusNone,
140 focus: uiFocusNone,
142 state: uiConfigure,
141 state: uiConfigure,
143 textarea: ta,
142 textarea: ta,
144 chat: ch,
143 chat: ch,
145 }
144 }
146
145
146+ status := NewStatus(com, ui)
147+
147 // set onboarding state defaults
148 // set onboarding state defaults
148 ui.onboarding.yesInitializeSelected = true
149 ui.onboarding.yesInitializeSelected = true
149
150
@@ -162,7 +163,7 @@ func New(com *common.Common) *UI {
162 ui.setEditorPrompt(false)
163 ui.setEditorPrompt(false)
163 ui.randomizePlaceholders()
164 ui.randomizePlaceholders()
164 ui.textarea.Placeholder = ui.readyPlaceholder
165 ui.textarea.Placeholder = ui.readyPlaceholder
165− ui.help.Styles = com.Styles.Help
166+ ui.status = status
166
167
167 return ui
168 return ui
168}
169}
@@ -338,6 +339,15 @@ func (m *UI) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
338 case openEditorMsg:
339 case openEditorMsg:
339 m.textarea.SetValue(msg.Text)
340 m.textarea.SetValue(msg.Text)
340 m.textarea.MoveToEnd()
341 m.textarea.MoveToEnd()
342+ case uiutil.InfoMsg:
343+ m.status.SetInfoMsg(msg)
344+ ttl := msg.TTL
345+ if ttl <= 0 {
346+ ttl = DefaultStatusTTL
347+ }
348+ cmds = append(cmds, clearInfoMsgCmd(ttl))
349+ case uiutil.ClearStatusMsg:
350+ m.status.ClearInfoMsg()
341 }
351 }
342
352
343 // This logic gets triggered on any message type, but should it?
353 // This logic gets triggered on any message type, but should it?
@@ -480,7 +490,7 @@ func (m *UI) handleKeyPressMsg(msg tea.KeyPressMsg) tea.Cmd {
480 handleGlobalKeys := func(msg tea.KeyPressMsg) bool {
490 handleGlobalKeys := func(msg tea.KeyPressMsg) bool {
481 switch {
491 switch {
482 case key.Matches(msg, m.keyMap.Help):
492 case key.Matches(msg, m.keyMap.Help):
483− m.help.ShowAll = !m.help.ShowAll
493+ m.status.ToggleHelp()
484 m.updateLayoutAndSize()
494 m.updateLayoutAndSize()
485 return true
495 return true
486 case key.Matches(msg, m.keyMap.Commands):
496 case key.Matches(msg, m.keyMap.Commands):
@@ -569,7 +579,7 @@ func (m *UI) handleKeyPressMsg(msg tea.KeyPressMsg) tea.Cmd {
569 cmds = append(cmds, uiutil.ReportError(err))
579 cmds = append(cmds, uiutil.ReportError(err))
570 }
580 }
571 case dialog.ToggleHelpMsg:
581 case dialog.ToggleHelpMsg:
572− m.help.ShowAll = !m.help.ShowAll
582+ m.status.ToggleHelp()
573 m.dialog.CloseDialog(dialog.CommandsID)
583 m.dialog.CloseDialog(dialog.CommandsID)
574 case dialog.QuitMsg:
584 case dialog.QuitMsg:
575 cmds = append(cmds, tea.Quit)
585 cmds = append(cmds, tea.Quit)
@@ -815,9 +825,8 @@ func (m *UI) Draw(scr uv.Screen, area uv.Rectangle) {
815 editor.Draw(scr, layout.editor)
825 editor.Draw(scr, layout.editor)
816 }
826 }
817
827
818− // Add help layer
828+ // Add status and help layer
819− help := uv.NewStyledString(m.help.View(m))
820− help.Draw(scr, layout.help)
829+ m.status.Draw(scr, layout.status)
821
830
822 // Debugging rendering (visually see when the tui rerenders)
831 // Debugging rendering (visually see when the tui rerenders)
823 if os.Getenv("CRUSH_UI_DEBUG") == "true" {
832 if os.Getenv("CRUSH_UI_DEBUG") == "true" {
@@ -1077,8 +1086,8 @@ func (m *UI) updateLayoutAndSize() {
1077
1086
1078// updateSize updates the sizes of UI components based on the current layout.
1087// updateSize updates the sizes of UI components based on the current layout.
1079func (m *UI) updateSize() {
1088func (m *UI) updateSize() {
1080− // Set help width
1089+ // Set status width
1081− m.help.SetWidth(m.layout.help.Dx())
1090+ m.status.SetWidth(m.layout.status.Dx())
1082
1091
1083 m.chat.SetSize(m.layout.main.Dx(), m.layout.main.Dy())
1092 m.chat.SetSize(m.layout.main.Dx(), m.layout.main.Dy())
1084 m.textarea.SetWidth(m.layout.editor.Dx())
1093 m.textarea.SetWidth(m.layout.editor.Dx())
@@ -1115,18 +1124,16 @@ func (m *UI) generateLayout(w, h int) layout {
1115 headerHeight := 4
1124 headerHeight := 4
1116
1125
1117 var helpKeyMap help.KeyMap = m
1126 var helpKeyMap help.KeyMap = m
1118− if m.help.ShowAll {
1127+ if m.status.ShowingAll() {
1119 for _, row := range helpKeyMap.FullHelp() {
1128 for _, row := range helpKeyMap.FullHelp() {
1120 helpHeight = max(helpHeight, len(row))
1129 helpHeight = max(helpHeight, len(row))
1121 }
1130 }
1122 }
1131 }
1123
1132
1124 // Add app margins
1133 // Add app margins
1125− appRect := area
1134+ appRect, helpRect := uv.SplitVertical(area, uv.Fixed(area.Dy()-helpHeight))
1126 appRect.Min.X += 1
1135 appRect.Min.X += 1
1127− appRect.Min.Y += 1
1128 appRect.Max.X -= 1
1136 appRect.Max.X -= 1
1129− appRect.Max.Y -= 1
1130
1137
1131 if slices.Contains([]uiState{uiConfigure, uiInitialize, uiLanding}, m.state) {
1138 if slices.Contains([]uiState{uiConfigure, uiInitialize, uiLanding}, m.state) {
1132 // extra padding on left and right for these states
1139 // extra padding on left and right for these states
@@ -1134,11 +1141,9 @@ func (m *UI) generateLayout(w, h int) layout {
1134 appRect.Max.X -= 1
1141 appRect.Max.X -= 1
1135 }
1142 }
1136
1143
1137− appRect, helpRect := uv.SplitVertical(appRect, uv.Fixed(appRect.Dy()-helpHeight))
1138−
1139 layout := layout{
1144 layout := layout{
1140− area: area,
1145+ area: area,
1141− help: helpRect,
1146+ status: helpRect,
1142 }
1147 }
1143
1148
1144 // Handle different app states
1149 // Handle different app states
@@ -1242,8 +1247,8 @@ type layout struct {
1242 // sidebar is the area for the sidebar.
1247 // sidebar is the area for the sidebar.
1243 sidebar uv.Rectangle
1248 sidebar uv.Rectangle
1244
1249
1245− // help is the area for the help view.
1250+ // status is the area for the status view.
1246− help uv.Rectangle
1251+ status uv.Rectangle
1247}
1252}
1248
1253
1249func (m *UI) openEditor(value string) tea.Cmd {
1254func (m *UI) openEditor(value string) tea.Cmd {
internal/ui/styles/styles.go+29
@@ -303,6 +303,23 @@ type Styles struct {
303
303
304 Commands struct{}
304 Commands struct{}
305 }
305 }
306+
307+ // Status bar and help
308+ Status struct {
309+ Help lipgloss.Style
310+
311+ ErrorIndicator lipgloss.Style
312+ WarnIndicator lipgloss.Style
313+ InfoIndicator lipgloss.Style
314+ UpdateIndicator lipgloss.Style
315+ SuccessIndicator lipgloss.Style
316+
317+ ErrorMessage lipgloss.Style
318+ WarnMessage lipgloss.Style
319+ InfoMessage lipgloss.Style
320+ UpdateMessage lipgloss.Style
321+ SuccessMessage lipgloss.Style
322+ }
306}
323}
307
324
308// ChromaTheme converts the current markdown chroma styles to a chroma
325// ChromaTheme converts the current markdown chroma styles to a chroma
@@ -1110,6 +1127,18 @@ func DefaultStyles() Styles {
1110
1127
1111 s.Dialog.List = base.Margin(0, 0, 1, 0)
1128 s.Dialog.List = base.Margin(0, 0, 1, 0)
1112
1129
1130+ s.Status.Help = lipgloss.NewStyle().Padding(0, 1)
1131+ s.Status.SuccessIndicator = base.Foreground(bgSubtle).Background(green).Padding(0, 1).Bold(true).SetString("OKAY!")
1132+ s.Status.InfoIndicator = s.Status.SuccessIndicator
1133+ s.Status.UpdateIndicator = s.Status.SuccessIndicator.SetString("HEY!")
1134+ s.Status.WarnIndicator = s.Status.SuccessIndicator.Foreground(bgOverlay).Background(yellow).SetString("WARNING")
1135+ s.Status.ErrorIndicator = s.Status.SuccessIndicator.Foreground(bgBase).Background(red).SetString("ERROR")
1136+ s.Status.SuccessMessage = base.Foreground(bgSubtle).Background(greenDark).Padding(0, 1)
1137+ s.Status.InfoMessage = s.Status.SuccessMessage
1138+ s.Status.UpdateMessage = s.Status.SuccessMessage
1139+ s.Status.WarnMessage = s.Status.SuccessMessage.Foreground(bgOverlay).Background(warning)
1140+ s.Status.ErrorMessage = s.Status.SuccessMessage.Foreground(white).Background(redDark)
1141+
1113 return s
1142 return s
1114}
1143}
1115
1144
internal/uiutil/uiutil.go+6
@@ -65,6 +65,12 @@ type (
65 ClearStatusMsg struct{}
65 ClearStatusMsg struct{}
66)
66)
67
67
68+// IsEmpty checks if the [InfoMsg] is empty.
69+func (m InfoMsg) IsEmpty() bool {
70+ var zero InfoMsg
71+ return m == zero
72+}
73+
68// ExecShell parses a shell command string and executes it with exec.Command.
74// ExecShell parses a shell command string and executes it with exec.Command.
69// Uses shell.Fields for proper handling of shell syntax like quotes and
75// Uses shell.Fields for proper handling of shell syntax like quotes and
70// arguments while preserving TTY handling for terminal editors.
76// arguments while preserving TTY handling for terminal editors.