Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links for widgets on documentation #95

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 39 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,27 @@ var screen = blessed.screen({ term: 'windows-ansi' });
Blessed comes with a number of high-level widgets so you can avoid all the
nasty low-level terminal stuff.


#### Node (from EventEmitter)
* [Node](#node)
* [Screen](#screen)
* [Element](#element)
* [Box](#box)
* [Text](#text)
* [Line](#line)
* [ScrollableBox (deprecated)](#scrollable-box)
* [ScrollableText (deprecated)](#scrollable-text)
* [List](#list)
* [Form](#form)
* [Input](#input)
* [Textarea](#textarea)
* [Textbox](#textbox)
* [Button](#button)
* [ProgressBar](#progress-bar)
* [FileManager](#file-manager)
* [Checkbox](#checkbox)
* [RadioSet](#radio-set)
* [RadioButton](#radio-button)

#### <a name="node">Node</a> (from EventEmitter)

The base node which everything inherits from.

Expand Down Expand Up @@ -144,7 +163,7 @@ The base node which everything inherits from.
- **set(name, value)** - set user property to value.


#### Screen (from Node)
#### <a name="screen">[Screen]</a> (from [Node](#node))

The screen on which every other node renders.

Expand Down Expand Up @@ -254,7 +273,7 @@ The screen on which every other node renders.
- **deleteTop(top, bottom)** - delete a line at the top of the screen.


#### Element (from Node)
#### <a name="element">Element</a> (from [Node](#node))

The base element.

Expand Down Expand Up @@ -414,7 +433,7 @@ parameter must be a string.
the screen.


#### Box (from Element)
#### <a name="box">Box</a> (from [Element](#element))

A box element which draws a simple box containing `content` or other elements.

Expand All @@ -435,7 +454,7 @@ A box element which draws a simple box containing `content` or other elements.
- inherits all from Element.


#### Text (from Element)
#### <a name="text">Text</a> (from [Element](#element))

An element similar to Box, but geared towards rendering simple text elements.

Expand All @@ -449,7 +468,7 @@ An element similar to Box, but geared towards rendering simple text elements.
Inherits all options, properties, events, and methods from Element.


#### Line (from Box)
#### <a name="line">Line</a> (from [Box](#box))

A simple line which can be `line` or `bg` styled.

Expand All @@ -463,7 +482,7 @@ A simple line which can be `line` or `bg` styled.
Inherits all options, properties, events, and methods from Box.


#### ScrollableBox (from Box)
#### <a name="scrollable-box">ScrollableBox</a> (from [Box](#box))

**DEPRECATED** - Use Box with the `scrollable` option instead.

Expand Down Expand Up @@ -501,7 +520,7 @@ A box with scrollable content.
- **resetScroll()** - reset the scroll index to its initial state.


#### ScrollableText (from ScrollableBox)
#### <a name="scrollable-text">ScrollableText</a> (from [ScrollableBox](#scrollable-box))

**DEPRECATED** - Use Box with the `scrollable` and `alwaysScroll` options
instead.
Expand Down Expand Up @@ -529,7 +548,7 @@ pre-existing newlines and escape codes.
- inherits all from ScrollableBox.


#### List (from Box)
#### <a name="list">List</a> (from [Box](#box))

A scrollable list which can display selectable items.

Expand Down Expand Up @@ -584,7 +603,7 @@ A scrollable list which can display selectable items.
executed with the result.


#### Form (from Box)
#### <a name="form">Form</a> (from [Box](#box))

A form which can contain form elements.

Expand Down Expand Up @@ -616,12 +635,12 @@ A form which can contain form elements.
- **reset()** - clear the form.


#### Input (from Box)
#### <a name="input">Input</a> (from [Box](#box))

A form input.


#### Textarea (from Input)
#### <a name="textarea">Textarea</a> (from [Input](#input))

A box which allows multiline text input.

Expand Down Expand Up @@ -660,7 +679,7 @@ A box which allows multiline text input.
- **setValue(text)** - set value.


#### Textbox (from Textarea)
#### <a name="textbox">Textbox</a> (from [Textarea](#textarea))

A box which allows text input.

Expand All @@ -685,7 +704,7 @@ A box which allows text input.
- inherits all from Textarea.


#### Button (from Input)
#### <a name="button">Button</a> (from [Input](#input))

A button which can be focused and allows key and mouse input.

Expand All @@ -708,7 +727,7 @@ A button which can be focused and allows key and mouse input.
- **press()** - press button. emits `press`.


#### ProgressBar (from Input)
#### <a name="progress-bar">ProgressBar</a> (from [Input](#input))

A progress bar allowing various styles. This can also be used as a form input.

Expand Down Expand Up @@ -742,7 +761,7 @@ A progress bar allowing various styles. This can also be used as a form input.
- **reset()** - reset the bar.


#### FileManager (from List)
#### <a name="file-manager">FileManager</a> (from [List](#list))

A very simple file manager for selecting files.

Expand Down Expand Up @@ -771,7 +790,7 @@ A very simple file manager for selecting files.
- **reset([cwd], [callback])** - reset back to original cwd.


#### Checkbox (from Input)
#### <a name="checkbox">Checkbox</a> (from [Input](#input))

A checkbox which can be used in a form element.

Expand Down Expand Up @@ -803,7 +822,7 @@ A checkbox which can be used in a form element.
- **toggle()** - toggle checked state.


#### RadioSet (from Box)
#### <a name="radio-set">RadioSet</a> (from [Box](#box))

An element wrapping RadioButtons. RadioButtons within this element will be
mutually exclusive with each other.
Expand All @@ -825,7 +844,7 @@ mutually exclusive with each other.
- inherits all from Box.


#### RadioButton (from Checkbox)
#### <a name="radio-button">RadioButton</a> (from [Checkbox](#checkbox))

A radio button which can be used in a form element.

Expand Down