Updated Grid layout (markdown)

Jakub Sobon 2019-04-07 17:08:06 -04:00
parent dc3f0c0625
commit 08039e009c
1 changed files with 8 additions and 0 deletions

@ -27,12 +27,20 @@ The **grid.ColWidthPerc** function defines a new Column of the specified width.
The sum of all Column widths on the same level cannot be more than 100%. If it is less than 100%, the last Column will stretch to the edge of the screen. The sum of all Column widths on the same level cannot be more than 100%. If it is less than 100%, the last Column will stretch to the edge of the screen.
## [grid.ColWidthPercWithOpts](https://godoc.org/github.com/mum4k/termdash/container/grid#ColWidthPercWithOpts):
The **grid.ColWidthPercWithOpts** function is an alternative for **grid.ColWidthPerc** and allows the caller to also specify options for the intermediate container that represents the added column.
## [grid.RowHeightPerc](https://godoc.org/github.com/mum4k/termdash/container/grid#RowHeightPerc): ## [grid.RowHeightPerc](https://godoc.org/github.com/mum4k/termdash/container/grid#RowHeightPerc):
The **grid.RowHeightPerc** function defines a new Row of the specified height. The height is specified as a percentage of the parent's height. I.e. for the top-most Row, this will be percentage of the terminal's height. For a sub-Row, this will be a percentage of the parent's height. The parent is either a Row or a Column. The **grid.RowHeightPerc** function defines a new Row of the specified height. The height is specified as a percentage of the parent's height. I.e. for the top-most Row, this will be percentage of the terminal's height. For a sub-Row, this will be a percentage of the parent's height. The parent is either a Row or a Column.
The sum of all Row heights on the same level cannot be more than 100%. If it is less than 100%, the last Row will stretch to the edge of the screen. The sum of all Row heights on the same level cannot be more than 100%. If it is less than 100%, the last Row will stretch to the edge of the screen.
## [grid.RowHeightPercWithOpts](https://godoc.org/github.com/mum4k/termdash/container/grid#RowHeightPercWithOpts):
The **grid.RowHeightPercWithOpts** function is an alternative for **grid.RowHeightPerc** and allows the caller to also specify options for the intermediate container that represents the added row.
## [grid.Widget](https://godoc.org/github.com/mum4k/termdash/container/grid#Widget): ## [grid.Widget](https://godoc.org/github.com/mum4k/termdash/container/grid#Widget):
The **grid.Widget** function adds the specified [[widget|widget-api]] into the current Row or Column. The developer can also specify any additional container options to be applied to the same container. See the [[Container API|container-api]] for more details about container options. The **grid.Widget** function adds the specified [[widget|widget-api]] into the current Row or Column. The developer can also specify any additional container options to be applied to the same container. See the [[Container API|container-api]] for more details about container options.