Picnic Tables ============= A Kotlin DSL and Java/Kotlin builder API for constructing HTML-like tables which can be rendered to text. Features: * Borders (with multiple styles) * Padding (left/right/top/bottom) * Per-table, row, and cell styling * Header/footer sections * Row/column spans * Text alignment DSL: ```kotlin table { row("Hello", "World") row("Hola", "Mundo") } ``` ``` HelloWorld Hola Mundo ``` Very underwhelming! Picnic tables start completely unstyled by design. Jump to a [real-world example](#real-world-example) or continue reading for individual features. _(Note: these examples do not render correctly on mobile)_ ### Border ```kotlin table { cellStyle { // These options affect the style of all cells contained within the table. border = true } row("Hello", "World") row("Hola", "Mundo") } ``` ``` ┌─────┬─────┐ │Hello│World│ ├─────┼─────┤ │Hola │Mundo│ └─────┴─────┘ ``` ### Table Border Style ```kotlin table { style { // Unlike cellStyle, these options affect the style of the table itself. borderStyle = Hidden } cellStyle { border = true } row("Hello", "World") row("Hola", "Mundo") } ``` ``` Hello│World ─────┼───── Hola │Mundo ``` ### Padding ```kotlin table { cellStyle { border = true paddingLeft = 1 paddingRight = 1 } row("Hello", "World") row("Hola", "Mundo") } ``` ``` ┌───────┬───────┐ │ Hello │ World │ ├───────┼───────┤ │ Hola │ Mundo │ └───────┴───────┘ ``` ### Table, Row, and Cell Style ```kotlin table { cellStyle { border = true paddingLeft = 1 paddingRight = 1 } row { cellStyle { // These options affect only the cells contained within this row and override table options. paddingTop = 1 } cell("Hello") cell("World") } row { cell("Hola") cell("Mundo") { // These options affect only this specific cell and override row and table options. border = false } } } ``` ``` ┌───────┬───────┐ │ │ │ │ Hello │ World │ ├───────┼───────┘ │ Hola │ Mundo └───────┘ ``` ### Header and Footer ```kotlin table { header { // Rows in a header always come first no matter when they're added. row("Hello", "Header") } footer { // Rows in a footer always come last no matter when they're added. row("Hello", "Footer") } row("Hello", "World") cellStyle { border = true } } ``` ``` ┌─────┬──────┐ │Hello│Header│ ├─────┼──────┤ │Hello│World │ ├─────┼──────┤ │Hello│Footer│ └─────┴──────┘ ``` ### Row and Column Span ```kotlin table { cellStyle { border = true } row { cell("Hello") { rowSpan = 2 } cell("World") } // This row has only one cell because "Hello" will carry over and push it to the right. row("Mars") // This row has only one cell because it spans two columns. row { cell("Hola Mundo") { columnSpan = 2 } } } ``` ``` ┌─────┬─────┐ │Hello│World│ │ ├─────┤ │ │Mars │ ├─────┴─────┤ │Hola Mundo │ └───────────┘ ``` ### Text Alignment ```kotlin table { cellStyle { border = true alignment = TopCenter } row { cell("Hello") { rowSpan = 4 alignment = MiddleLeft } cell("Mercury") } row("Venus") row("Earth") row("Mars") row { cell("Hola") { rowSpan = 4 alignment = MiddleLeft } cell("Jupiter") } row("Saturn") row("Uranus") row("Neptune") row("Adios", "Pluto") } ``` ``` ┌─────┬───────┐ │ │Mercury│ │ ├───────┤ │ │ Venus │ │Hello├───────┤ │ │ Earth │ │ ├───────┤ │ │ Mars │ ├─────┼───────┤ │ │Jupiter│ │ ├───────┤ │ │Saturn │ │Hola ├───────┤ │ │Uranus │ │ ├───────┤ │ │Neptune│ ├─────┼───────┤ │Adios│ Pluto │ └─────┴───────┘ ``` ### Real-world Example Here is a more advanced, real-world example from the [Diffuse](https://github.com/JakeWharton/diffuse/) tool. It features row and column spans, headers and footers, borders, table border style, padding, and text alignment. ```kotlin table { style { borderStyle = Hidden } cellStyle { alignment = MiddleRight paddingLeft = 1 paddingRight = 1 borderLeft = true borderRight = true } header { cellStyle { border = true alignment = BottomLeft } row { cell("APK") { rowSpan = 2 } cell("compressed") { alignment = BottomCenter columnSpan = 3 } cell("uncompressed") { alignment = BottomCenter columnSpan = 3 } } row("old", "new", "diff", "old", "new", "diff") } body { row("dex", "664.8 KiB", "664.8 Kib", "-25 B", "1.5 MiB", "1.5 MiB", "-112 B") // "arsc", "manifest", etc… } footer { cellStyle { border = true } row("total", "1.3 MiB", "1.3 MiB", "-39 B", "2.2 MiB", "2.2 MiB", "-112 B") } } ``` ``` │ compressed │ uncompressed ├───────────┬───────────┬───────┼───────────┬───────────┬──────── APK │ old │ new │ diff │ old │ new │ diff ──────────┼───────────┼───────────┼───────┼───────────┼───────────┼──────── dex │ 664.8 KiB │ 664.8 KiB │ -25 B │ 1.5 MiB │ 1.5 MiB │ -112 B arsc │ 201.7 KiB │ 201.7 KiB │ 0 B │ 201.6 KiB │ 201.6 KiB │ 0 B manifest │ 1.4 KiB │ 1.4 KiB │ 0 B │ 4.2 KiB │ 4.2 KiB │ 0 B res │ 418.2 KiB │ 418.2 KiB │ -14 B │ 488.3 KiB │ 488.3 KiB │ 0 B asset │ 0 B │ 0 B │ 0 B │ 0 B │ 0 B │ 0 B other │ 37.1 KiB │ 37.1 KiB │ 0 B │ 36.3 KiB │ 36.3 KiB │ 0 B ──────────┼───────────┼───────────┼───────┼───────────┼───────────┼──────── total │ 1.3 MiB │ 1.3 MiB │ -39 B │ 2.2 MiB │ 2.2 MiB │ -112 B ``` Download -------- ```groovy repositories { mavenCentral() } dependencies { implementation 'com.jakewharton.picnic:picnic:0.7.0' } ```
Snapshots of the development version are available in Sonatype's snapshots repository.

```groovy repositories { maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } } dependencies { implementation 'com.jakewharton.picnic:picnic:0.8.0-SNAPSHOT' } ```

License ======= Copyright 2015 Jake Wharton Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.