Skip to content

table: defaults for row/header/footer align/valign; fixes #340 #341

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

Merged
merged 1 commit into from
Nov 17, 2024
Merged

table: defaults for row/header/footer align/valign; fixes #340 #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 57 additions & 12 deletions table/render_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,20 +112,64 @@ A Song of Ice and Fire`)
}

func TestTable_Render_Align(t *testing.T) {
tw := NewWriter()
tw.AppendHeader(testHeader)
tw.AppendRows(testRows)
tw.AppendRow(Row{500, "Jamie", "Lannister", "Kingslayer", "The things I do for love."})
tw.AppendRow(Row{1000, "Tywin", "Lannister", nil})
tw.AppendFooter(testFooter)
tw.SetColumnConfigs([]ColumnConfig{
{Name: "First Name", Align: text.AlignLeft, AlignHeader: text.AlignLeft, AlignFooter: text.AlignLeft},
{Name: "Last Name", Align: text.AlignRight, AlignHeader: text.AlignRight, AlignFooter: text.AlignRight},
{Name: "Salary", Align: text.AlignAuto, AlignHeader: text.AlignRight, AlignFooter: text.AlignAuto},
{Number: 5, Align: text.AlignJustify, AlignHeader: text.AlignJustify, AlignFooter: text.AlignJustify},
t.Run("defaults", func(t *testing.T) {
tw := NewWriter()
tw.AppendHeader(Row{"#", "First\nName", "Last\nName", "Final\nState", "Misc.\nMulti-line\nNotes"})
tw.AppendRows([]Row{
{1, "Arya", "Stark", ":) 8)"},
{20, "Jon", "Snow", ":( :( :(", "You know nothing, Jon Snow!"},
{300, "Tyrion", "Lannister", ":)"},
})
tw.AppendFooter(Row{"#", "First\nName", "Last\nName", "Final\nState", "Misc.\nMulti-line\nNotes"})
tw.Style().Format = FormatOptions{
FooterAlign: text.AlignRight,
FooterVAlign: text.VAlignTop,
HeaderAlign: text.AlignLeft,
HeaderVAlign: text.VAlignBottom,
RowAlign: text.AlignCenter,
RowVAlign: text.VAlignMiddle,
}
tw.SetColumnConfigs([]ColumnConfig{ // takes precedence
{
Name: "Final\nState",
Align: text.AlignLeft, VAlign: text.VAlignTop,
AlignHeader: text.AlignLeft, VAlignHeader: text.VAlignTop,
AlignFooter: text.AlignLeft, VAlignFooter: text.VAlignBottom,
},
})

compareOutput(t, tw.Render(), `
+-----+--------+-----------+----------+-----------------------------+
| | | | Final | Misc. |
| | First | Last | State | Multi-line |
| # | Name | Name | | Notes |
+-----+--------+-----------+----------+-----------------------------+
| 1 | Arya | Stark | :) 8) | |
| 20 | Jon | Snow | :( :( :( | You know nothing, Jon Snow! |
| 300 | Tyrion | Lannister | :) | |
+-----+--------+-----------+----------+-----------------------------+
| # | First | Last | | Misc. |
| | Name | Name | Final | Multi-line |
| | | | State | Notes |
+-----+--------+-----------+----------+-----------------------------+`)

})

compareOutput(t, tw.Render(), `
t.Run("column overrides", func(t *testing.T) {
tw := NewWriter()
tw.AppendHeader(testHeader)
tw.AppendRows(testRows)
tw.AppendRow(Row{500, "Jamie", "Lannister", "Kingslayer", "The things I do for love."})
tw.AppendRow(Row{1000, "Tywin", "Lannister", nil})
tw.AppendFooter(testFooter)
tw.SetColumnConfigs([]ColumnConfig{
{Name: "First Name", Align: text.AlignLeft, AlignHeader: text.AlignLeft, AlignFooter: text.AlignLeft},
{Name: "Last Name", Align: text.AlignRight, AlignHeader: text.AlignRight, AlignFooter: text.AlignRight},
{Name: "Salary", Align: text.AlignAuto, AlignHeader: text.AlignRight, AlignFooter: text.AlignAuto},
{Number: 5, Align: text.AlignJustify, AlignHeader: text.AlignJustify, AlignFooter: text.AlignJustify},
})

compareOutput(t, tw.Render(), `
+------+------------+-----------+------------+-----------------------------+
| # | FIRST NAME | LAST NAME | SALARY | |
+------+------------+-----------+------------+-----------------------------+
Expand All @@ -137,6 +181,7 @@ func TestTable_Render_Align(t *testing.T) {
+------+------------+-----------+------------+-----------------------------+
| | | TOTAL | 10000 | |
+------+------------+-----------+------------+-----------------------------+`)
})
}

func TestTable_Render_AutoIndex(t *testing.T) {
Expand Down
26 changes: 19 additions & 7 deletions table/style.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,17 +690,29 @@ var (

// FormatOptions defines the text-formatting to perform on parts of the Table.
type FormatOptions struct {
Direction text.Direction // (forced) BiDi direction for each Column
Footer text.Format // footer row(s) text format
Header text.Format // header row(s) text format
Row text.Format // (data) row(s) text format
Direction text.Direction // (forced) BiDi direction for each Column
Footer text.Format // default text format
FooterAlign text.Align // default horizontal align
FooterVAlign text.VAlign // default vertical align
Header text.Format // default text format
HeaderAlign text.Align // default horizontal align
HeaderVAlign text.VAlign // default vertical align
Row text.Format // default text format
RowAlign text.Align // default horizontal align
RowVAlign text.VAlign // default vertical align
}

// FormatOptionsDefault defines sensible formatting options.
var FormatOptionsDefault = FormatOptions{
Footer: text.FormatUpper,
Header: text.FormatUpper,
Row: text.FormatDefault,
Footer: text.FormatUpper,
FooterAlign: text.AlignDefault,
FooterVAlign: text.VAlignDefault,
Header: text.FormatUpper,
HeaderAlign: text.AlignDefault,
HeaderVAlign: text.VAlignDefault,
Row: text.FormatDefault,
RowAlign: text.AlignDefault,
RowVAlign: text.VAlignDefault,
}

// HTMLOptions defines the global options to control HTML rendering.
Expand Down
15 changes: 15 additions & 0 deletions table/table.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,12 @@ func (t *Table) getAlign(colIdx int, hint renderHint) text.Align {
align = text.AlignRight
} else if hint.isAutoIndexRow {
align = text.AlignCenter
} else if hint.isHeaderRow {
align = t.style.Format.HeaderAlign
} else if hint.isFooterRow {
align = t.style.Format.FooterAlign
} else {
align = t.style.Format.RowAlign
}
}
return align
Expand Down Expand Up @@ -671,6 +677,15 @@ func (t *Table) getVAlign(colIdx int, hint renderHint) text.VAlign {
vAlign = cfg.VAlign
}
}
if vAlign == text.VAlignDefault {
if hint.isHeaderRow {
vAlign = t.style.Format.HeaderVAlign
} else if hint.isFooterRow {
vAlign = t.style.Format.FooterVAlign
} else {
vAlign = t.style.Format.RowVAlign
}
}
return vAlign
}

Expand Down