Ui XML Input - BLKTower/TestWiki GitHub Wiki

Table of Contents

A text input frame. By default, this frame type attempts to fill its parent size unless given explicit dimensions.

Example Usage

    <Input height="30" width="200" />

This XML produces the following UI: image

Related Trigger Function(s):

A text input frame

text

Value type: string

Description

The text in the input frame.

Example Usage

<Input height="30" width="200" text="Text Input" />

Related Trigger Function(s):

bind:enable

Value type: string

Description

The bind value for enabling the input frame.

Example Usage

<Frame xmlns:bind="https://platform.wildsky.dev/xml/ui/bind">
    <State name="enable" booleanValue="false" />
    <Input height="30" width="200" placeholder="Text Input" bind:enable="state.enable" />
</Frame>

Related Trigger Function(s):

  • None.

translationKey

Value type: string

Supports data binding

Description

The translation key for the input frame. This uses a translation key declared in the data editor (Localization tab) to display text across different languages.

Example Usage

<Input height="30" width="200" text="Text Input" translationKey="key" />

Related Trigger Function(s):

  • None.

fontSize

Value type: number

Supports data binding

Description

The font size for the input frame.

Example Usage

<Input height="100" width="400" text="Text Input" fontSize="80" color="r: 1, g: 0, b: 0, a: 1" />

Related Trigger Function(s):

color

Value type: color

Description

The font color for the input frame.

Example Usage

<Input height="30" width="200" text="Text Input" color="r: 0, g: 0, b: 1, a: 1" />

Related Trigger Function(s):

outline

Value type: boolean

Supports data binding

Description

The text outline status for the input frame, where true enables the text outline.

Example Usage

<Input height="100" width="400" text="Text Input" fontSize="80" color="r: 1, g: 0, b: 0, a: 1" outline="true" />

Related Trigger Function(s):

wrapping

Value type: boolean

Supports data binding

Description

The font wrapping status for the input frame, where true enables font wrapping. Font wrapping will wrap text to the next line if it would exceed the current line. By default, this value is false for input frames.

Example Usage

<Input height="300" width="200" text="Text Input" fontSize="80" color="r: 1, g: 0, b: 0, a: 1" wrapping="true" />

Related Trigger Function(s):

placeholder

Value type: string

Supports data binding

Description

The placeholder text for the input frame. This text is bolded and italicized by default.

Example Usage

<Input height="40" width="200" placeholder="Text Input" />

Related Trigger Function(s):

placeholderTranslationKey

Value type: string

Supports data binding

Description

The translation key for the placeholder text. This uses a translation key declared in the data editor (Localization tab) to display text across different languages.

Example Usage

<Input height="30" width="200" text="Hello" placeholderTranslationKey="key" />

Related Trigger Function(s):

  • None.

placeholderFontSize

Value type: number

Supports data binding

Description

The placeholder text font size for the input frame.

Example Usage

<Input height="90" width="400" placeholder="Text Input" placeholderFontSize="60" />

Related Trigger Function(s):

placeholderColor

Value type: color

Description

The placeholder text color for the input frame.

Example Usage

<Input height="90" width="400" placeholder="Text Input" placeholderFontSize="60" placeholderColor="r: 0, g: 0, b: 1, a: 1" />

Related Trigger Function(s):

bind:enplaceholderColorable

Value type: string

Description

The bind value for if the placeholder text is colorable.

Example Usage

<Frame xmlns:bind="https://platform.wildsky.dev/xml/ui/bind">
    <State name="colorable" booleanValue="true" />
    <Input height="90" width="400" placeholder="Text Input" placeholderFontSize="60" bind:enplaceholderColorable="state.colorable" placeholderColor="r: 0, g: 0, b: 1, a: 1" />
</Frame>

Related Trigger Function(s):

  • None.

placeholderOutline

Value type: boolean

Supports data binding

Description

The placeholder text outline status for the input frame, where true enables the text outline. The outline is always black.

Example Usage

<Input height="90" width="400" placeholder="Text Input" placeholderFontSize="60" placeholderColor="r: 1, g: 1, b: 0, a: 1" placeholderOutline="true" />

Related Trigger Function(s):

⚠️ **GitHub.com Fallback** ⚠️