You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,43 @@ func main() {
86
86
87
87
Create a table with `NewTable` or `NewWriter`, configure it using options or a `Config` struct, add data with `Append` or `Bulk`, and render to an `io.Writer`. Use renderers like `Blueprint` (ASCII), `HTML`, `Markdown`, `Colorized`, or `Ocean` (streaming).
88
88
89
+
Here's how the API primitives map to the generated ASCII table:
-**Renderer** - Implements the core interface for converting table data into output formats. Available renderers include Blueprint (ASCII), HTML, Markdown, Colorized (ASCII with color), Ocean (streaming ASCII), and SVG.
112
+
113
+
-**Config** - The root configuration struct that controls all table behavior and appearance
114
+
-**Behavior** - Controls high-level rendering behaviors including auto-hiding empty columns, trimming row whitespace, header/footer visibility, and compact mode for optimized merged cell calculations
115
+
-**CellConfig** - The comprehensive configuration template used for table sections (header, row, footer). Combines formatting, padding, alignment, filtering, callbacks, and width constraints with global and per-column control
116
+
-**StreamConfig** - Configuration for streaming mode including enable/disable state and strict column validation
117
+
118
+
-**Rendition** - Defines how a renderer formats tables and contains the complete visual styling configuration
119
+
-**Borders** - Control the outer frame visibility (top, bottom, left, right edges) of the table
120
+
-**Lines** - Control horizontal boundary lines (above/below headers, above footers) that separate different table sections
121
+
-**Separators** - Control the visibility of separators between rows and between columns within the table content
122
+
-**Symbols** - Define the characters used for drawing table borders, corners, and junctions
123
+
124
+
These components can be configured with various `tablewriter.With*()` functional options when creating a new table.
0 commit comments