Docs
Widgets / directory

Text Input

TEXT_INPUT

Freeform string input for commands, labels, tokens or terminal-like control fields.

At a glance

Default4 x 2
Minimum3 x 1
Resizeboth
Pinrequired
Interactiveyes

Behavior

  • Good for Wi-Fi credentials, command channels and macro fields.
  • Often paired with Button or Terminal for submit workflows.
  • Should be validated server-side before sensitive operations.

Firmware contract

Use param.asStr() and parse commands or arbitrary text payloads.

On the app side this widget snaps to the 8-column square grid and uses both resizing. Its raw type is TEXT_INPUT and the matching icon token in the app is character.cursor.ibeam.

Pin support: Usually virtual pins carrying string payloads.

Transmission: Single UTF-8 text body sent through the app protocol path.

Canvas preview

docs.widget.preview
Text Input
stable
STATUS

Widget contract

PropertyValue
Raw typeTEXT_INPUT
Default size4 x 2
Minimum size3 x 1
Resize modeboth
Pin requirementrequired
Pin supportUsually virtual pins carrying string payloads.
Interactiveyes
TransmissionSingle UTF-8 text body sent through the app protocol path.

Allowed pin families

Usually virtual pins carrying string payloads.

Transport path

Single UTF-8 text body sent through the app protocol path.

Operational limits

The protocol body is finite and should not be treated as a rich text channel

Configuration surface

  • label and placeholder matter for safe usage
  • pair with explicit submit action for risky commands

Limits and caveats

  • The protocol body is finite and should not be treated as a rich text channel
  • Sensitive credentials should be redacted from logs

Layout notes

Canvas footprint

4 x 2

Default footprint in the Plynx canvas before user resizing.

Resize floor

3 x 1

The minimum size accepted by the app during drag-resize.

Interaction model

Live input

Whether the user edits state directly or only reads it.

Related widgets

Button

Momentary or toggle actuator for a single virtual or hardware pin.

Styled Button

A richer button with distinct on/off labels and color states.

Slider

Horizontal continuous input with min, max and send strategy options.

Vertical Slider

Vertical range control for compact side panels and console-style layouts.