docs(table): update readme and examples

c4spar · Jul 26, 2020 · df18516 · df18516
1 parent 9c05cc3
commit df18516
Show file tree

Hide file tree

Showing 25 changed files with 598 additions and 499 deletions.
diff --git a/assets/img/table/basic-usage.png b/assets/img/table/basic-usage.png
diff --git a/assets/img/table/colspan-and-rowspan.png b/assets/img/table/colspan-and-rowspan.png
diff --git a/assets/img/table/header-and-body.png b/assets/img/table/header-and-body.png
diff --git a/assets/img/table/random-table.gif b/assets/img/table/random-table.gif
diff --git a/assets/img/table/rows-and-cells.png b/assets/img/table/rows-and-cells.png
diff --git a/assets/img/table/table-options.png b/assets/img/table/table-options.png
diff --git a/assets/img/table/using-as-array.png b/assets/img/table/using-as-array.png
diff --git a/examples/table/basic-usage.ts b/examples/table/basic-usage.ts
@@ -0,0 +1,12 @@
+#!/usr/bin/env -S deno run
+
+import { Table } from '../../packages/table/lib/table.ts';
+
+const table: Table = new Table(
+    [ 'Row 1 Column 1', 'Row 1 Column 2', 'Row 1 Column 3' ],
+    [ 'Row 2 Column 1', 'Row 2 Column 2', 'Row 2 Column 3' ],
+    [ 'Row 3 Column 1', 'Row 3 Column 2', 'Row 3 Column 3' ]
+);
+
+console.log( table.toString() );
+// You can also use table.render() as shorthand which uses Deno.stdout.writeSync() under the hood.
diff --git a/examples/table/colspan-and-rowspan.ts b/examples/table/colspan-and-rowspan.ts
@@ -0,0 +1,15 @@
+#!/usr/bin/env -S deno run
+
+import { Cell } from '../../packages/table/lib/cell.ts';
+import { Table } from '../../packages/table/lib/table.ts';
+
+Table.from( [
+        [ Cell.from( 'Row 1 & 2 Column 1' ).rowSpan( 2 ), 'Row 1 Column 2', 'Row 1 Column 3' ],
+        [ Cell.from( 'Row 2 Column 2 & 3' ).colSpan( 2 ) ],
+        [ Cell.from( 'Row 3 & 4 Column 1' ).rowSpan( 2 ), 'Row 3 Column 2', 'Row 3 Column 3' ],
+        [ Cell.from( 'Row 4 Column 2 & 3' ).colSpan( 2 ) ],
+        [ 'Row 5 Column 1', Cell.from( 'Row 5 & 6 Column 2 & 3' ).rowSpan( 2 ).colSpan( 2 ) ],
+        [ 'Row 6 Column 1' ]
+    ] )
+    .border( true )
+    .render();
diff --git a/examples/table/header-and-body.ts b/examples/table/header-and-body.ts
@@ -0,0 +1,12 @@
+#!/usr/bin/env -S deno run
+
+import { Table } from '../../packages/table/lib/table.ts';
+
+new Table()
+    .header( [ 'Heading 1', 'Heading 2', 'Heading 3' ] )
+    .body( [
+        [ 'Row 1 Column 1', 'Row 1 Column 2', 'Row 1 Column 3' ],
+        [ 'Row 2 Column 1', 'Row 2 Column 2', 'Row 2 Column 3' ],
+        [ 'Row 3 Column 1', 'Row 3 Column 2', 'Row 3 Column 3' ]
+    ] )
+    .render();
diff --git a/examples/table/multiline-border-table.ts b/examples/table/multiline-border-table.ts
diff --git a/examples/table/multiline-nested-border-table.ts b/examples/table/multiline-nested-border-table.ts
diff --git a/examples/table/multiline-nested-table.ts b/examples/table/multiline-nested-table.ts
diff --git a/examples/table/multiline-table.ts b/examples/table/multiline-table.ts
diff --git a/examples/table/nested-tables.ts b/examples/table/nested-tables.ts
diff --git a/examples/table/padding-indent.ts b/examples/table/padding-indent.ts