Docs
Widgets / directory

Styled Button

STYLED_BUTTON

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

At a glance

Default4 x 2
Minimum2 x 1
Resizeboth
Pinrequired
Interactiveyes

Behavior

  • Server profile stores custom text and color per state.
  • Useful for pump, fan and mode toggles with explicit visual feedback.
  • In the app it occupies more space than the plain button for readability.

Firmware contract

Same callback model as Button, but usually paired with labels like HEAT / IDLE.

On the app side this widget snaps to the 8-column square grid and uses both resizing. Its raw type is STYLED_BUTTON and the matching icon token in the app is rectangle.fill.

Pin support: A configured pin is required before the widget becomes meaningful.

Transmission: Payload format depends on the widget type and the selected pinType.

Canvas preview

docs.widget.preview
Styled Button
stable
STATUS

Widget contract

PropertyValue
Raw typeSTYLED_BUTTON
Default size4 x 2
Minimum size2 x 1
Resize modeboth
Pin requirementrequired
Pin supportSee behavior and firmware contract above
Interactiveyes
TransmissionDepends on the widget payload type

Allowed pin families

Bound to the configured pinType and limited by how the current app/connector serialize the widget payload.

Transport path

Payload leaves the canvas through the dashboard transport and lands on the selected virtual, digital or analog endpoint.

Operational limits

Server-side behavior may still depend on board library support and project policy.

Configuration surface

  • Color, label and position are stored in the dashboard profile.
  • Use the app-side widget config sheet to tune behavior per widget type.

Limits and caveats

  • Server-side behavior may still depend on board library support and project policy.

Layout notes

Canvas footprint

4 x 2

Default footprint in the Plynx canvas before user resizing.

Resize floor

2 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.

Slider

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

Vertical Slider

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

Step

Increment and decrement control with fixed step size and optional send-delta mode.