Show Frame

Show Frame

The Show Frame action loads and displays a frame within the current interface. It is commonly used to add additional UI layers such as menus, overlays, dialogs, or dynamic content areas.

Frames displayed with Show Frame can later be removed using the Hide Frame action. Together, these actions allow interfaces to be composed dynamically using multiple frame layers.


Parameters

Parameter
Description

Frame

The frame that should be displayed

Alignment

Defines how the frame is aligned on the screen

Position

Additional X/Y offset applied to the alignment

Size

Custom width and height for the frame

Position Relative to Size

Interprets the position values relative to the frame size

Size Relative to Size

Interprets the size values relative to the original frame size

ID

Identifier used to reference the displayed frame layer

Relative to Mouse Position

Positions the frame at the mouse click location

Hide When Focus Lost

Automatically hides the frame when it loses focus

Persistent

Keeps the frame active until it is explicitly hidden

Replace Frame ID

Replaces an existing frame with the specified ID

Use User Widget

Displays a user widget instead of a frame

Transition

Defines how the frame appears

Transition Duration

Duration of the transition animation


Frame

Defines the frame that will be loaded and displayed.

The selected frame is rendered as a new interface layer and can be positioned independently from the main layout.


Alignment

Defines the base position of the frame on the screen.

Available options:

  • Top Left

  • Top Center

  • Top Right

  • Center Left

  • Center

  • Center Right

  • Bottom Left

  • Bottom Center

  • Bottom Right

The alignment defines the anchor point for positioning the frame. The frame’s original dimensions are automatically taken into account.


Position

The Position parameter defines an additional X/Y offset in pixels that is applied after the alignment.

This allows precise positioning adjustments relative to the chosen alignment anchor.

Example:

Moves the frame 20px right and 10px up from the alignment position.


Size

Defines the size of the displayed frame.

Value
Behavior

0,0

Uses the original frame size

Custom values

Overrides the frame size with the specified width and height


Position Relative to Size

If enabled, the Position values are interpreted relative to the frame size rather than as absolute pixel values.


Size Relative to Size

If enabled, the Size values are interpreted relative to the original frame size instead of absolute pixel dimensions.


ID

The ID identifies the frame layer created by this action.

This identifier is used to reference the layer later, for example when removing it using Hide Frame.

Frames are not directly linked to specific frame objects in this workflow. Instead, the ID defines a logical UI layer that can display different frames over time.

Typical layer IDs include:

  • Menu

  • Content

  • Header

  • Overlay

This allows interfaces to manage different UI regions independently.


Relative to Mouse Position

If enabled, the frame is positioned at the mouse click location instead of using the alignment settings.

This is useful for elements such as:

  • context menus

  • popups

  • tooltips


Hide When Focus Lost

If enabled, the frame automatically disappears when it loses focus.

This is commonly used for temporary interface elements such as dropdown menus or popups.


Persistent

If enabled, the frame remains visible until it is explicitly hidden using Hide Frame.


Replace Frame ID

If a frame ID is specified here, the frame currently associated with that ID will automatically be replaced by the new frame.

This allows dynamic switching of content within the same interface layer.


Use User Widget

Instead of loading a full frame, this option allows displaying a user widget.

This can be useful for smaller reusable UI elements.


Transition

Defines how the frame appears.

Available options:

  • None

  • Fade In

  • Slide In Left

  • Slide In Top

  • Slide In Right

  • Slide In Bottom


Transition Duration

Defines the duration of the transition animation when the frame appears.

Last updated