Console Api
Provides methods for creating a console on a page. These functions are available under the `convenienceApi.console` namespace.
Properties
- containersPromise ⇒
Promise
- Contains a reference to the console root element container.
- generate
- A collection of functions that are capable of generating elements used by the console with preset defaults
- isVisible ⇒
Boolean
- Gets whether the console element is visible
- isVisible
- Shows or hides the console element
Methods
- destroy() ⇒
Promise
- Removes children of the console element
Properties Details
containersPromise ⇒ Promise
Contains a reference to the console root element container.
Returns: Promise
- Promise of rootElement.
generate
A collection of functions that are capable of generating elements used by the console with preset defaults
Properties
Name |
Type |
Description |
generate |
Object
|
A collection of functions that are capable of generating elements used by the console with preset defaults |
generate.button |
button
|
A function that generates a button |
generate.buttonStyledAsLink |
buttonStyledAsLink
|
Generate a button styled as link |
generate.section |
section
|
Generate a section |
generate.sectionTitle |
sectionTitle
|
Generate a section title |
generate.title |
title
|
Generate console title |
Generate a button
Returns: HTMLElement
- generated button element
Param |
Type |
Description |
props |
Object
|
a collection of attributes |
Generate a button styled as link
Returns: HTMLElement
- generated button element
Param |
Type |
Description |
props |
Object
|
a collection of attributes |
generate.section ⇒ HTMLElement
Generate a section
Returns: HTMLElement
- generated section element
Param |
Type |
Description |
props |
Object
|
a collection of attributes |
children |
Array.<HTMLElement>
|
section child elements |
generate.sectionTitle ⇒ HTMLElement
Generate a section title
Returns: HTMLElement
- generated section title element
Param |
Type |
Description |
props |
Object
|
a collection of attributes |
generate.title ⇒ HTMLElement
Generate console title
Returns: HTMLElement
- generated title element
Param |
Type |
Description |
props |
Object
|
a collection of attributes |
isVisible ⇒ Boolean
Gets whether the console element is visible
Returns: Boolean
- True if the console is displayed and false otherwise
isVisible
Shows or hides the console element
Param |
Type |
Description |
value |
Boolean
|
if true, display the console, hide otherwise |
destroy() ⇒ Promise
Removes children of the console element
Returns: Promise
- promise of a destroyed console