Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: multicolumn layout forms #214

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: multicolumn layout forms #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fb06a2a
feat: multicolumn layout forms
adamdottv May 3, 2024
8b20d6b
feat: form layouts
adamdottv May 4, 2024
95c02c6
fix: linting errors
adamdottv May 4, 2024
5bbb20a
feat: grid layout
adamdottv May 8, 2024
bbaef64
fix: blur causes validation
adamdottv May 10, 2024
c58c7ea
Merge branch 'main' into main
maaslalani Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions examples/layout/columns/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package main

import "github.com/charmbracelet/huh"

func main() {
form := huh.NewForm(
huh.NewGroup(
huh.NewInput().Title("First"),
huh.NewInput().Title("Second"),
huh.NewInput().Title("Third"),
),
huh.NewGroup(
huh.NewInput().Title("Fourth"),
huh.NewInput().Title("Fifth"),
huh.NewInput().Title("Sixth"),
),
huh.NewGroup(
huh.NewInput().Title("Seventh"),
huh.NewInput().Title("Eigth"),
huh.NewInput().Title("Nineth"),
huh.NewInput().Title("Tenth"),
),
).WithLayout(huh.LayoutColumns(2))
form.Run()
}
25 changes: 25 additions & 0 deletions examples/layout/default/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package main

import "github.com/charmbracelet/huh"

func main() {
form := huh.NewForm(
huh.NewGroup(
huh.NewInput().Title("First"),
huh.NewInput().Title("Second"),
huh.NewInput().Title("Third"),
),
huh.NewGroup(
huh.NewInput().Title("Fourth"),
huh.NewInput().Title("Fifth"),
huh.NewInput().Title("Sixth"),
),
huh.NewGroup(
huh.NewInput().Title("Seventh"),
huh.NewInput().Title("Eigth"),
huh.NewInput().Title("Nineth"),
huh.NewInput().Title("Tenth"),
),
)
form.Run()
}
30 changes: 30 additions & 0 deletions examples/layout/grid/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package main

import "github.com/charmbracelet/huh"

func main() {
form := huh.NewForm(
huh.NewGroup(
huh.NewInput().Title("First"),
huh.NewInput().Title("Second"),
huh.NewInput().Title("Third"),
),
huh.NewGroup(
huh.NewInput().Title("Fourth"),
huh.NewInput().Title("Fifth"),
huh.NewInput().Title("Sixth"),
),
huh.NewGroup(
huh.NewInput().Title("Seventh"),
huh.NewInput().Title("Eigth"),
huh.NewInput().Title("Nineth"),
huh.NewInput().Title("Tenth"),
),
huh.NewGroup(
huh.NewInput().Title("Eleventh"),
huh.NewInput().Title("Twelveth"),
huh.NewInput().Title("Thirteenth"),
),
).WithLayout(huh.LayoutGrid(2, 2))
form.Run()
}
25 changes: 25 additions & 0 deletions examples/layout/stack/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package main

import "github.com/charmbracelet/huh"

func main() {
form := huh.NewForm(
huh.NewGroup(
huh.NewInput().Title("First"),
huh.NewInput().Title("Second"),
huh.NewInput().Title("Third"),
),
huh.NewGroup(
huh.NewInput().Title("Fourth"),
huh.NewInput().Title("Fifth"),
huh.NewInput().Title("Sixth"),
),
huh.NewGroup(
huh.NewInput().Title("Seventh"),
huh.NewInput().Title("Eigth"),
huh.NewInput().Title("Nineth"),
huh.NewInput().Title("Tenth"),
),
).WithLayout(huh.LayoutStack)
form.Run()
}
22 changes: 20 additions & 2 deletions form.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ type Form struct {
height int
keymap *KeyMap
teaOptions []tea.ProgramOption

layout Layout
}

// NewForm returns a form with the given groups and default themes and
Expand All @@ -78,6 +80,7 @@ func NewForm(groups ...*Group) *Form {
paginator: p,
keymap: NewDefaultKeyMap(),
results: make(map[string]any),
layout: LayoutDefault,
teaOptions: []tea.ProgramOption{
tea.WithOutput(os.Stderr),
},
Expand Down Expand Up @@ -266,6 +269,7 @@ func (f *Form) WithWidth(width int) *Form {
}
f.width = width
for _, group := range f.groups {
width := f.layout.GroupWidth(f, group, width)
group.WithWidth(width)
}
return f
Expand Down Expand Up @@ -301,6 +305,14 @@ func (f *Form) WithProgramOptions(opts ...tea.ProgramOption) *Form {
return f
}

// WithLayout sets the layout on a form.
//
// This allows customization of the form group layout.
func (f *Form) WithLayout(layout Layout) *Form {
f.layout = layout
return f
}

// UpdateFieldPositions sets the position on all the fields.
func (f *Form) UpdateFieldPositions() *Form {
firstGroup := 0
Expand Down Expand Up @@ -431,6 +443,9 @@ func (f *Form) PrevField() tea.Cmd {
func (f *Form) Init() tea.Cmd {
cmds := make([]tea.Cmd, len(f.groups))
for i, group := range f.groups {
if i == 0 {
group.active = true
}
cmds[i] = group.Init()
}

Expand All @@ -457,7 +472,8 @@ func (f *Form) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
break
}
for _, group := range f.groups {
group.WithWidth(msg.Width)
width := f.layout.GroupWidth(f, group, msg.Width)
group.WithWidth(width)
}
if f.height > 0 {
break
Expand Down Expand Up @@ -507,6 +523,7 @@ func (f *Form) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
return submit()
}
}
f.groups[f.paginator.Page].active = true
return f, f.groups[f.paginator.Page].Init()

case prevGroupMsg:
Expand All @@ -521,6 +538,7 @@ func (f *Form) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
}
}

f.groups[f.paginator.Page].active = true
return f, f.groups[f.paginator.Page].Init()
}

Expand Down Expand Up @@ -551,7 +569,7 @@ func (f *Form) View() string {
return ""
}

return f.groups[f.paginator.Page].View()
return f.layout.View(f)
}

// Run runs the form.
Expand Down
31 changes: 27 additions & 4 deletions group.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ type Group struct {
height int
keymap *KeyMap
hide func() bool
active bool
}

// NewGroup returns a new group with the given fields.
Expand All @@ -53,6 +54,7 @@ func NewGroup(fields ...Field) *Group {
help: help.New(),
showHelp: true,
showErrors: true,
active: false,
}

height := group.fullHeight()
Expand Down Expand Up @@ -190,8 +192,10 @@ func (g *Group) Init() tea.Cmd {
return tea.Batch(cmds...)
}

cmd := g.fields[g.paginator.Page].Focus()
cmds = append(cmds, cmd)
if g.active {
cmd := g.fields[g.paginator.Page].Focus()
cmds = append(cmds, cmd)
}
g.buildView()
return tea.Batch(cmds...)
}
Expand Down Expand Up @@ -261,7 +265,7 @@ func (g *Group) fullHeight() int {
return height
}

func (g *Group) buildView() {
func (g *Group) getContent() (int, string) {
var fields strings.Builder
offset := 0
gap := "\n\n"
Expand All @@ -282,14 +286,33 @@ func (g *Group) buildView() {
}
}

g.viewport.SetContent(fields.String() + "\n")
return offset, fields.String() + "\n"
}

func (g *Group) buildView() {
offset, content := g.getContent()

g.viewport.SetContent(content)
g.viewport.SetYOffset(offset)
}

// View renders the group.
func (g *Group) View() string {
var view strings.Builder
view.WriteString(g.viewport.View())
view.WriteString(g.Footer())
return view.String()
}

// Content renders the group's content only (no footer).
func (g *Group) Content() string {
_, content := g.getContent()
return content
}

// Footer renders the group's footer only (no content).
func (g *Group) Footer() string {
var view strings.Builder
view.WriteRune('\n')
errors := g.Errors()
if g.showHelp && len(errors) <= 0 {
Expand Down