smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Inline single use interfaces

Browse Source
This commit is contained in:
Dolan
2021-03-15 00:11:39 +00:00
parent 18ce200cdb
commit a3febae8a3
42 changed files with 91 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/usage/tables.md
View File

@ -4,9 +4,9 @@
## Intro
* `Tables` contain a list of `Rows`
* `Rows` contain a list of `TableCells`
* `TableCells` contain a list of `Parahraphs` and/or `Tables`. You can add `Tables` as tables can be nested inside each other
- `Tables` contain a list of `Rows`
- `Rows` contain a list of `TableCells`
- `TableCells` contain a list of `Parahraphs` and/or `Tables`. You can add `Tables` as tables can be nested inside each other
Create a simple table like so:
@ -85,11 +85,11 @@ const table = new Table({
Here is a list of options you can add to the `table row`:
| Property | Type | Notes |
| ----------- | ------------------------------------- | -------- |
| children | `Array<TableCell>` | Required |
| cantSplit | `boolean` | Optional |
| tableHeader | `boolean` | Optional |
| Property | Type | Notes |
| ----------- | -------------------------------------- | -------- |
| children | `Array<TableCell>` | Required |
| cantSplit | `boolean` | Optional |
| tableHeader | `boolean` | Optional |
| height | `{ height: number, rule: HeightRule }` | Optional |
### Repeat row
@ -142,7 +142,7 @@ const tableRow = new TableRow({
| Property | Type | Notes |
| ------------- | ----------------------------------- | ----------------------------------------------------------- |
| children | `Array<Paragraph | Table>` | Required. You can nest tables by adding a table into a cell |
| children | `Array<Paragraph or Table>` | Required. You can nest tables by adding a table into a cell |
| shading | `ITableShadingAttributesProperties` | Optional |
| margins | `ITableCellMarginOptions` | Optional |
| verticalAlign | `VerticalAlign` | Optional |
@ -336,7 +336,6 @@ const table = new Table({
});
```
## Examples
[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/4-basic-table.ts ':include')