aboutsummaryrefslogtreecommitdiff
path: root/node_modules/cliui/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2018-09-20 02:56:13 +0200
committerFlorian Dold <florian.dold@gmail.com>2018-09-20 02:56:13 +0200
commitbbff7403fbf46f9ad92240ac213df8d30ef31b64 (patch)
treec58400ec5124da1c7d56b01aea83309f80a56c3b /node_modules/cliui/README.md
parent003fb34971cf63466184351b4db5f7c67df4f444 (diff)
update packages
Diffstat (limited to 'node_modules/cliui/README.md')
-rw-r--r--node_modules/cliui/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/node_modules/cliui/README.md b/node_modules/cliui/README.md
index 028392c26..7861976fc 100644
--- a/node_modules/cliui/README.md
+++ b/node_modules/cliui/README.md
@@ -10,9 +10,7 @@ easily create complex multi-column command-line-interfaces.
## Example
```js
-var ui = require('cliui')({
- width: 80
-})
+var ui = require('cliui')()
ui.div('Usage: $0 [command] [options]')
@@ -88,6 +86,7 @@ cliui = require('cliui')
### cliui({width: integer})
Specify the maximum width of the UI being generated.
+If no width is provided, cliui will try to get the current window's width and use it, and if that doesn't work, width will be set to `80`.
### cliui({wrap: boolean})
@@ -99,6 +98,7 @@ Create a row with any number of columns, a column
can either be a string, or an object with the following
options:
+* **text:** some text to place in the column.
* **width:** the width of a column.
* **align:** alignment, `right` or `center`.
* **padding:** `[top, right, bottom, left]`.
@@ -108,3 +108,8 @@ options:
Similar to `div`, except the next row will be appended without
a new line being created.
+
+### cliui.resetOutput()
+
+Resets the UI elements of the current cliui instance, maintaining the values
+set for `width` and `wrap`.