Class BabylonGuiInputText

Single-line text fields the user can type into, with a placeholder shown while empty. Subscribe to the text changed event to react to typing.

Index

Constructors

create

createInputText createInputTextObservableSelector

get

getBackground getText getPlaceholder

set

setBackground setText setPlaceholder

Constructors

constructor

new BabylonGuiInputText(): BabylonGuiInputText
Returns BabylonGuiInputText

create

createInputText

createInputText(inputs: CreateInputTextDto): InputText
Creates a text field holding text, showing placeholder while it is empty, in the given colors; sizes are pixel strings or fractions of the parent.
Parameters
- inputs: CreateInputTextDto
  The name, the text, the placeholder, the colors and the optional size
Returns InputText
The text field
Example
```
const input = bitbybit.babylon.gui.inputText.createInputText({ name: "label", text: "", placeholder: "Type a label", color: "#f0cebb", background: "black", width: "300px", height: "40px" });
panel.addControl(input);
input.onTextChangedObservable.add((field) => { console.log(field.text); });
```
- Defined in bitbybit-docs.d.ts:49260

createInputTextObservableSelector

createInputTextObservableSelector(
inputs: InputTextObservableSelectorDto,
): inputTextObservableSelectorEnum
Passes through the name of a text field event, its text changing, as a typed selector for code that subscribes to text field events by name.
Parameters
- inputs: InputTextObservableSelectorDto
  The event selector
Returns inputTextObservableSelectorEnum
The same selector
- Defined in bitbybit-docs.d.ts:49317

get

getBackground

getBackground(inputs: InputTextDto): string
Reads the background color of a text field.
Parameters
- inputs: InputTextDto
  The text field
Returns string
The background color
- Defined in bitbybit-docs.d.ts:49292

getText

getText(inputs: InputTextDto): string
Reads the text a text field currently holds, as typed by the user.
Parameters
- inputs: InputTextDto
  The text field
Returns string
The text
- Defined in bitbybit-docs.d.ts:49300

getPlaceholder

getPlaceholder(inputs: InputTextDto): string
Reads the hint a text field shows while it is empty.
Parameters
- inputs: InputTextDto
  The text field
Returns string
The placeholder
- Defined in bitbybit-docs.d.ts:49308

set

setBackground

setBackground(inputs: SetInputTextBackgroundDto): InputText
Sets the background color of a text field, as a CSS color.
Parameters
- inputs: SetInputTextBackgroundDto
  The text field and the background color
Returns InputText
The same text field
- Defined in bitbybit-docs.d.ts:49268

setText

setText(inputs: SetInputTextTextDto): InputText
Replaces the text a text field holds, which fires its text changed event like typing would.
Parameters
- inputs: SetInputTextTextDto
  The text field and the text
Returns InputText
The same text field
- Defined in bitbybit-docs.d.ts:49276

setPlaceholder

setPlaceholder(inputs: SetInputTextPlaceholderDto): InputText
Sets the hint a text field shows while it is empty.
Parameters
- inputs: SetInputTextPlaceholderDto
  The text field and the placeholder
Returns InputText
The same text field
- Defined in bitbybit-docs.d.ts:49284