unleashed-firmware/documentation/js/js_textbox.md
Ruslan Nadyrshin 9a02e23dc7
New js modules documentation added (#3736)
* New js modules documentation added
* Documentation: Spelling and formatting

Co-authored-by: ElectronicsInFocus <rnadyrshin@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>
2024-06-30 12:18:46 +01:00

1.2 KiB

js_textbox

Textbox module

let textbox = require("textbox");

Methods

setConfig

Set focus and font for the textbox.

Parameters

  • focus: "start" to focus on the beginning of the text, or "end" to focus on the end of the text
  • font: "text" to use the default proportional font, or "hex" to use a monospaced font, which is convenient for aligned array output in HEX

Example

textbox.setConfig("start", "text");
textbox.addText("Hello world");
textbox.show();

addText

Add text to the end of the textbox.

Parameters

  • text (string): The text to add to the end of the textbox

Example

textbox.addText("New text 1\nNew text 2");

clearText

Clear the textbox.

Example

textbox.clearText();

isOpen

Return true if the textbox is open.

Returns

True if the textbox is open, false otherwise.

Example

let isOpen = textbox.isOpen();

show

Show the textbox. You can add text to it using the addText() method before or after calling the show() method.

Example

textbox.show();

close

Close the textbox.

Example

if (textbox.isOpen()) {
    textbox.close();
}