actions
actions
Detailed documentation for individual actions within each set.
.10x1-image
The .10x1-image action an image with a 10x1 aspect ratio (banner!). It belongs to the images category within the ui area.
Action Syntax
.10x1-image +imagetag.10x1-image $variable.10x1-image https://...Valid sizes
Examples
// Basic Usage
.10x1-image %imagetag// Using Variables
// Display dynamic content from variables
.10x1-image $imagetag.12x1-image
The .12x1-image action an image with a 12x1 aspect ratio (mega banner!). It belongs to the images category within the ui area.
Action Syntax
.12x1-image +imagetag.12x1-image $variable.12x1-image https://...Valid sizes
Examples
// Basic Usage
.12x1-image %imagetag// Using Variables
// Display dynamic content from variables
.12x1-image $imagetag.16x9-image
The .16x9-image action an image with a 16x9 aspect ratio. It belongs to the images category within the ui area.
Action Syntax
.16x9-image +imagetag.16x9-image $variableValid sizes
Examples
// Basic Usage
.16x9-image %tag// Using Variables
// Display dynamic content from variables
.16x9-image $imagetag.1x1-image
The .1x1-image action an image with a 1x1 aspect ratio (square!). It belongs to the images category within the ui area.
Action Syntax
.1x1-image +imagetag.1x1-image $variable.1x1-image https://...Valid sizes
Examples
// Basic Usage
.1x1-image %imagetag// Using Variables
// Display dynamic content from variables
.1x1-image $imagetag.1x2-image
The .1x2-image action an image with a 1x2 aspect ratio (tall!). It belongs to the images category within the ui area.
Action Syntax
.1x2-image +imagetag.1x2-image $variable.1x2-image https://...Valid sizes
Examples
// Basic Usage
.1x2-image %imagetag// Using Variables
// Display dynamic content from variables
.1x2-image $imagetag.1x3-image
The .1x3-image action an image with a 1x3 aspect ratio (very tall!). It belongs to the images category within the ui area.
Action Syntax
.1x3-image +imagetag.1x3-image $variable.1x3-image https://...Valid sizes
Examples
// Basic Usage
.1x3-image %imagetag// Using Variables
// Display dynamic content from variables
.1x3-image $imagetag.1x4-image
The .1x4-image action an image with a 1x4 aspect ratio (extremely tall!). It belongs to the images category within the ui area.
Action Syntax
.1x4-image +imagetag.1x4-image $variable.1x4-image https://...Valid sizes
Examples
// Basic Usage
.1x4-image %imagetag// Using Variables
// Display dynamic content from variables
.1x4-image $imagetag.1x6-image
The .1x6-image action an image with a 1x6 aspect ratio (super tall!). It belongs to the images category within the ui area.
Action Syntax
.1x6-image +imagetag.1x6-image $variable.1x6-image https://...Valid sizes
Examples
// Basic Usage
.1x6-image %imagetag// Using Variables
// Display dynamic content from variables
.1x6-image $imagetag.1x8-image
The .1x8-image action an image with a 1x8 aspect ratio (ultra tall!). It belongs to the images category within the ui area.
Action Syntax
.1x8-image +imagetag.1x8-image $variable.1x8-image https://...Valid sizes
Examples
// Basic Usage
.1x8-image %imagetag// Using Variables
// Display dynamic content from variables
.1x8-image $imagetag.2x1-image
The .2x1-image action an image with a 2x1 aspect ratio (wide!). It belongs to the images category within the ui area.
Action Syntax
.2x1-image +imagetag.2x1-image $variable.2x1-image https://...Valid sizes
Examples
// Basic Usage
.2x1-image %imagetag// Using Variables
// Display dynamic content from variables
.2x1-image $imagetag.2x3-image
The .2x3-image action an image with a 2x3 aspect ratio (portrait!). It belongs to the images category within the ui area.
Action Syntax
.2x3-image +imagetag.2x3-image $variable.2x3-image https://...Valid sizes
Examples
// Basic Usage
.2x3-image %imagetag// Using Variables
// Display dynamic content from variables
.2x3-image $imagetag.3x1-image
The .3x1-image action an image with a 3x1 aspect ratio (very wide!). It belongs to the images category within the ui area.
Action Syntax
.3x1-image +imagetag.3x1-image $variable.3x1-image https://...Valid sizes
Examples
// Basic Usage
.3x1-image %imagetag// Using Variables
// Display dynamic content from variables
.3x1-image $imagetag.3x2-image
The .3x2-image action an image with a 3x2 aspect ratio (landscape!). It belongs to the images category within the ui area.
Action Syntax
.3x2-image +imagetag.3x2-image $variable.3x2-image https://...Valid sizes
Examples
// Basic Usage
.3x2-image %imagetag// Using Variables
// Display dynamic content from variables
.3x2-image $imagetag.4x1-image
The .4x1-image action an image with a 4x1 aspect ratio (extremely wide!). It belongs to the images category within the ui area.
Action Syntax
.4x1-image +imagetag.4x1-image $variable.4x1-image https://...Valid sizes
Examples
// Basic Usage
.4x1-image %imagetag// Using Variables
// Display dynamic content from variables
.4x1-image $imagetag.4x3-image
The .4x3-image action an image with a 4x3 aspect ratio (classic!). It belongs to the images category within the ui area.
Action Syntax
.4x3-image +imagetag.4x3-image $variable.4x3-image https://...Valid sizes
Examples
// Basic Usage
.4x3-image %imagetag// Using Variables
// Display dynamic content from variables
.4x3-image $imagetag.4x5-image
The .4x5-image action an image with a 4x5 aspect ratio (standard print!). It belongs to the images category within the ui area.
Action Syntax
.4x5-image +imagetag.4x5-image $variable.4x5-image https://...Valid sizes
Examples
// Basic Usage
.4x5-image %imagetag// Using Variables
// Display dynamic content from variables
.4x5-image $imagetag.5x4-image
The .5x4-image action an image with a 5x4 aspect ratio (photo print!). It belongs to the images category within the ui area.
Action Syntax
.5x4-image +imagetag.5x4-image $variable.5x4-image https://...Valid sizes
Examples
// Basic Usage
.5x4-image %imagetag// Using Variables
// Display dynamic content from variables
.5x4-image $imagetag.6x1-image
The .6x1-image action an image with a 6x1 aspect ratio (super wide!). It belongs to the images category within the ui area.
Action Syntax
.6x1-image +imagetag.6x1-image $variable.6x1-image https://...Valid sizes
Examples
// Basic Usage
.6x1-image %imagetag// Using Variables
// Display dynamic content from variables
.6x1-image $imagetag.6x9-image
The .6x9-image action an image with a 6x9 aspect ratio (postcard!). It belongs to the images category within the ui area.
Action Syntax
.6x9-image +imagetag.6x9-image $variable.6x9-image https://...Valid sizes
Examples
// Basic Usage
.6x9-image %imagetag// Using Variables
// Display dynamic content from variables
.6x9-image $imagetag.8x1-image
The .8x1-image action an image with a 8x1 aspect ratio (ultra wide!). It belongs to the images category within the ui area.
Action Syntax
.8x1-image +imagetag.8x1-image $variable.8x1-image https://...Valid sizes
Examples
// Basic Usage
.8x1-image %imagetag// Using Variables
// Display dynamic content from variables
.8x1-image $imagetag.a
The .a action Creates a clickable link that navigates to web pages. It belongs to the html category within the ui area.
Action Syntax
.a https://....a $variableValid sizes
Examples
// Basic Usage
.a https://example.com// Using Variables
// Display dynamic content from variables
.a $url-variable.account-signup
The .account-signup action shows account sign up screen. It belongs to the account category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.account-signup.acknowledge
The .acknowledge action shows a message that need to be explictly acknowledged/dismissed. It belongs to the acknowledgement category within the ui area.
Action Syntax
.acknowledge "text".acknowledge blk.acknowledge $variableValid sizes
Examples
// Basic Usage
.acknowledge "message"// Using Variables
// Display dynamic content from variables
.acknowledge $message.acknowledge-once
The .acknowledge-once action shows a message that need to be explictly acknowledged. One it is, it does not show up again. It belongs to the acknowledgement category within the ui area.
Action Syntax
.acknowledge-once "text".acknowledge-once blk.acknowledge-once $variableValid sizes
Examples
// Basic Usage
.acknowledge-once "message"// Using Variables
// Display dynamic content from variables
.acknowledge-once $message.action-help
The .action-help action displays action help screen. It belongs to the help category within the system area.
Action Syntax
.action-help "text".action-help $variableValid sizes
Examples
// Basic Usage
.action-help "actionname"// Using Variables
// Display dynamic content from variables
.action-help $actionmame.action-list
The .action-list action shows a list of actions (search result). It belongs to the help category within the system area.
Action Syntax
.action-list $variableValid sizes
Examples
// Basic Usage
.action-list $Ggroupname.alt
The .alt action sets the alt text modifier for an element. It belongs to the modifier category within the ui area.
Action Syntax
.alt "text".alt $variableValid sizes
Examples
// Basic Usage
.alt "help"// Using Variables
// Display dynamic content from variables
.alt $text.announcement
The .announcement action shows an in-app top banner announcement. It belongs to the announcements category within the interaction area.
Action Syntax
.announcement "text".announcement $variable.announcement blkValid sizes
Examples
// Basic Usage
.announcement "message"// Using Variables
// Display dynamic content from variables
.announcement $message.app-frame
The .app-frame action shows an app frame. It belongs to the appdev category within the platform area.
Action Syntax
.app-frame $variableValid sizes
Examples
// Basic Usage
.app-frame $bin.app-icon
The .app-icon action displays an app icon. must have dev-mode enabled!. It belongs to the app category within the platform area.
Action Syntax
.app-icon @referenceValid sizes
Modifiers
link
The .app-icon action supports the link modifier.
Examples
// Basic Usage
.app-icon @apptag.app-iphone
The .app-iphone action shows an app in a simulated iphone. It belongs to the appdev category within the platform area.
Action Syntax
.app-iphone $variableValid sizes
Tags
scale
scale factor. default is 0.5
apppad
a padding factor to make it size properly
Examples
// Basic Usage
.app-iphone $bin.app-laptop
The .app-laptop action shows an app in a simulated laptop. It belongs to the appdev category within the platform area.
Action Syntax
.app-laptop $variableValid sizes
Tags
scale
scale factor. default is 0.5
apppad
a padding factor to make it size properly
Examples
// Basic Usage
.app-laptop $bin.app-navbar
The .app-navbar action standard bottom app nav bar. It belongs to the navbars category within the ui area.
Action Syntax
.app-navbar !set:icon "text" [file].app-navbar !set:icon [file].app-navbar "text" [file]Valid sizes
Examples
// Basic Usage
.app-navbar !icon "label" [block].app-tablet
The .app-tablet action shows an app in a simulated ipad/tablet. It belongs to the appdev category within the platform area.
Action Syntax
.app-tablet $variableValid sizes
Tags
scale
scale factor. default is 0.4
apppad
a padding factor to make it size properly
Examples
// Basic Usage
.app-tablet $bin.aside
The .aside action a stand alone block of text with additional explanation. It belongs to the text category within the ui area.
Action Syntax
.aside "text".aside $variable.aside blkValid sizes
Examples
// Basic Usage
.aside "text"// Using Variables
// Display dynamic content from variables
.aside $text.avatar
The .avatar action avatar. It belongs to the avatar category within the ui area.
Action Syntax
.avatar +imagetag.avatar !set:icon.avatar "text".avatar @referenceValid sizes
Modifiers
click
The .avatar action supports the click modifier.
Tags
circle
a circular avatar
square
a square avatar
Examples
// Basic Usage
.avatar %imagetag.back
The .back action a back navigation button. It belongs to the navigation category within the interaction area.
Action Syntax
.back [file].back !set:icon [file].back !set:icon "text" [file].back "text" [file]Valid sizes
Examples
// Basic Usage
.back [block].back-button
The .back-button action displays a back button for navigation. It belongs to the buttons category within the ui area.
Action Syntax
.back-button !set:icon.back-button "text".back-button !set:icon "text".back-button [file].back-button !set:icon [file].back-button "text" [file].back-button !set:icon "text" [file]Valid sizes
Examples
// Basic Usage
.back-button !icon.back-header
The .back-header action Header with back button for navigation. It belongs to the headers category within the layout area.
Action Syntax
.back-header "text".back-header $variable.back-header !set:icon "text".back-header !set:icon $variable.back-header +imagetag !set:icon "text".back-header +imagetag !set:icon $variableValid sizes
Examples
// Basic Usage
.back-header "title"// Using Variables
// Display dynamic content from variables
.back-header $title.background-animated-gradient
The .background-animated-gradient action an animated background gradient. It belongs to the background category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.background-animated-gradient.background-color
The .background-color action sets background color. It belongs to the background category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.background-color #ff0000.background-gradient
The .background-gradient action sets a background gradient. It belongs to the background category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
vertical
vertical gradient
radial
radial gradient
diagonal
diagonal gradient
Examples
// Basic Usage
.background-gradient #ff0000 #0000ff.background-image
The .background-image action display a background image for the app. It belongs to the background category within the ui area.
Action Syntax
.background-image +imagetag.background-image https://...Valid sizes
Examples
// Basic Usage
.background-image +mypic.background-video
The .background-video action shows MP4 video as background. It belongs to the background category within the ui area.
Action Syntax
.background-video +imagetagValid sizes
Examples
// Basic Usage
.background-video %videotag.banner-divider
The .banner-divider action displays an edge to edge colored bar with centered text that serves as a section content divider. It belongs to the divider category within the ui area.
Action Syntax
.banner-divider "text".banner-divider $variable.banner-divider !set:icon "text".banner-divider !set:icon $variableValid sizes
Examples
// Basic Usage
.banner-divider "text"// Using Variables
// Display dynamic content from variables
.banner-divider $text.bluesky
The .bluesky action shows a bluesky icon link. It belongs to the social category within the ui area.
Action Syntax
.bluesky "text".bluesky $variableValid sizes
Examples
// Basic Usage
.bluesky "socialid"// Using Variables
// Display dynamic content from variables
.bluesky $var.bottom-center
The .bottom-center action bottom center positions. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.bottom-center.bottom-left
The .bottom-left action bottom left position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.bottom-left.bottom-navbar
The .bottom-navbar action displays a standard buttom app bar. It belongs to the navbars category within the ui area.
Action Syntax
.bottom-navbar "text".bottom-navbar $variable.bottom-navbar "text" "text".bottom-navbar "text" "text" "text"Valid sizes
Modifiers
appendable
The .bottom-navbar action supports the appendable modifier.
.bottom-panel
The .bottom-panel action displays a bottom panel. It belongs to the overlays category within the layout area.
Action Syntax
.bottom-panel [file]Valid sizes
Examples
// Basic Usage
.bottom-panel [block].bottom-right
The .bottom-right action positions in bottom right. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.bottom-right.brand-screen
The .brand-screen action shows brand screen for trial/free plans. It belongs to the screens category within the ui area.
Action Syntax
.brand-screen $variableValid sizes
Tags
duration
duration to display. minimal/default is 1s
Examples
// Basic Usage
.brand-screen $text.btn
The .btn action Creates a clickable button that can trigger actions. It belongs to the html category within the ui area.
Action Syntax
.btn "text".btn $variableValid sizes
Examples
// Basic Usage
.btn "Click me"// Using Variables
// Display dynamic content from variables
.btn $button-text.busy-button
The .busy-button action a button with a busy indicator. It belongs to the buttons category within the ui area.
Action Syntax
.busy-button "text".busy-button !set:icon "text".busy-button "text" [file].busy-button !set:icon "text" [file]Valid sizes
Examples
// Basic Usage
.busy-button "label".button
The .button action Creates a clickable button that can trigger actions or navigate. It belongs to the buttons category within the ui area.
Action Syntax
.button "text".button "text" [file].button !set:icon "text".button !set:icon "text" [file].button $variable.button [file].button !set:icon [file]Valid sizes
Modifiers
click
The .button action supports the click modifier.
.button-bar
The .button-bar action Groups multiple buttons together in a horizontal bar layout. It belongs to the buttons category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.button-bar.chat-incoming
The .chat-incoming action incoming chat message. It belongs to the chat category within the platform area.
Action Syntax
.chat-incoming "text".chat-incoming $variableValid sizes
Examples
// Basic Usage
.chat-incoming "message"// Using Variables
// Display dynamic content from variables
.chat-incoming $var.chat-input
The .chat-input action chat message input at bottom of screen. It belongs to the chat category within the platform area.
Action Syntax
.chat-input "text"Valid sizes
Examples
// Basic Usage
.chat-input "placeholder".chat-outgoing
The .chat-outgoing action outgoing chat message. It belongs to the chat category within the platform area.
Action Syntax
.chat-outgoing "text".chat-outgoing $variableValid sizes
Examples
// Basic Usage
.chat-outgoing "message"// Using Variables
// Display dynamic content from variables
.chat-outgoing $var.chat-typing
The .chat-typing action display temporary in-progress/typing text chat message. It belongs to the chat category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.chat-typing.checkbox-field
The .checkbox-field action Creates a checkbox input with a clickable label. It belongs to the fields category within the ui area.
Action Syntax
.checkbox-field "text"Valid sizes
Examples
// Basic Usage
.checkbox-field "label".chip
The .chip action display a chip. It belongs to the components category within the ui area.
Action Syntax
.chip "text".chip $variable.chip !set:icon "text".chip !set:icon $variable.chip +imagetag "text".chip +imagetag $variableValid sizes
Tags
vertical
shows icon above the label
.circle-button
The .circle-button action a circular button. It belongs to the buttons category within the ui area.
Action Syntax
.circle-button "text".circle-button $variable.circle-button !set:icon.circle-button +imageValid sizes
Examples
// Basic Usage
.circle-button "Label"// Using Variables
// Display dynamic content from variables
.circle-button $labelvar.circle-image
The .circle-image action small circlular image. It belongs to the images category within the ui area.
Action Syntax
.circle-image +imagetag.circle-image +imagetag +imagetagExamples
// Basic Usage
.circle-image +imagetag.click
The .click action sets a click modifier. It belongs to the modifier category within the ui area.
Action Syntax
.click [file].click navto [file].click goto [file].click run [file]Valid sizes
Examples
// Basic Usage
.click [block].close-icon
The .close-icon action a standard close / “x” icon to close dialogs. It belongs to the navigation category within the interaction area.
Action Syntax
.close-icon EValid sizes
Examples
// Basic Usage
.close-icon *id.color-input
The .color-input action color input for a single line of text. It belongs to the input category within the interaction area.
Action Syntax
.color-input $variableValid sizes
Modifiers
placeholder
The .color-input action supports the placeholder modifier.
help
The .color-input action supports the help modifier.
Tags
disabled
make the disabled
Examples
// Basic Usage
.color-input $varname.color-palette
The .color-palette action …. It belongs to the color category within the ui area.
Action Syntax
.color-palette "text"Valid sizes
Examples
// Basic Usage
.color-palette "basecolor".color-swatch
The .color-swatch action displays one to three color swatches. It belongs to the color category within the ui area.
Action Syntax
.color-swatch "text"Valid sizes
Examples
// Basic Usage
.color-swatch "label".column
The .column action a column element: children will appear in a vertical column. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Modifiers
hover-over
The .column action supports the hover-over modifier.
click-on
The .column action supports the click-on modifier.
Examples
// Basic Usage
.column.confetti
The .confetti action shows confetti. It belongs to the specialfx category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
angle
launch angle. default is 90
shape
circle, square, or star
Examples
// Basic Usage
.confetti.continue-button
The .continue-button action a button that continues an app in wait state. It belongs to the buttons category within the ui area.
Action Syntax
.continue-button "text".continue-button $variableValid sizes
Examples
// Basic Usage
.continue-button "label"// Using Variables
// Display dynamic content from variables
.continue-button $label.copy-textbox
The .copy-textbox action display a text box with a copy icon that allows users to copy text to the system clipboard. It belongs to the components category within the ui area.
Action Syntax
.copy-textbox $variable.copy-textbox "text"Valid sizes
Tags
ui
clipboard
Examples
// Basic Usage
.copy-textbox $textRelated Actions
- `` -
- `` -
.copyright
The .copyright action displays a copyright phrase with the current year. It belongs to the components category within the ui area.
Action Syntax
.copyright $variable.copyright "text"Valid sizes
Examples
// Basic Usage
.copyright $text.corner-banner
The .corner-banner action a fixed corner diagonal banner in the upper right of the app screen. It belongs to the specialfx category within the ui area.
Action Syntax
.corner-banner "text".corner-banner $variableValid sizes
Examples
// Basic Usage
.corner-banner "label"// Using Variables
// Display dynamic content from variables
.corner-banner $label.date-input
The .date-input action date input for a single line of text. It belongs to the input category within the interaction area.
Action Syntax
.date-input $variableValid sizes
Modifiers
placeholder
The .date-input action supports the placeholder modifier.
help
The .date-input action supports the help modifier.
Tags
disabled
make the input disabled
Examples
// Basic Usage
.date-input $varname.details
The .details action Creates an expandable details section with collapsible content. It belongs to the html category within the ui area.
Action Syntax
.details "text" "text".details $variable "text".details "text" $variable.details $variable $variableValid sizes
Examples
// Basic Usage
.details "title" "details"// Using Variables
// Display dynamic content from variables
.details $title-var "details".devfooter
The .devfooter action Shows development mode footer with user and target info. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.devfooter.dialog
The .dialog action Creates a modal dialog popup for user interaction. It belongs to the html category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
max
maximizes dialog to full screen
left
positions dialog on the left side
right
positions dialog on the right side
active
sets dialog as open immediately
Examples
// Basic Usage
.dialog.dicebear-avatar
The .dicebear-avatar action a variety of avatar sets fron Dicebear. It belongs to the avatars category within the ui area.
Action Syntax
.dicebear-avatar "text".dicebear-avatar @reference.dicebear-avatar $variableValid sizes
Tags
set
dicebear set name
circle
a circular avatar
square
a square avatar
Examples
// Basic Usage
.dicebear-avatar "label"// Using Variables
// Display dynamic content from variables
.dicebear-avatar $text.div
The .div action Creates a flexible container for organizing content. It belongs to the html category within the ui area.
Action Syntax
.div "text"Valid sizes
Modifiers
overlay
The .div action supports the overlay modifier.
Examples
// Basic Usage
.div "Some Text".divider
The .divider action basic horizontal divider. It belongs to the divider category within the ui area.
Action Syntax
.divider "text"Valid sizes
Examples
// Basic Usage
.divider "label".divider-bar
The .divider-bar action displays an edge to edge colored bar with centered text that serves as a section content divider. It belongs to the divider category within the ui area.
Action Syntax
.divider-bar "text".divider-bar $variable.divider-bar !set:icon "text".divider-bar !set:icon $variable.divider-bar +imagetag.divider-bar +imagetag "text".divider-bar +imagetag $variableValid sizes
Styles
.left
align text to left
.edit-app
The .edit-app action floating action button to edit app. It belongs to the appdev category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.edit-app.editor
The .editor action simple overlay text editor. It belongs to the editors category within the appdev area.
Action Syntax
.editor $variable.editor "text" $variableValid sizes
Modifiers
+when-close
The .editor action supports the +when-close modifier.
Examples
// Basic Usage
.editor $var.enter
The .enter action sets a enter key modifier for an input field. It belongs to the modifier category within the ui area.
Action Syntax
.enter continue.enter [file].enter navto [file].enter goto [file].enter run [file]Valid sizes
Examples
// Basic Usage
.enter continue.enter-date
The .enter-date action enter date field. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-date $variable.enter-date "text".enter-date "text" $variable.enter-date !set:icon.enter-date !set:icon $variable.enter-date !set:icon "text".enter-date !set:icon "text" $variableReturn Value
This function returns a
.enter-email
The .enter-email action enter email field. It belongs to the enter category within the interaction area.
Action Syntax
.enter-email $variable.enter-email "text".enter-email "text" $variable.enter-email !set:icon.enter-email !set:icon $variable.enter-email !set:icon "text".enter-email !set:icon "text" $variableReturn Value
This function returns a
.enter-family-name
The .enter-family-name action enter family-name field. It belongs to the enter category within the interaction area.
Action Syntax
.enter-family-name $variable.enter-family-name "text".enter-family-name "text" $variable.enter-family-name !set:icon.enter-family-name !set:icon $variable.enter-family-name !set:icon "text".enter-family-name !set:icon "text" $variableReturn Value
This function returns a
.enter-fullname
The .enter-fullname action enter fullname field. It belongs to the enter category within the interaction area.
Action Syntax
.enter-fullname $variable.enter-fullname "text".enter-fullname "text" $variable.enter-fullname !set:icon.enter-fullname !set:icon $variable.enter-fullname !set:icon "text".enter-fullname !set:icon "text" $variableReturn Value
This function returns a
.enter-given-name
The .enter-given-name action enter given-name field. It belongs to the enter category within the interaction area.
Action Syntax
.enter-given-name $variable.enter-given-name "text".enter-given-name "text" $variable.enter-given-name !set:icon.enter-given-name !set:icon $variable.enter-given-name !set:icon "text".enter-given-name !set:icon "text" $variableReturn Value
This function returns a
.enter-helptext
The .enter-helptext action adds help text below an .enter-xxxx element. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-helptext "text"Valid sizes
Examples
// Basic Usage
.enter-helptext "helptext".enter-number
The .enter-number action enter number field. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-number $variable.enter-number "text".enter-number "text" $variable.enter-number !set:icon.enter-number !set:icon $variable.enter-number !set:icon "text".enter-number !set:icon "text" $variableReturn Value
This function returns a
.enter-password
The .enter-password action enter password field. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-password $variable.enter-password "text".enter-password "text" $variable.enter-password !set:icon.enter-password !set:icon $variable.enter-password !set:icon "text".enter-password !set:icon "text" $variableReturn Value
This function returns a
.enter-phone
The .enter-phone action enter phone field. It belongs to the enter category within the interaction area.
Action Syntax
.enter-phone $variable.enter-phone "text".enter-phone "text" $variable.enter-phone !set:icon.enter-phone !set:icon $variable.enter-phone !set:icon "text".enter-phone !set:icon "text" $variableReturn Value
This function returns a
.enter-text
The .enter-text action text input for a single line of text. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-text $variable.enter-text "text".enter-text "text" $variable.enter-text !set:icon.enter-text !set:icon $variable.enter-text !set:icon "text".enter-text !set:icon "text" $variableReturn Value
This function returns a
.enter-time
The .enter-time action enter time field. It belongs to the inputs category within the interaction area.
Action Syntax
.enter-time $variable.enter-time "text".enter-time "text" $variable.enter-time !set:icon.enter-time !set:icon $variable.enter-time !set:icon "text".enter-time !set:icon "text" $variableReturn Value
This function returns a
.enterkey-effect
The .enterkey-effect action enter key event/effect. It belongs to the effects category within the ui area.
Action Syntax
.enterkey-effect [file].enterkey-effect goto [file].enterkey-effect run [file]Valid sizes
Examples
// Basic Usage
.enterkey-effect [blockname].error-line
The .error-line action displays an error on the app screen. It belongs to the error category within the system area.
Action Syntax
.error-line "text".error-line !set:icon "text"Examples
// Basic Usage
.error-line "the network request timed out"The .facebook action shows a facebook icon link. It belongs to the social category within the ui area.
Action Syntax
.facebook "text".facebook $variableValid sizes
Examples
// Basic Usage
.facebook "facebookid"// Using Variables
// Display dynamic content from variables
.facebook $var.filler
The .filler action fills available space in a row. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.filler.fineprint
The .fineprint action displays teeny-tiny text!. It belongs to the text category within the ui area.
Action Syntax
.fineprint "text".fineprint $variableValid sizes
Examples
// Basic Usage
.fineprint "hello world"// Using Variables
// Display dynamic content from variables
.fineprint $eventname.fixed-footer
The .fixed-footer action Creates a footer that stays visible during page changes. It belongs to the footers category within the layout area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.fixed-footer.font-sample
The .font-sample action Shows a preview of what text looks like in a font. It belongs to the fonts category within the ui area.
Action Syntax
.font-sample %fontValid sizes
Examples
// Basic Usage
.font-sample ^font-tag.footer
The .footer action Creates a footer at the bottom of your app. It belongs to the footers category within the layout area.
Action Syntax
.footer "text".footer $variableValid sizes
Examples
// Basic Usage
.footer "Footer"// Using Variables
// Display dynamic content from variables
.footer $title.footer-nav
The .footer-nav action Adds clickable navigation items to your footer. It belongs to the footers category within the layout area.
Action Syntax
.footer-nav !set:icon [file].footer-nav +imagetag [file].footer-nav "text" [file].footer-nav [file].footer-nav !set:icon "text" [file].footer-nav +imagetag "text" [file]Valid sizes
Examples
// Basic Usage
.footer-nav !icon [block].full-panel
The .full-panel action displays a full screen panel. It belongs to the overlays category within the layout area.
Action Syntax
.full-panel [file]Valid sizes
Examples
// Basic Usage
.full-panel [block].fullscreen-error
The .fullscreen-error action a full screen error component. It belongs to the error category within the system area.
Action Syntax
.fullscreen-error "text".fullscreen-error !set:icon "text"Tags
continue
continue with app after acknowledgement (default)
reload
reload/restart the app after acknowledgement
goto
block name to goto after acknowledgement
Examples
// Basic Usage
.fullscreen-error "This-is-an-error".github
The .github action shows a github icon link. It belongs to the social category within the ui area.
Action Syntax
.github "text".github $variableValid sizes
Examples
// Basic Usage
.github "socialid"// Using Variables
// Display dynamic content from variables
.github $var.golden-image
The .golden-image action an image with golden ratio aspect (1.618:1!). It belongs to the images category within the ui area.
Action Syntax
.golden-image +imagetag.golden-image $variable.golden-image https://...Valid sizes
Examples
// Basic Usage
.golden-image %imagetag// Using Variables
// Display dynamic content from variables
.golden-image $imagetag.goleft-effect
The .goleft-effect action page left animated goto. It belongs to the navigation category within the interaction area.
Action Syntax
.goleft-effect [file]Examples
// Basic Usage
.goleft-effect [block].goto
The .goto action sets a goto modifier. It belongs to the modifier category within the ui area.
Action Syntax
.goto [file]Valid sizes
Examples
// Basic Usage
.goto [block].goto-effect
The .goto-effect action goto effect. It belongs to the navigation category within the interaction area.
Action Syntax
.goto-effect [file]Examples
// Basic Usage
.goto-effect [blockname].gradient
The .gradient action adds a gradient effect to an element. It belongs to the modifier category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.gradient.grid
The .grid action .grid layout. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.grid.grid-cell
The .grid-cell action grid cell (must be defined after grid). It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.grid-cell.handwriting
The .handwriting action simulates hand or script written text (cursive). It belongs to the text category within the ui area.
Action Syntax
.handwriting "text".handwriting $variableValid sizes
Examples
// Basic Usage
.handwriting "text"// Using Variables
// Display dynamic content from variables
.handwriting $text.header
The .header action Creates a header bar at the top of your app. It belongs to the headers category within the layout area.
Action Syntax
.header "text".header !set:icon "text"Valid sizes
Modifiers
link
The .header action supports the link modifier.
Examples
// Basic Usage
.header "Awesome".help
The .help action sets a help text modifier for an element. It belongs to the modifier category within the ui area.
Action Syntax
.help "text".help $variableValid sizes
Examples
// Basic Usage
.help "help"// Using Variables
// Display dynamic content from variables
.help $text.hide
The .hide action hides the element after a previous modifier action. It belongs to the modifier category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.hide.hide-in-progress
The .hide-in-progress action hides the .show-in-progess element. It belongs to the progress category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.hide-in-progress.hover-over
The .hover-over action sets a hover over modifier. It belongs to the modifier category within the ui area.
Action Syntax
.hover-over change-color.hover-over goto [file].hover-over run [file]Valid sizes
Examples
// Basic Usage
.hover-over change-color.hr
The .hr action Creates a horizontal line to separate content sections. It belongs to the html category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.hr.icon
The .icon action a basic icon. It belongs to the icons category within the ui area.
Action Syntax
.icon !set:icon.icon $variableValid sizes
Modifiers
navigate
The .icon action supports the navigate modifier.
Examples
// Basic Usage
.icon !icon// Using Variables
// Display dynamic content from variables
.icon $icontag.icon-avatar
The .icon-avatar action a small avatar with icon. It belongs to the avatars category within the ui area.
Action Syntax
.icon-avatar !set:icon.icon-avatar $variableValid sizes
Tags
circle
a circular avatar
square
a square avatar
rounded
a rounded square
Examples
// Basic Usage
.icon-avatar !icontag// Using Variables
// Display dynamic content from variables
.icon-avatar $icontag.icon-button
The .icon-button action this is an icon button. It belongs to the buttons category within the ui area.
Action Syntax
.icon-button !set:icon.icon-button !set:icon [file]Valid sizes
Examples
// Basic Usage
.icon-button !home.icon-with-label
The .icon-with-label action an icon with a label to the left or below it. It belongs to the icons category within the ui area.
Action Syntax
.icon-with-label !set:icon "text".icon-with-label !set:icon $variableValid sizes
Examples
// Basic Usage
.icon-with-label !icontag "label"// Using Variables
// Display dynamic content from variables
.icon-with-label !icontag $label.iframe
The .iframe action Embeds external web pages or content into your app. It belongs to the html category within the ui area.
Action Syntax
.iframe https://....iframe $variableValid sizes
Tags
noscroll
hides scroll bars for fixed content display
Examples
// Basic Usage
.iframe https://example.com// Using Variables
// Display dynamic content from variables
.iframe $page-url.image
The .image action base image with its original aspect ratio. It belongs to the images category within the ui area.
Action Syntax
.image +imagetag.image $variable.image https://...Valid sizes
Examples
// Basic Usage
.image %imagetag// Using Variables
// Display dynamic content from variables
.image $imagetag.image-avatar
The .image-avatar action avatar with an app image. It belongs to the avatars category within the ui area.
Action Syntax
.image-avatar +imagetag.image-avatar $variable.image-avatar https://...Valid sizes
Tags
circle
a circular avatar
square
a square avatar
Examples
// Basic Usage
.image-avatar %imagetag// Using Variables
// Display dynamic content from variables
.image-avatar $imagetag.image-button
The .image-button action an image button. It belongs to the images category within the ui area.
Action Syntax
.image-button +imagetag.image-button +imagetag "text".image-button +imagetag [file].image-button +imagetag "text" [file]Valid sizes
Tags
rounded
a rounded button (default)
.image-header
The .image-header action Header with background image and overlay text. It belongs to the headers category within the layout area.
Action Syntax
.image-header +imagetag "text".image-header +imagetag $variable.image-header +imagetag !set:icon "text".image-header +imagetag !set:icon $variable.image-header +imagetag "text" [file].image-header +imagetag $variable [file].image-header +imagetag !set:icon "text" [file].image-header +imagetag !set:icon $variable [file]Valid sizes
Styles
.back
inserts a back nav icon element on left
.image-title
The .image-title action displays title text on top of an image. It belongs to the images category within the ui area.
Action Syntax
.image-title "text".image-title $variableValid sizes
Examples
// Basic Usage
.image-title "imagetitle"// Using Variables
// Display dynamic content from variables
.image-title $imagetitle.inbox-message
The .inbox-message action a single inbox message. It belongs to the inbox category within the external area.
Action Syntax
.inbox-message $variableValid sizes
Examples
// Basic Usage
.inbox-message $Iitem.inbox-message-input
The .inbox-message-input action full inbox message input with from subject and body. It belongs to the inbox category within the external area.
Action Syntax
.inbox-message-input $variableValid sizes
Examples
// Basic Usage
.inbox-message-input $var.initials-avatar
The .initials-avatar action a small avatar with initials / letters. It belongs to the avatars category within the ui area.
Action Syntax
.initials-avatar "text".initials-avatar $variable.initials-avatar @referenceValid sizes
Tags
circle
a circular avatar
square
a square avatar
Examples
// Basic Usage
.initials-avatar "Text"// Using Variables
// Display dynamic content from variables
.initials-avatar $initials.input
The .input action Creates a text input field for user data entry. It belongs to the html category within the ui area.
Action Syntax
.input $variableValid sizes
Modifiers
enter
The .input action supports the enter modifier.
hide
The .input action supports the hide modifier.
wait
The .input action supports the wait modifier.
Tags
autofocus
automatically focuses cursor on this input
The .instagram action shows an instagram icon link. It belongs to the social category within the ui area.
Action Syntax
.instagram "text".instagram $variableValid sizes
Examples
// Basic Usage
.instagram "socialid"// Using Variables
// Display dynamic content from variables
.instagram $var.left-panel
The .left-panel action displays a left panel. It belongs to the overlays category within the layout area.
Action Syntax
.left-panel [file]Valid sizes
Examples
// Basic Usage
.left-panel [block].link
The .link action sets a link modifier. It belongs to the modifier category within the ui area.
Action Syntax
.link https://....link @referenceValid sizes
Examples
// Basic Usage
.link https://someurlThe .linkedin action shows a linkedin icon link. It belongs to the social category within the ui area.
Action Syntax
.linkedin "text".linkedin $variableValid sizes
Examples
// Basic Usage
.linkedin "socialid"// Using Variables
// Display dynamic content from variables
.linkedin $var.list
The .list action list. It belongs to the lists category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.list.list-item
The .list-item action list item. It belongs to the lists category within the ui area.
Action Syntax
.list-item "text"Valid sizes
Examples
// Basic Usage
.list-item "fffff".live-search
The .live-search action live search (on each character). It belongs to the search category within the ui area.
Action Syntax
.live-search $variable [file].live-search $variable "text" [file]Valid sizes
Examples
// Basic Usage
.live-search $var [block].lottie
The .lottie action embeds a lottie animation. It belongs to the animation category within the ui area.
Action Syntax
.lottie +imagetag.lottie https://...Valid sizes
Tags
loop
loops animation
controls
shows animation controls
Examples
// Basic Usage
.lottie %animtag.megaicon
The .megaicon action an oversized very large icon. It belongs to the icons category within the ui area.
Action Syntax
.megaicon !set:icon.megaicon $variableValid sizes
Examples
// Basic Usage
.megaicon !icon// Using Variables
// Display dynamic content from variables
.megaicon $icontag.menu
The .menu action creates a menu anchor position. It belongs to the menus category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
active
opens immediatley
Examples
// Basic Usage
.menu.menu-item
The .menu-item action a menu item. It belongs to the menus category within the ui area.
Action Syntax
.menu-item "text" [file].menu-item $variable [file].menu-item !set:icon "text" [file].menu-item !set:icon $variable [file].menu-item +imagetag "text" [file].menu-item +imagetag $variable [file]Valid sizes
Examples
// Basic Usage
.menu-item "Label" [block]// Using Variables
// Display dynamic content from variables
.menu-item $var [block].middle-center
The .middle-center action middle center position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.middle-center.middle-left
The .middle-left action middle left position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.middle-left.middle-right
The .middle-right action middle right position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.middle-right.mobile-app-view
The .mobile-app-view action mobile app view with simple header and footer nav. It belongs to the view category within the ui area.
Action Syntax
.mobile-app-view "text".mobile-app-view $variableValid sizes
Examples
// Basic Usage
.mobile-app-view "My App"// Using Variables
// Display dynamic content from variables
.mobile-app-view $apptitle.navigation-bar
The .navigation-bar action a navigation bar with text and a chevron on the right. Used to drill down into more detailed info. It belongs to the navigation category within the interaction area.
Action Syntax
.navigation-bar "text" [file].navigation-bar $variable [file].navigation-bar !set:icon "text" [file].navigation-bar !set:icon $variable [file].navigation-bar +imagetag "text" [file].navigation-bar +imagetag $variable [file]Valid sizes
Examples
// Basic Usage
.navigation-bar "text" [block]// Using Variables
// Display dynamic content from variables
.navigation-bar $text [block].navto
The .navto action sets a navto modifier. It belongs to the modifier category within the ui area.
Action Syntax
.navto [file]Valid sizes
Examples
// Basic Usage
.navto [block].number
The .number action display a number. It belongs to the numbers category within the ui area.
Action Syntax
.number 123.number $variableValid sizes
Tags
percentage
shows number as a percentage
Examples
// Basic Usage
.number 10// Using Variables
// Display dynamic content from variables
.number $number.option
The .option action Creates dropdown menu choices for .selectio selection actions. It belongs to the selects category within the interaction area.
Action Syntax
.option "text".option 123.option true|false.option $variableValid sizes
Tags
value
sets specific value different from display text
Examples
// Basic Usage
.option "Option Text"// Using Variables
// Display dynamic content from variables
.option $value.overlay
The .overlay action overlays text or other element on top of another (usually an image). It belongs to the modifier category within the ui area.
Action Syntax
.overlay "text".overlay $variableValid sizes
Examples
// Basic Usage
.overlay "text"// Using Variables
// Display dynamic content from variables
.overlay $varname.paragraph
The .paragraph action a paragraph text container. It belongs to the paragraph category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.paragraph.paragraph-text
The .paragraph-text action inline paragraph text or value. It belongs to the paragraph category within the ui area.
Action Syntax
.paragraph-text $variable.paragraph-text "text".paragraph-text "text" [file].paragraph-text "text" https://...Valid sizes
Examples
// Basic Usage
.paragraph-text $var.password-field
The .password-field action Creates a password input field with hidden text. It belongs to the fields category within the ui area.
Action Syntax
.password-field "text"Valid sizes
Examples
// Basic Usage
.password-field "label".password-panel
The .password-panel action displays a full screen password input panel. It belongs to the auth category within the external area.
Action Syntax
.password-panel !set:icon.password-panel +imagetagValid sizes
Examples
// Basic Usage
.password-panel !icon.paste-background
The .paste-background action full screen input to capture a pasted background image. It belongs to the clipboard category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = .paste-background Valid sizes
Examples
// Basic Usage
.paste-background.pinpad-input
The .pinpad-input action display a numeric pinpad input suitable for mobile. It belongs to the auth category within the external area.
Action Syntax
.pinpad-input $variableValid sizes
Tags
numdigits
the number of digits in the pin
Examples
// Basic Usage
.pinpad-input $pin.placeholder
The .placeholder action sets a placeholder for an input element. It belongs to the decorator category within the ui area.
Action Syntax
.placeholder "text".placeholder $variableValid sizes
Examples
// Basic Usage
.placeholder "placeholder"// Using Variables
// Display dynamic content from variables
.placeholder $text.popup
The .popup action a centered pop up/modal layout container. It belongs to the layout category within the ui area.
Action Syntax
.popup "text".popup [file]Valid sizes
Tags
closebutton
shows a close button in top right
Examples
// Basic Usage
.popup "message".popup-screen
The .popup-screen action full screen to hold other elements and can be closed. It belongs to the screens category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.popup-screen.profile
The .profile action a default display of a user profile. It belongs to the profile category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.profile.progress-bar
The .progress-bar action Display a horizontal progress bar with customizable appearance. It belongs to the progress category within the ui area.
Action Syntax
.progress-bar 123 of 123.progress-bar $variable of $variable.progress-bar $variable of 123.progress-bar 123 of $variableValid sizes
Tags
label="text"
sets a custom label for the progress bar
.progress-circle
The .progress-circle action …. It belongs to the progress category within the ui area.
Action Syntax
.progress-circle 123 of 123.progress-circle $variable of $variable.progress-circle $variable of 123.progress-circle 123 of $variableValid sizes
Tags
showvalue
shows the value inside the circle
.progress-circle-with-value
The .progress-circle-with-value action shows a progress circle with percent complete value in center. It belongs to the progress category within the ui area.
Action Syntax
.progress-circle-with-value 123 of 123.progress-circle-with-value $variable of $variable.progress-circle-with-value $variable of 123.progress-circle-with-value 123 of $variableValid sizes
Examples
// Basic Usage
.progress-circle-with-value 1 of 100// Using Variables
// Display dynamic content from variables
.progress-circle-with-value $num of $max.qrcode
The .qrcode action displays a scannable QR code from text or URL. It belongs to the barcodes category within the ui area.
Action Syntax
.qrcode https://....qrcode "text".qrcode $variableValid sizes
Tags
invert
swaps black and white colors in the QR code
Examples
// Basic Usage
.qrcode https://dqwdqwdqwdqwd// Using Variables
// Display dynamic content from variables
.qrcode $value.radio-field
The .radio-field action Creates a radio button input with selectable options. It belongs to the fields category within the ui area.
Action Syntax
.radio-field "text"Valid sizes
Examples
// Basic Usage
.radio-field "label".rhappsody
The .rhappsody action shows rhappsody logo. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.rhappsody.rhyme-editor
The .rhyme-editor action a full featured rhyme editor. It belongs to the editor category within the platform area.
Action Syntax
.rhyme-editor "text".rhyme-editor $variableValid sizes
Examples
// Basic Usage
.rhyme-editor "source"// Using Variables
// Display dynamic content from variables
.rhyme-editor $source.rhyme-example
The .rhyme-example action an example rhyme snippet with output. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-example blkValid sizes
Examples
// Basic Usage
.rhyme-example `source`.rhyme-live
The .rhyme-live action a live rhyme scratch pad with output. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-live blk.rhyme-live "text" blkValid sizes
Tags
height
output height in pixels. default is 100
Examples
// Basic Usage
.rhyme-live `source`.rhyme-source
The .rhyme-source action displays a formatted block of rhyme code. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-source $variableValid sizes
Examples
// Basic Usage
.rhyme-source $var.right-panel
The .right-panel action displays a right panel. It belongs to the overlays category within the layout area.
Action Syntax
.right-panel [file]Valid sizes
Examples
// Basic Usage
.right-panel [block].row
The .row action a row element: children will appear underneath. It belongs to the rows category within the layout area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Styles
.wrapped
wraps row
.row.wrapped "example text".scroll
make row a scroller
.row.scroll "example text"Modifiers
augmentable
The .row action supports the augmentable modifier.
Examples
// Basic Usage
.row// With Styles
// Apply the .wrapped style modifier
.row.wrapped "example text".run
The .run action sets a run modifier. It belongs to the modifier category within the ui area.
Action Syntax
.run [file]Valid sizes
Examples
// Basic Usage
.run [block].screen
The .screen action bas screen element. It belongs to the screens category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.screen.screen-background
The .screen-background action sets the main screen background for the app. It belongs to the screens category within the ui area.
Action Syntax
.screen-background +imagetagValid sizes
Examples
// Basic Usage
.screen-background %mypic.search
The .search action a search line input box. It belongs to the search category within the ui area.
Action Syntax
.search $variable [file].search $variable "text" [file]Valid sizes
Examples
// Basic Usage
.search $var [searchaction].select
The .select action Creates a dropdown selection menu for choosing options. It belongs to the selects category within the interaction area.
Action Syntax
.select "text".select from $variable.select "text" from $variableValid sizes
Tags
value
specifies initial value variable / value
.select-field
The .select-field action Creates a dropdown selection field with multiple options. It belongs to the fields category within the ui area.
Action Syntax
.select-field "text"Valid sizes
Examples
// Basic Usage
.select-field "label".set
The .set action sets a +set modifier. It belongs to the modifier category within the ui area.
Action Syntax
.set $variable = "text".set $variable = 123.set $variable = true|false.set $variable = HH:MM.set $variable = YYYY-MM-DD.set $variable = ITValid sizes
Examples
// Basic Usage
.set $var = "value".shape-divider
The .shape-divider action shape divider. It belongs to the divider category within the ui area.
Action Syntax
.shape-divider 123Valid sizes
Examples
// Basic Usage
.shape-divider 11.show-in-progress
The .show-in-progress action shows full screen in progress overlay spinner with an optional message. It belongs to the progress category within the ui area.
Action Syntax
.show-in-progress $variable.show-in-progress "text"Valid sizes
Examples
// Basic Usage
.show-in-progress $text.signature
The .signature action text that mimics a handwritten signature. It belongs to the text category within the ui area.
Action Syntax
.signature "text".signature $variableValid sizes
Examples
// Basic Usage
.signature "name"// Using Variables
// Display dynamic content from variables
.signature $name.signature-pad
The .signature-pad action an input pad that mimics capturing a signature. It belongs to the input category within the interaction area.
Action Syntax
.signature-pad "text"Return Value
This function returns a
$result = .signature-pad Valid sizes
Examples
// Basic Usage
$text = .signature-pad "placeholder".sim-app
The .sim-app action floating action button to similate app. It belongs to the appdev category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.sim-app.simulate
The .simulate action full panel app simulator. It belongs to the sim category within the appdev area.
Action Syntax
.simulate $variable.simulate "text" $variableValid sizes
Examples
// Basic Usage
.simulate $binvar.simulator
The .simulator action runs RHC binary in simulator. It belongs to the sim category within the appdev area.
Action Syntax
.simulator $variableValid sizes
Examples
// Basic Usage
.simulator $binary.slider-input
The .slider-input action a slider input field. It belongs to the input category within the interaction area.
Action Syntax
.slider-input $variable.slider-input $variable from 123 to 123.slider-input $variable from $variable to $variableValid sizes
Examples
// Basic Usage
.slider-input $var.spacer
The .spacer action defines a spacer. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
visible
makes the spacer border and size visible (usefule during app development)
Examples
// Basic Usage
.spacer.span
The .span action Creates inline text elements for styling and formatting. It belongs to the html category within the ui area.
Action Syntax
.span "text".span $variableValid sizes
Examples
// Basic Usage
.span "text label"// Using Variables
// Display dynamic content from variables
.span $text-variable.spinner
The .spinner action shows a spinner icon. It belongs to the icons category within the ui area.
Action Syntax
.spinner !set:icon.spinner true|falseValid sizes
Tags
(duration)
controls the spin duration. larger is slower. default is -2s
Examples
// Basic Usage
.spinner !icon.splash-screen
The .splash-screen action shows a default splash screen. It belongs to the screens category within the ui area.
Action Syntax
.splash-screen +imagetag.splash-screen $variable.splash-screen +imagetag $variableValid sizes
Examples
// Basic Usage
.splash-screen %image// Using Variables
// Display dynamic content from variables
.splash-screen $text.stack
The .stack action a general stack element to add vertical children to. It belongs to the stacks category within the layout area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Styles
.rounded
makes the stack rounded
.stack.rounded "example text"Examples
// Basic Usage
.stack// With Styles
// Apply the .rounded style modifier
.stack.rounded "example text".tagline
The .tagline action a huge large tagline. Keep it under 10 words. Shorter is better. It belongs to the text category within the ui area.
Action Syntax
.tagline "text".tagline $variableValid sizes
Examples
// Basic Usage
.tagline "this is a title"// Using Variables
// Display dynamic content from variables
.tagline $title.text
The .text action displays text in the UI. It belongs to the text category within the ui area.
Action Syntax
.text "text".text $variableValid sizes
Styles
.tight
minimal line spacing
.text.tight "example text"Modifiers
goto
The .text action supports the goto modifier.
Examples
// Basic Usage
.text "hello world"// Using Variables
// Display dynamic content from variables
.text $eventname// With Styles
// Apply the .tight style modifier
.text.tight "example text"Additional Notes
.text action is the most fundamental way to display content in Rhappsody apps. It’s lightweight and performant, making it ideal for:
.text-field
The .text-field action Creates a single-line text input field. It belongs to the fields category within the ui area.
Action Syntax
.text-field "text"Valid sizes
Examples
// Basic Usage
.text-field "label".textarea
The .textarea action Creates a multi-line text input area for longer text. It belongs to the html category within the ui area.
Action Syntax
.textarea $variableValid sizes
Tags
disabled
disables text input making it non-interactive
rows
sets number of visible text rows
cols
sets number of visible character columns
readonly
prevents user editing but allows text selection
placeholder
shows hint text when empty
.textbox-field
The .textbox-field action Creates a multi-line text input area for longer content. It belongs to the fields category within the ui area.
Action Syntax
.textbox-field "text"Valid sizes
Examples
// Basic Usage
.textbox-field "label".textbox-input
The .textbox-input action textbox input for larger amounts of text. It belongs to the input category within the interaction area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = .textbox-input Valid sizes
Modifiers
placeholder
The .textbox-input action supports the placeholder modifier.
help
The .textbox-input action supports the help modifier.
.time-input
The .time-input action time input for a single line of text. It belongs to the input category within the interaction area.
Action Syntax
.time-input $variableValid sizes
Modifiers
placeholder
The .time-input action supports the placeholder modifier.
help
The .time-input action supports the help modifier.
Tags
disabled
make the input disabled
Examples
// Basic Usage
.time-input $varname.tint
The .tint action tints an image with the specified color. It belongs to the modifier category within the ui area.
Action Syntax
.tint 123Valid sizes
Examples
// Basic Usage
.tint 50.tiptext
The .tiptext action sets tooltip text modifier for an element. It belongs to the modifier category within the ui area.
Action Syntax
.tiptext "text".tiptext $variableValid sizes
Examples
// Basic Usage
.tiptext "tip"// Using Variables
// Display dynamic content from variables
.tiptext $text.title
The .title action a text title. It belongs to the text category within the ui area.
Action Syntax
.title "text".title $variableValid sizes
Examples
// Basic Usage
.title "this is a title"// Using Variables
// Display dynamic content from variables
.title $title.top-appbar
The .top-appbar action displays a standard top app bar. It belongs to the navbars category within the ui area.
Action Syntax
.top-appbar "text".top-appbar $variable.top-appbar !set:icon "text".top-appbar !set:icon $variable.top-appbar +imagetag "text".top-appbar +imagetag $variable.top-appbar +imagetag "text" !set:icon.top-appbar +imagetag $variable !set:iconValid sizes
Modifiers
goto
The .top-appbar action supports the goto modifier.
.top-center
The .top-center action top center position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.top-center.top-left
The .top-left action .stack positioned in top left. It belongs to the stacks category within the layout area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.top-left.top-panel
The .top-panel action displays a top panel. It belongs to the overlays category within the layout area.
Action Syntax
.top-panel [file]Valid sizes
Examples
// Basic Usage
.top-panel [block].top-right
The .top-right action top right position. It belongs to the layout category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.top-right.turnstile
The .turnstile action renders Cloudflare CATCHPA solution widget. It belongs to the security category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
light
renders widget in light mode (default)
dark
renders widget in dark mode
Examples
// Basic Usage
.turnstileThe .twitter action shows a twitter/X icon link. It belongs to the social category within the ui area.
Action Syntax
.twitter "text".twitter $variableValid sizes
Examples
// Basic Usage
.twitter "socialid"// Using Variables
// Display dynamic content from variables
.twitter $var.upload-csv
The .upload-csv action Creates a button to let users upload CSV files from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-csv +imagetagReturn Value
This function returns a
$result = .upload-csv Valid sizes
Examples
// Basic Usage
$response = .upload-csv %icontag.upload-file
The .upload-file action Creates a button to let users upload any file from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-file +imagetagReturn Value
This function returns a
$result = .upload-file Valid sizes
Examples
// Basic Usage
$response = .upload-file %icontag.upload-file-input
The .upload-file-input action Creates a labeled file upload button with icon and text. It belongs to the file category within the system area.
Action Syntax
.upload-file-input "text".upload-file-input !set:icon "text"Valid sizes
Examples
// Basic Usage
$any = .upload-file-input "Label".upload-image
The .upload-image action Creates a button to let users upload and resize images from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-image +imagetagReturn Value
This function returns a
$result = .upload-image Valid sizes
Examples
// Basic Usage
$response = .upload-image %icontag.upload-json
The .upload-json action Creates a button to let users upload JSON files from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-json +imagetagReturn Value
This function returns a
$result = .upload-json Valid sizes
Examples
// Basic Usage
$response = .upload-json %icontag.user-login
The .user-login action app user login panel. It belongs to the auth category within the external area.
Action Syntax
.user-login [file]Valid sizes
Examples
// Basic Usage
.user-login [block].validate-email
The .validate-email action validates input is valid email. It belongs to the validate category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.validate-email.value
The .value action shows the text value of a variable. It belongs to the variables category within the external area.
Action Syntax
.value $variable.value "text"Valid sizes
Examples
// Basic Usage
.value $var.video
The .video action shows MP4 video. It belongs to the video category within the media area.
Action Syntax
.video +imagetagValid sizes
Tags
controls
shows video playboack controls
muted
starts video in muted mode
Examples
// Basic Usage
.video %videotag.video-banner
The .video-banner action shows a video banner (edge to edge). It belongs to the video category within the media area.
Action Syntax
.video-banner +imagetagValid sizes
Examples
// Basic Usage
.video-banner %videotag.video-button
The .video-button action an video button. It belongs to the video category within the media area.
Action Syntax
.video-button +imagetag.video-button +imagetag [file]Valid sizes
Tags
rounded
a rounded button (default)
circle
a circle button
square
a square button
Examples
// Basic Usage
.video-button %video2.wait
The .wait action waits on previous modifier action before continuing. It belongs to the modifier category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.wait.when-load-complete
The .when-load-complete action modifier for when load complete event. It belongs to the modifier category within the ui area.
Action Syntax
.when-load-complete continue.when-load-complete [file]Valid sizes
Examples
// Basic Usage
.when-load-complete continue.youtube
The .youtube action shows a youtube icon link. It belongs to the social category within the ui area.
Action Syntax
.youtube "text".youtube $variableValid sizes
Examples
// Basic Usage
.youtube "socialid"// Using Variables
// Display dynamic content from variables
.youtube $var.youtube-video
The .youtube-video action a youtube video player. It belongs to the video category within the media area.
Action Syntax
.youtube-video "text".youtube-video $variableValid sizes
Examples
// Basic Usage
.youtube-video "videoid"// Using Variables
// Display dynamic content from variables
.youtube-video $videoid+attachable
The +attachable action Groups related form fields together with optional label. It belongs to the fields category within the ui area.
Action Syntax
+attachable "text"+attachable $variableValid sizes
Examples
// Basic Usage
.fieldset "label"// Using Variables
// Display dynamic content from variables
.fieldset $label+decorate
The +decorate action basic mobile navigation button with icon and a label. It belongs to the buttons category within the ui area.
Action Syntax
+decorate !set:icon "text"+decorate !set:icon "text" [file]+decorate !set:icon [file]+decorate !set:icon $variable [file]Valid sizes
Examples
// Basic Usage
.nav-button !icon "Label"// Using Variables
// Display dynamic content from variables
.nav-button !icon $label [block]+paste-image
Work with +paste image
Overview
The +paste-image action is part of the clipboard set in Rhyme. Work with +paste image.
Category: Clipboard
Area: ⚙️ System & Control Flow
Basic Usage
+paste-image "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
+paste-image "Example usage"Example 2: With Variables
$my-variable: "some value"
+paste-image $my-variableTips
- This action is part of the clipboard set
- Common use case: Controlling app flow and logic
Related Actions
Related actions from the clipboard set will be listed here.
+paste-image
The +paste-image action pastes an image into the clipboard. It belongs to the clipboard category within the system area.
Action Syntax
+paste-image EReturn Value
This function returns a
$result = +paste-image Valid sizes
Examples
// Basic Usage
$image = +paste-image *target+tint
The +tint action tints image with a color. It belongs to the images category within the ui area.
Action Syntax
+tint #color+tint $variableValid sizes
Examples
// Basic Usage
+tint #color// Using Variables
// Display dynamic content from variables
+tint $color+when-close
The +when-close action action to take when the parent element is closed. It belongs to the editors category within the appdev area.
Action Syntax
+when-close [file]Valid sizes
Examples
// Basic Usage
+when-close [block]+when-load-complete
The +when-load-complete action Displays images from web urls or your media collection. It belongs to the html category within the ui area.
Action Syntax
+when-load-complete https://...+when-load-complete +imagetag+when-load-complete $variableValid sizes
Examples
// Basic Usage
.img https://example.com/photo.jpg// Using Variables
// Display dynamic content from variables
.img $image-urlaccount-ctx
The account-ctx action gets the Rhappsody Account CTX. It belongs to the account category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = account-ctx Valid sizes
Examples
// Basic Usage
account-ctxaccount-login
The account-login action login to rhappsody account. It belongs to the account category within the platform area.
Action Syntax
account-login $variable $variableReturn Value
This function returns a
$result = account-login Valid sizes
Examples
// Basic Usage
$response = account-login $email $passwordaccount-logout
The account-logout action logs out of rhappsody account. It belongs to the account category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
account-logoutaccount-signup
The account-signup action signs user email up for new rhappsody account. It belongs to the account category within the platform area.
Action Syntax
account-signup $variable $variableReturn Value
This function returns a
$result = account-signup Valid sizes
Examples
// Basic Usage
$response = account-signup $email $passwordaction
The action action this is just a demo action. It belongs to the _tmpl category within the templates area.
Action Syntax
action #coloraction +imagetag ~soundaction %font "text"action add 123 to 123action goto $variable 123action $variableaction .elementaction !set:icon https://...action "text"action !set:iconaction +imagetag tagExamples
// Basic Usage
action #red4// Using Variables
// Display dynamic content from variables
action goto $foo 456add
The add action Adds a number to an existing value. It belongs to the math category within the data area.
Action Syntax
add 123add $variableValid sizes
Examples
// Basic Usage
add 22// Using Variables
// Display dynamic content from variables
add $numberadd-days
The add-days action adds days to a given date. It belongs to the datetime category within the data area.
Action Syntax
add-days 123 to $variableadd-days $variable to $variableadd-days 123 to YYYY-MM-DDadd-days $variable to YYYY-MM-DDReturn Value
This function returns a
add-line
The add-line action Add a line of text to existing text with newline. It belongs to the text category within the ui area.
Action Syntax
add-line "text" to "text"add-line $variable to "text"add-line $variable to $variableadd-line "text" to $variableReturn Value
This function returns a
add-row
The add-row action adds a row to a table. It belongs to the row category within the data area.
Action Syntax
add-row $variable to $variableReturn Value
This function returns a
$result = add-row Valid sizes
Examples
// Basic Usage
$grp_item = add-row $r to $tadd-text
The add-text action Concatenates two text values together. It belongs to the text category within the ui area.
Action Syntax
add-text "text" to "text"add-text $variable to "text"add-text $variable to $variableadd-text "text" to $variableReturn Value
This function returns a
add-weeks
The add-weeks action adds weeks to a given date. It belongs to the datetime category within the data area.
Action Syntax
add-weeks 123 to $variableadd-weeks $variable to $variableadd-weeks 123 to YYYY-MM-DDadd-weeks $variable to YYYY-MM-DDReturn Value
This function returns a
admin-login
The admin-login action admin-login. It belongs to the auth category within the external area.
Action Syntax
admin-login @reference $variableadmin-login $variable $variableReturn Value
This function returns a
$result = admin-login Valid sizes
Examples
// Basic Usage
$item = admin-login @name $passcodeai-auth
The ai-auth action sets ai provider api or auth key. It belongs to the ai category within the external area.
Action Syntax
ai-auth "text"Valid sizes
Examples
// Basic Usage
ai-auth "fffffff"ai-context
The ai-context action sets ai context. It belongs to the ai category within the external area.
Action Syntax
ai-context $variableai-context $variable $variableai-context $variable $variable $variableai-context $variable $variable $variable $variableValid sizes
Examples
// Basic Usage
ai-context $varnameai-model
The ai-model action sets ai model. It belongs to the ai category within the external area.
Action Syntax
ai-model "text"ai-model $variableValid sizes
Examples
// Basic Usage
ai-model "modelname"// Using Variables
// Display dynamic content from variables
ai-model $textai-provider
The ai-provider action sets ai provider. It belongs to the ai category within the external area.
Action Syntax
ai-provider "text"ai-provider $variableValid sizes
Examples
// Basic Usage
ai-provider "provider"// Using Variables
// Display dynamic content from variables
ai-provider $providerallow-dynamic-actions
The allow-dynamic-actions action allowed dynamic action referencing. It belongs to the actions category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
allow-dynamic-actionsand
The and action hidden for , addon to varset!. It belongs to the variables category within the external area.
Action Syntax
and $variableand "text"and 123and true|falseand 30mand HH:MMand YYYY-MM-DDValid sizes
Examples
// Basic Usage
and $varnameapp
The app action defines the app name, along with key auth key. It belongs to the appauth category within the system area.
Action Syntax
app @referenceapp @reference "text"Valid sizes
Examples
// Basic Usage
app @aganapp-authorization
The app-authorization action generates an app authorization token if needed at runtime. It belongs to the app category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = app-authorization Valid sizes
Tags
reset
resets any local saved auth/forces re-auth
Examples
// Basic Usage
app-authorizationapp-colors
The app-colors action sets the default app colors. It belongs to the app category within the platform area.
Action Syntax
app-colors #colorapp-colors #color #colorValid sizes
Examples
// Basic Usage
app-colors #fgcolorapp-context
The app-context action gets app context item from the environment. It belongs to the app category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = app-context Valid sizes
Examples
// Basic Usage
app-contextapp-context-server
The app-context-server action Gets the server context for the current app including environment, region, version, and server time. It belongs to the app category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = app-context-server Valid sizes
Examples
// Basic Usage
app-context-serverapp-data
The app-data action stub action for all server app data ACTIONS. It belongs to the data category within the data area.
Action Syntax
app-data $variableReturn Value
This function returns a
$result = app-data Valid sizes
Examples
// Basic Usage
$response = app-data $varnameapp-expires-on
The app-expires-on action sets the time and/or date the app will expire. It belongs to the app category within the platform area.
Action Syntax
app-expires-on YYYY-MM-DDapp-expires-on YYYY-MM-DD at HH:MMapp-expires-on YYYY-MM-DD [file]app-expires-on YYYY-MM-DD at HH:MM [file]Valid sizes
Examples
// Basic Usage
app-expires-on 2025-12-31app-font
The app-font action Sets the default font used throughout your app. It belongs to the fonts category within the ui area.
Action Syntax
app-font "text"Valid sizes
Examples
// Basic Usage
app-font "fontname"app-golive-on
The app-golive-on action sets the time and/or date the app will be available to users. It belongs to the app category within the platform area.
Action Syntax
app-golive-on YYYY-MM-DDapp-golive-on YYYY-MM-DD at HH:MMapp-golive-on YYYY-MM-DD [file]app-golive-on YYYY-MM-DD at HH:MM [file]Valid sizes
Examples
// Basic Usage
app-golive-on 2025-12-31app-host
The app-host action defines an allowed host for the app. The rhapp.app domain is allowed by default. It belongs to the appauth category within the system area.
Action Syntax
app-host https://...Valid sizes
Examples
// Basic Usage
app-host https://www.acme.comapp-image
The app-image action manually defines app-images: this are cached and save on the device. Use for images that do not change often or ever. It belongs to the images category within the ui area.
Action Syntax
app-image +imagetag https://...Valid sizes
Examples
// Basic Usage
app-image %imagetag https://imageurlapp-mode
The app-mode action set app mode to light or dark. It belongs to the app category within the platform area.
Action Syntax
app-mode lightapp-mode darkValid sizes
Examples
// Basic Usage
app-mode lightapp-name
The app-name action sets the App Name. Appears under icon. It belongs to the app category within the platform area.
Action Syntax
app-name "text"Valid sizes
Examples
// Basic Usage
app-name "appname"app-password
The app-password action protect app with basic password. It belongs to the auth category within the external area.
Action Syntax
app-password 123app-password "text"app-password 123 [file]app-password "text" [file]Valid sizes
Examples
// Basic Usage
app-password 1234app-private
The app-private action sets app private key. It belongs to the appauth category within the system area.
Action Syntax
app-private privatekeyValid sizes
Examples
// Basic Usage
app-private privatekeyapp-public
The app-public action defines an app public auth key. It belongs to the appauth category within the system area.
Action Syntax
app-public publickeyValid sizes
Examples
// Basic Usage
app-public publickeyapp-sound
The app-sound action defines an app sound. It belongs to the sounds category within the media area.
Action Syntax
app-sound ~sound https://...app-sound ~sound ~soundValid sizes
Examples
// Basic Usage
app-sound ~soundtag https://soundfileappdev
The appdev action mainly a STUB server for all appdev related server actions. It belongs to the appdev category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
appdevaverage
The average action Calculates the average (mean) of a set of numbers in an array. It belongs to the math category within the undefined area.
Action Syntax
average $variableReturn Value
This function returns a
$result = average Tags
round=2
Examples
// Basic Usage
average $arraybackground-image
The background-image action Sets a full-screen background image for the entire app. It belongs to the layout category within the undefined area.
Action Syntax
background-image https://...background-image $variablebackground-image +imagetagTags
blur=5
opacity=0.8
fixed
Examples
// Basic Usage
background-image https://example.com/image.jpg// Using Variables
// Display dynamic content from variables
background-image $imageurlbluesky
Work with bluesky
Overview
The bluesky action is part of the social set in Rhyme. Work with bluesky.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
bluesky "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
bluesky "Example usage"Example 2: With Variables
$my-variable: "some value"
bluesky $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
break
The break action breaks / halts app execution for debugging. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
breakbrowser-version
The browser-version action returns info about the current browser environment. It belongs to the browser category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = browser-version Valid sizes
Examples
// Basic Usage
browser-versionbuild-app
The build-app action builds an app from rhyme source text. It belongs to the appdev category within the platform area.
Action Syntax
build-app $variablebuild-app "text"Return Value
This function returns a
$result = build-app Valid sizes
Examples
// Basic Usage
$text = build-app $sourcecalculate
The calculate action performs a calculation. It belongs to the math category within the data area.
Action Syntax
calculate EXPRReturn Value
This function returns a
$result = calculate Valid sizes
Examples
// Basic Usage
$number = calculate (expr)capitalize
The capitalize action Capitalizes the first letter of each word in text. It belongs to the text category within the ui area.
Action Syntax
capitalize "text"capitalize $variableReturn Value
This function returns a
$result = capitalize Valid sizes
Examples
// Basic Usage
$text = capitalize "hello world"character
The character action Gets the character at a specific position in text. It belongs to the text category within the ui area.
Action Syntax
character 123 of $variablecharacter $variable of $variablecharacter 123 of "text"character $variable of "text"Return Value
This function returns a
clear-acknowledgement
The clear-acknowledgement action clears all prior user acknowledgements. It belongs to the acknowledgement category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-acknowledgementclear-announcement
The clear-announcement action clears announcement from an app if it exists. It belongs to the announcements category within the interaction area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-announcementclear-client
The clear-client action clears out rhappsody client info from the device. It belongs to the client category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-clientclear-icons
The clear-icons action clears offline/caches icons from device. It belongs to the icons category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-iconsclear-image
The clear-image action deletes a stored images from this device. It belongs to the images category within the ui area.
Action Syntax
clear-image +imagetagclear-image $variableValid sizes
Examples
// Basic Usage
clear-image %imagetag// Using Variables
// Display dynamic content from variables
clear-image $imagetagclear-images
The clear-images action clears all stored/cached images on local device. It belongs to the images category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = clear-images Valid sizes
Examples
// Basic Usage
clear-imagesclear-inbox
The clear-inbox action clears the inbox of messages. It belongs to the inbox category within the external area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = clear-inbox Valid sizes
Examples
// Basic Usage
clear-inboxclear-profile
The clear-profile action Removes all saved user profile information from your app. It belongs to the profile category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-profileclose-menu
The close-menu action closes a menu. It belongs to the menus category within the ui area.
Action Syntax
close-menu EValid sizes
Examples
// Basic Usage
close-menu *idcolor
The color action defines a color or alias. It belongs to the color category within the ui area.
Action Syntax
color #color is #colorValid sizes
Examples
// Basic Usage
color #color is #colorcompile
The compile action compiles rhyme source code using compiler (init-compiler required first). It belongs to the compiler category within the system area.
Action Syntax
compile $variablecompile "text"compile blkReturn Value
This function returns a
$result = compile Valid sizes
Examples
// Basic Usage
$response = compile $sourceconditional
The conditional action a very special op that is a conditional attach/execution of a SINGLE compiled op to its previous op. It belongs to the flow category within the system area.
Action Syntax
conditionalThis action takes no parameters and is used as a bare command.
Examples
// Basic Usage
conditionalconfetti
Work with confetti
Overview
The confetti action is part of the specialfx set in Rhyme. Work with confetti.
Category: Specialfx
Area: 🎨 UI & Presentation
Basic Usage
confetti "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
confetti "Example usage"Example 2: With Variables
$my-variable: "some value"
confetti $my-variableTips
- This action is part of the specialfx set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the specialfx set will be listed here.
console-error
The console-error action a javascript console.error equivalent. It belongs to the debug category within the dev area.
Action Syntax
console-error "text"console-error $variableValid sizes
Examples
// Basic Usage
console-error "message"// Using Variables
// Display dynamic content from variables
console-error $messageconsole-info
The console-info action a javascript console.info equivalent. It belongs to the debug category within the dev area.
Action Syntax
console-info "text"console-info $variableValid sizes
Examples
// Basic Usage
console-info "message"// Using Variables
// Display dynamic content from variables
console-info $messageconsole-log
The console-log action a javascript console.log equivalent. It belongs to the debug category within the dev area.
Action Syntax
console-log "text"console-log $variableValid sizes
Examples
// Basic Usage
console-log "message"// Using Variables
// Display dynamic content from variables
console-log $messageconsole-var
The console-var action prints a variable to the javacript console. It belongs to the debug category within the dev area.
Action Syntax
console-var $variableValid sizes
Examples
// Basic Usage
console-var $varnamecontains
The contains action contains actions. It belongs to the logicfn category within the system area.
Action Syntax
contains "text"contains $variablecontains 123Return Value
This function returns a
$result = contains Valid sizes
Examples
// Basic Usage
$boolean = contains "text"continue
The continue action continues running the app block (usually) after a wait. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
continuecore-kv-get
The core-kv-get action core-kv-get gets kv. It belongs to the core category within the core area.
Action Syntax
core-kv-get $variable from "text"Return Value
This function returns a
$result = core-kv-get Valid sizes
Examples
// Basic Usage
$varrec = core-kv-get $keyname from "BIND"core-kv-put
The core-kv-put action Cloudflare KV put. It belongs to the cfkv category within the core area.
Action Syntax
core-kv-put $variable into "text"Return Value
This function returns a
$result = core-kv-put Valid sizes
Examples
// Basic Usage
$response = core-kv-put $varname into "BINDNAME"core-run
The core-run action core-run a reserver internal only CFW runner. It belongs to the core category within the core area.
Action Syntax
core-run [file]Return Value
This function returns a
$result = core-run Valid sizes
Examples
// Basic Usage
$response = core-run [server-block]corner-banner
Work with corner banner
Overview
The corner-banner action is part of the specialfx set in Rhyme. Work with corner banner.
Category: Specialfx
Area: 🎨 UI & Presentation
Basic Usage
corner-banner "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
corner-banner "Example usage"Example 2: With Variables
$my-variable: "some value"
corner-banner $my-variableTips
- This action is part of the specialfx set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the specialfx set will be listed here.
create-key
The create-key action creates a randon offical encrpytion key - 32 characters long. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = create-key Valid sizes
Examples
// Basic Usage
create-keycreate-table
The create-table action creates a new table. It belongs to the table category within the ui area.
Action Syntax
create-table with 123 rowscreate-table with $variable rowscreate-table of $variable with 123 rowscreate-table of $variable with $variable rowsReturn Value
This function returns a
csv
The csv action defines a block of static csv data. It belongs to the data category within the data area.
Action Syntax
csvThis action takes no parameters and is used as a bare command.
Examples
// Basic Usage
csvday-names
The day-names action gets localized day names. It belongs to the datetime category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = day-names Valid sizes
Examples
// Basic Usage
$dn = day-namesdays-between
The days-between action calculate the number of days between two dates. It belongs to the datetime category within the data area.
Action Syntax
days-between $variable and $variabledays-between $variable and YYYY-MM-DDdays-between YYYY-MM-DD and $variabledays-between YYYY-MM-DD and YYYY-MM-DDReturn Value
This function returns a
days-until
The days-until action calculate the days until specified or current date. It belongs to the datetime category within the data area.
Action Syntax
days-until todaydays-until YYYY-MM-DDdays-until $variableReturn Value
This function returns a
$result = days-until Valid sizes
Examples
// Basic Usage
$number = days-until todaydecode-secret
The decode-secret action test function to decode a secret. It belongs to the secrets category within the system area.
Action Syntax
decode-secret "text" with $variableReturn Value
This function returns a
$result = decode-secret Valid sizes
Examples
// Basic Usage
$text = decode-secret "SECRETNAME" with $keydecrement
The decrement action decrmeents a number variable. It belongs to the math category within the data area.
Action Syntax
decrement $variableValid sizes
Examples
// Basic Usage
decrement $varnamedecrypt
The decrypt action general decryption. It belongs to the secrets category within the system area.
Action Syntax
decrypt "text"decrypt $variabledecrypt "text" with $variabledecrypt $variable with $variableReturn Value
This function returns a
default
The default action sets a default value for a variable if it does not already exist. It belongs to the variables category within the external area.
Action Syntax
default $variable = "text"default $variable = 123default $variable = [file]default $variable = HH:MMdefault $variable = YYYY-MM-DDdefault $variable = 30mdefault $variable = $variabledefault $variable = ITdefault $variable = blkValid sizes
Examples
// Basic Usage
default $var = "text value"default-style
The default-style action define a default style for an element type. It belongs to the styling category within the ui area.
Action Syntax
default-style .elementValid sizes
Examples
// Basic Usage
default-style .elementdelay
The delay action delays or sleeps for a specified amount of time. It belongs to the exec category within the system area.
Action Syntax
delay 30mdelay $variableValid sizes
Examples
// Basic Usage
delay 3s// Using Variables
// Display dynamic content from variables
delay $timedelete
The delete action deletes previously saved value. It belongs to the localstorage category within the storage area.
Action Syntax
delete $variableValid sizes
Examples
// Basic Usage
delete $varnamedelete-all-videos
The delete-all-videos action deletes all saved local video files. It belongs to the video category within the media area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = delete-all-videos Valid sizes
Examples
// Basic Usage
delete-all-videosdelete-app-data
The delete-app-data action delete app data (private). It belongs to the data category within the data area.
Action Syntax
delete-app-data $variableReturn Value
This function returns a
$result = delete-app-data Valid sizes
Examples
// Basic Usage
$response = delete-app-data $varnamedelete-app-image
The delete-app-image action deletes an app image. It belongs to the images category within the ui area.
Action Syntax
delete-app-image +imagetagdelete-app-image $variableReturn Value
This function returns a
$result = delete-app-image Valid sizes
Examples
// Basic Usage
$response = delete-app-image %imagetagdelete-appgroup
The delete-appgroup action deletes an appgroup from an account. It belongs to the appgroup category within the platform area.
Action Syntax
delete-appgroup $variabledelete-appgroup "text"Return Value
This function returns a
$result = delete-appgroup Valid sizes
Examples
// Basic Usage
$response = delete-appgroup $namedelete-column
The delete-column action deletes a column from a table. It belongs to the column category within the data area.
Action Syntax
delete-column "text" from $variableReturn Value
This function returns a
$result = delete-column Valid sizes
Examples
// Basic Usage
$group = delete-column "name" from $groupvardelete-inbox-message
The delete-inbox-message action deletes an app inbox message. It belongs to the inbox category within the external area.
Action Syntax
delete-inbox-message 123delete-inbox-message $variableReturn Value
This function returns a
$result = delete-inbox-message Valid sizes
Examples
// Basic Usage
$response = delete-inbox-message 10delete-key
The delete-key action Sets up what happens when delete key is pressed. It belongs to the keys category within the ui area.
Action Syntax
delete-key [file]delete-key goto [file]delete-key run [file]delete-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
delete-key [block]delete-public-app-data
The delete-public-app-data action delete app data (public). It belongs to the data category within the data area.
Action Syntax
delete-public-app-data $variableReturn Value
This function returns a
$result = delete-public-app-data Valid sizes
Examples
// Basic Usage
$response = delete-public-app-data $varnamedelete-public-user-data
The delete-public-user-data action delete user data item (public). It belongs to the users category within the system area.
Action Syntax
delete-public-user-data $variableReturn Value
This function returns a
$result = delete-public-user-data Valid sizes
Examples
// Basic Usage
$response = delete-public-user-data $varnamedelete-row
The delete-row action deletes a row from a table. It belongs to the row category within the data area.
Action Syntax
delete-row 123 from $variabledelete-row $variable from $variableReturn Value
This function returns a
delete-saved
The delete-saved action deletes all previously saved variables. It belongs to the localstorage category within the storage area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = delete-saved Valid sizes
Examples
// Basic Usage
delete-saveddelete-user-data
The delete-user-data action delete user data item (private). It belongs to the users category within the system area.
Action Syntax
delete-user-data $variableReturn Value
This function returns a
$result = delete-user-data Valid sizes
Examples
// Basic Usage
$response = delete-user-data $varnamedir-action
The dir-action action prints syntax help for specified action. It belongs to the shell category within the platform area.
Action Syntax
dir-action "text"Valid sizes
Examples
// Basic Usage
dir-action "actioname"dir-actions
The dir-actions action displays a list of actions. It belongs to the shell category within the platform area.
Action Syntax
dir-actions "text"Valid sizes
Examples
// Basic Usage
dir-actions "prefix"dir-app
The dir-app action displays the status of the current app. It belongs to the shell category within the platform area.
Action Syntax
dir-app @referenceValid sizes
Examples
// Basic Usage
dir-app @appnamedir-blocks
The dir-blocks action lists the blocks in the current app. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-blocksdir-boot
The dir-boot action boot and runs the current devmode app. It belongs to the shell category within the platform area.
Action Syntax
dir-boot $variabledir-boot [file]Valid sizes
Examples
// Basic Usage
dir-boot $blockdir-build
The dir-build action builds the current app. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-builddir-clear
The dir-clear action /clear - clears the shell screen. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-cleardir-clear-inbox
The dir-clear-inbox action /clear-inbox - clears out app inbox. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-clear-inboxdir-compile
The dir-compile action compiles the current app. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-compiledir-compiler
The dir-compiler action manage local environment compiler instances. It belongs to the shell category within the platform area.
Action Syntax
dir-compiler listdir-compiler loadValid sizes
Tags
version
specific version of compiler: dev, beta, latest, or a specific version
Examples
// Basic Usage
dir-compiler listdir-current
The dir-current action /current - display or sets current app target. It belongs to the shell category within the platform area.
Action Syntax
dir-current @referenceValid sizes
Examples
// Basic Usage
dir-current @apptagdir-delay
The dir-delay action simulate a delay. It belongs to the shell category within the platform area.
Action Syntax
dir-delay 30mValid sizes
Examples
// Basic Usage
dir-delay 1sdir-delete-appgroup
The dir-delete-appgroup action /delete-appgroup. It belongs to the shell category within the platform area.
Action Syntax
dir-delete-appgroup @referenceValid sizes
Examples
// Basic Usage
dir-delete-appgroup @agnamedir-delete-image
The dir-delete-image action deletes an app image. It belongs to the shell category within the platform area.
Action Syntax
dir-delete-image +imagetagValid sizes
Examples
// Basic Usage
dir-delete-image %imagetagdir-dev
The dir-dev action /dev - turns on development mode. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-devdir-edit
The dir-edit action launches editor (requires dev model). It belongs to the shell category within the platform area.
Action Syntax
dir-edit @referencedir-edit [file]dir-edit $variabledir-edit 123Valid sizes
Examples
// Basic Usage
dir-edit @appname// Using Variables
// Display dynamic content from variables
dir-edit $blocknamedir-edit-block
The dir-edit-block action launches block editor (requires dev model). It belongs to the shell category within the platform area.
Action Syntax
dir-edit-block [file]dir-edit-block $variableValid sizes
Examples
// Basic Usage
dir-edit-block [block]// Using Variables
// Display dynamic content from variables
dir-edit-block $blocknamedir-files
The dir-files action lists app files. It belongs to the shell category within the platform area.
Action Syntax
dir-files privatedir-files sbpublicdir-files sbprivateValid sizes
Examples
// Basic Usage
dir-files privatedir-help
The dir-help action /help interactive shell help. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-helpdir-hide
The dir-hide action hides shell screen. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-hidedir-images
The dir-images action lists all app-images. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-imagesdir-inbox
The dir-inbox action /inbox - lists the inbox messages for this app. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-inboxdir-list-apps
The dir-list-apps action /list-apps - lists apps in current app group. It belongs to the shell category within the platform area.
Action Syntax
dir-list-apps @referenceValid sizes
Examples
// Basic Usage
dir-list-apps @appgroupdir-list-groups
The dir-list-groups action /list-groups lists the current account’s app groups. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-list-groupsdir-load
The dir-load action loads app source from platform. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-loaddir-login
The dir-login action logs into rhappsody account. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
ifneeded
set to bypass prompt if you are already logged in
Examples
// Basic Usage
dir-logindir-login-if-needed
The dir-login-if-needed action login to rhappsody account if needed. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-login-if-neededdir-logout
The dir-logout action logs out of rhappsody account. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-logoutdir-mock-date
The dir-mock-date action sets a mock date for testing. It belongs to the shell category within the platform area.
Action Syntax
dir-mock-date YYYY-MM-DDdir-mock-date YYYY-MM-DD HH:MMdir-mock-date HH:MMValid sizes
Examples
// Basic Usage
dir-mock-date 2025-09-27dir-new
The dir-new action /new to create a new app. It belongs to the appdev category within the platform area.
Action Syntax
dir-new @referenceValid sizes
Examples
// Basic Usage
dir-new @appnamedir-new-appgroup
The dir-new-appgroup action /new-appgroup - adds a new app group to account. It belongs to the shell category within the platform area.
Action Syntax
dir-new-appgroup @referenceValid sizes
Examples
// Basic Usage
dir-new-appgroup @groupnamedir-new-image
The dir-new-image action adds a new app image via upload. It belongs to the shell category within the platform area.
Action Syntax
dir-new-image +imagetagValid sizes
Examples
// Basic Usage
dir-new-image %imagetagdir-publish
The dir-publish action publishes a new version of current app. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-publishdir-regen-keys
The dir-regen-keys action regenerate app keys. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-regen-keysdir-secrets
The dir-secrets action /secrets - lists defined secret names. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-secretsdir-send-inbox-message
The dir-send-inbox-message action sends a test inbox message. It belongs to the shell category within the platform area.
Action Syntax
dir-send-inbox-message "text"Valid sizes
Examples
// Basic Usage
dir-send-inbox-message "message"dir-set
The dir-set action makes platform setting changes. It belongs to the shell category within the platform area.
Action Syntax
dir-set activedir-set inactivedir-set name "text"dir-set brand-color #colorValid sizes
Examples
// Basic Usage
dir-set activedir-sets
The dir-sets action /sets - lists action sets. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-setsdir-shell
The dir-shell action launches an integrated development shell for the current app. It belongs to the shell category within the platform area.
Action Syntax
dir-shell #colordir-shell #color #colordir-shell #color #color #colordir-shell #color #color #color #colorValid sizes
Tags
background
instantiates shell in background. use /show to display
dir-show
The dir-show action shows shell screen. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-showdir-source
The dir-source action /source - shows current app source. It belongs to the shell category within the platform area.
Action Syntax
dir-source [file]Valid sizes
Examples
// Basic Usage
dir-source [block]dir-source-default
The dir-source-default action sets default app source code (RHDEV.source) if not already set. It belongs to the shell category within the platform area.
Action Syntax
dir-source-default $variabledir-source-default "text"dir-source-default blkValid sizes
Examples
// Basic Usage
dir-source-default $namedir-status
The dir-status action status of the current app. It belongs to the shell category within the platform area.
Action Syntax
dir-status @referenceValid sizes
Examples
// Basic Usage
dir-status @apptagdir-users
The dir-users action /users - shows app users. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-usersdir-who
The dir-who action /who displays current account info. It belongs to the shell category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
dir-whodistance-between
The distance-between action Calculates the distance between two geographic points (latitude/longitude) in miles or kilometers. It belongs to the location category within the undefined area.
Action Syntax
distance-between $variable $variableTags
km
miles
result=$Ndistance
Examples
// Basic Usage
distance-between $pointa $pointbdivide
The divide action divide. It belongs to the math category within the data area.
Action Syntax
divide $variable by $variabledivide $variable by 123Return Value
This function returns a
down-key
The down-key action down arrow key. It belongs to the keys category within the ui area.
Action Syntax
down-key [file]down-key goto [file]down-key run [file]down-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
down-key [block]dynamic-action
The dynamic-action action hidden command that is a dynamic action “carrier” action. It belongs to the actions category within the system area.
Action Syntax
dynamic-action "text"dynamic-action 123dynamic-action 123 123dynamic-action $variabledynamic-action $variable $variabledynamic-action [file]dynamic-action "text" [file]Valid sizes
Examples
// Basic Usage
dynamic-action "placeholder"// Using Variables
// Display dynamic content from variables
dynamic-action $varnamedynamic-color-theme
The dynamic-color-theme action sets a dynamic color theme from an image or base color. It belongs to the color category within the ui area.
Action Syntax
dynamic-color-theme +imagetagdynamic-color-theme #colordynamic-color-theme $variableValid sizes
Examples
// Basic Usage
dynamic-color-theme %imagetag// Using Variables
// Display dynamic content from variables
dynamic-color-theme $coloreditor-login
The editor-login action editor-login. It belongs to the auth category within the external area.
Action Syntax
editor-login @reference $variableeditor-login $variable $variableReturn Value
This function returns a
$result = editor-login Valid sizes
Examples
// Basic Usage
$item = editor-login @name $passcodeeditor-onkey
The editor-onkey action generic/core onkey handler for editors. It belongs to the editors category within the appdev area.
Action Syntax
editor-onkey 123 [file]Valid sizes
Examples
// Basic Usage
editor-onkey 12 [block]enable-shell-shortcut
The enable-shell-shortcut action enable the shell shortcut key. It belongs to the keys category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
enable-shell-shortcutencrypt
The encrypt action encrypts data. It belongs to the secrets category within the system area.
Action Syntax
encrypt "text"encrypt $variableencrypt "text" with $variableencrypt $variable with $variableReturn Value
This function returns a
endconditional
The endconditional action :end to end multiline conditional. It belongs to the flow category within the system area.
Action Syntax
endconditionalThis action takes no parameters and is used as a bare command.
Examples
// Basic Usage
endconditionalenglish
The english action Checks if the current language is set to English. It belongs to the language category within the media area.
Action Syntax
englishThis action takes no parameters and is used as a bare command.
Description: test if language is English
Valid sizes
Examples
// Basic Usage
englishensure-email
The ensure-email action ensure last input value is an email. It belongs to the validate category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
ensure-emailenter-date
enter date field
Overview
The enter-date action is part of the enter set in Rhyme. enter date field. enter date field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-date "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-date "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-date $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-email
enter email field
Overview
The enter-email action is part of the enter set in Rhyme. enter email field. enter email field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-email "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-email "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-email $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-family-name
enter family-name field
Overview
The enter-family-name action is part of the enter set in Rhyme. enter family-name field. enter family-name field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-family-name "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-family-name "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-family-name $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-fullname
enter fullname field
Overview
The enter-fullname action is part of the enter set in Rhyme. enter fullname field. enter fullname field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-fullname "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-fullname "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-fullname $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-given-name
enter given-name field
Overview
The enter-given-name action is part of the enter set in Rhyme. enter given-name field. enter given-name field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-given-name "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-given-name "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-given-name $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-helptext
adds help text below an .enter-xxxx element
Overview
The enter-helptext action is part of the enter set in Rhyme. adds help text below an .enter-xxxx element. adds help text below an .enter-xxxx element
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-helptext "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-helptext "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-helptext $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-key
The enter-key action enter key. It belongs to the keys category within the ui area.
Action Syntax
enter-key [file]enter-key goto [file]enter-key run [file]enter-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
enter-key [block]enter-number
enter number field
Overview
The enter-number action is part of the enter set in Rhyme. enter number field. enter number field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-number "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-number "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-number $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-password
enter password field
Overview
The enter-password action is part of the enter set in Rhyme. enter password field. enter password field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-password "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-password "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-password $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-phone
enter phone field
Overview
The enter-phone action is part of the enter set in Rhyme. enter phone field. enter phone field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-phone "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-phone "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-phone $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-text
text input for a single line of text
Overview
The enter-text action is part of the enter set in Rhyme. text input for a single line of text. text input for a single line of text
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-text "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-text "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-text $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
enter-time
enter time field
Overview
The enter-time action is part of the enter set in Rhyme. enter time field. enter time field
Category: Enter
Area: 👆 User Interaction
Basic Usage
enter-time "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
enter-time "Example usage"Example 2: With Variables
$my-variable: "some value"
enter-time $my-variableTips
- This action is part of the enter set
- Common use case: Handling user input and forms
Related Actions
Related actions from the enter set will be listed here.
equals
The equals action tests for equality. It belongs to the logicfn category within the system area.
Action Syntax
equals 123equals "text"equals $variableequals true|falseReturn Value
This function returns a
$result = equals Valid sizes
Examples
// Basic Usage
$boolean = equals 10error-line
displays an error on the app screen
Overview
The error-line action is part of the error set in Rhyme. displays an error on the app screen. displays an error on the app screen
Category: Error
Area: ⚙️ System & Control Flow
Basic Usage
error-line "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
error-line "Example usage"Example 2: With Variables
$my-variable: "some value"
error-line $my-variableTips
- This action is part of the error set
- Common use case: Controlling app flow and logic
Related Actions
Related actions from the error set will be listed here.
escape-key
The escape-key action escape-key. It belongs to the keys category within the ui area.
Action Syntax
escape-key [file]escape-key goto [file]escape-key run [file]escape-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
escape-key [block]exit-module
The exit-module action exits module and returns to host/parent app. It belongs to the modules category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
exit-moduleWork with facebook
Overview
The facebook action is part of the social set in Rhyme. Work with facebook.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
facebook "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
facebook "Example usage"Example 2: With Variables
$my-variable: "some value"
facebook $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
fadein
The fadein action fades element in. It belongs to the animation category within the ui area.
Action Syntax
fadein Efadein E 30mValid sizes
Examples
// Basic Usage
fadein *elidfadeout
The fadeout action fades an element in. It belongs to the animation category within the ui area.
Action Syntax
fadeout Efadeout E 30mValid sizes
Examples
// Basic Usage
fadeout *elidfake
The fake action fakes items. It belongs to the mock category within the dev area.
Action Syntax
fake addressfake 123 addressesfake companyfake 123 companiesfake emailfake 123 emailsfake namefake 123 namesfake linefake 123 linesReturn Value
This function returns a
fake-date
The fake-date action sets a fake date (for testing). It belongs to the mock category within the dev area.
Action Syntax
fake-date YYYY-MM-DDfake-date YYYY-MM-DD HH:MMValid sizes
Examples
// Basic Usage
fake-date 2024-12-04fake-table
The fake-table action creates a fake table for testing. It belongs to the mock category within the dev area.
Action Syntax
fake-table 123 rows 123 columnsReturn Value
This function returns a
$result = fake-table Valid sizes
Examples
// Basic Usage
$grp_item = fake-table 10 rows 10 columnsfake-time
The fake-time action sets a fake time (for testing). It belongs to the mock category within the dev area.
Action Syntax
fake-time HH:MMValid sizes
Examples
// Basic Usage
fake-time 09:00fill-column
The fill-column action fills a table column with fixes value. It belongs to the table category within the ui area.
Action Syntax
fill-column $variable with 123fill-column $variable with "text"fill-column $variable with true|falsefill-column $variable with $variablefill-column $variable with YYYY-MM-DDfill-column $variable with HH:MMfill-column $variable with 30mfill-column $variable with ITExamples
// Basic Usage
fill-column $foo.bar with 10filter-group
The filter-group action filters a group. It belongs to the group category within the data area.
Action Syntax
filter-group $variable starts-with "text"filter-group $variable starts-with $variablefilter-group $variable contains "text"filter-group $variable contains $variableReturn Value
This function returns a
first-row
The first-row action Gets the first row of a table or group. It belongs to the row category within the data area.
Action Syntax
first-row of $variablefirst-row $variableReturn Value
This function returns a
$result = first-row Valid sizes
Examples
// Basic Usage
$item = first-row of $GgroupRelated Actions
- `` -
font
The font action Loads a font from Google Fonts for use in your app. It belongs to the fonts category within the ui area.
Action Syntax
font %font google "text"font %font google "text" https://...Valid sizes
Examples
// Basic Usage
font ^font-tag google "Font Name"foreach
The foreach action loops over a group / column. It belongs to the loops category within the control area.
Action Syntax
foreach $variable run [file]foreach $variableforeach $variable as $variableValid sizes
Examples
// Basic Usage
foreach $V run [block]forget
The forget action forgets / erases a variable from memory. It belongs to the variables category within the external area.
Action Syntax
forget $variableValid sizes
Examples
// Basic Usage
forget $varnamefullscreen-error
a full screen error component
Overview
The fullscreen-error action is part of the error set in Rhyme. a full screen error component. a full screen error component
Category: Error
Area: ⚙️ System & Control Flow
Basic Usage
fullscreen-error "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
fullscreen-error "Example usage"Example 2: With Variables
$my-variable: "some value"
fullscreen-error $my-variableTips
- This action is part of the error set
- Common use case: Controlling app flow and logic
Related Actions
Related actions from the error set will be listed here.
generate-app-key
The generate-app-key action generates an temp app key on the server. Just used for temp apps and testing for now I guesss. It belongs to the appdev category within the platform area.
Action Syntax
generate-app-key "text"Return Value
This function returns a
$result = generate-app-key Valid sizes
Examples
// Basic Usage
$response = generate-app-key "aid"get-ip-location
The get-ip-location action Gets geolocation data for an IP address using the Abstract API. It belongs to the location category within the undefined area.
Action Syntax
get-ip-location $variableTags
result=$Nlocation
fields=$Tfields
Examples
// Basic Usage
get-ip-location $ipget-item-number
The get-item-number action gets specific item number from a group. It belongs to the group category within the data area.
Action Syntax
get-item-number 123 from $variableget-item-number $variable from $variableValid sizes
Examples
// Basic Usage
$any = get-item-number 3 from $Ggroupget-location
The get-location action Gets the user’s current location (latitude, longitude, timestamp) using the browser’s geolocation API. It belongs to the location category within the undefined area.
Action Syntax
get-location $variableTags
timeout=5000
Examples
// Basic Usage
get-location $varget-public-key
The get-public-key action gets app public key. It belongs to the app category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = get-public-key Valid sizes
Examples
// Basic Usage
get-public-keyget-recipe
The get-recipe action get specific recipe by name or index. It belongs to the recipes category within the platform area.
Action Syntax
get-recipe "text"get-recipe $variableReturn Value
This function returns a
$result = get-recipe Valid sizes
Examples
// Basic Usage
$item = get-recipe "name"get-row
The get-row action Gets a specific row by its position number from a table. It belongs to the row category within the data area.
Action Syntax
get-row $variable of $variableget-row 123 of $variableReturn Value
This function returns a
github
Work with github
Overview
The github action is part of the social set in Rhyme. Work with github.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
github "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
github "Example usage"Example 2: With Variables
$my-variable: "some value"
github $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
goto
The goto action Jumps to a different block in your app. It belongs to the goto category within the system area.
Action Syntax
goto [file]goto $variableValid sizes
Tags
no-clear
prevents clearing the screen when jumping
Examples
// Basic Usage
goto [block-name]// Using Variables
// Display dynamic content from variables
goto $block-variablegroq-ai-chat
The groq-ai-chat action Sends a message to Groq AI and gets a response. It belongs to the groq category within the plugins area.
Action Syntax
groq-ai-chat "text"groq-ai-chat $variableReturn Value
This function returns a
$result = groq-ai-chat Valid sizes
Tags
full
returns complete response with metadata
groq-models
The groq-models action Gets a list of available AI models from Groq. It belongs to the groq category within the plugins area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = groq-models Valid sizes
Examples
// Basic Usage
groq-modelshave
The have action checks for variables existance. It belongs to the logicfn category within the system area.
Action Syntax
have $variableReturn Value
This function returns a
$result = have Valid sizes
Examples
// Basic Usage
$boolean = have $varnamehide
The hide action hide specified element. It belongs to the layout category within the ui area.
Action Syntax
hide EValid sizes
Examples
// Basic Usage
hide *targethost-call
The host-call action call a function at the host / parent level. The environment is usually the browser to server javascript run time global environment. It belongs to the exec category within the system area.
Action Syntax
host-call "text"host-call "text" $variablehost-call "text" $variable $variableReturn Value
This function returns a
http-delete
The http-delete action sends a low level http DELETE request. It belongs to the http category within the network area.
Action Syntax
http-delete https://...http-delete $variableReturn Value
This function returns a
$result = http-delete Valid sizes
Examples
// Basic Usage
$response = http-delete https://someurlhttp-get
The http-get action Retrieves data from a web server using GET request. It belongs to the http category within the network area.
Action Syntax
http-get https://...http-get $variableReturn Value
This function returns a
$result = http-get Valid sizes
Examples
// Basic Usage
$response = http-get https://someurlhttp-post
The http-post action sends a low level http POST request. It belongs to the http category within the network area.
Action Syntax
http-post https://...http-post $variableReturn Value
This function returns a
$result = http-post Valid sizes
Examples
// Basic Usage
$response = http-post https://someurlhttp-put
The http-put action sends a low level http PUT request. It belongs to the http category within the network area.
Action Syntax
http-put https://...http-put $variableReturn Value
This function returns a
$result = http-put Valid sizes
Examples
// Basic Usage
$response = http-put https://someurlicon
The icon action defines an icon the app will use including optional aliases. It belongs to the icons category within the ui area.
Action Syntax
icon !set:iconicon !set:icon is !set:iconValid sizes
Examples
// Basic Usage
icon !icontagif
The if action if statement. It belongs to the logic category within the system area.
Action Syntax
if $variable = 123if $variable is 123if $variable = "text"if $variable is "text"if $variable = $variableif $variable is $variableif $variable = true|falseif $variable is true|falseif $variable < 123if $variable < $variableif $variable <= 123if $variable <= $variableif $variable > 123if $variable > $variableif $variable >= 123if $variable >= $variableif $variable contains "text"if $variable contains $variableif $variable starts-with "text"if $variable starts-with $variableif $variable ends-with "text"if $variable ends-with $variableif $variable is not "text"if $variable is not 123if $variable is not true|falseif $variable is not $variableif missing $variableif have $variableExamples
// Basic Usage
if $foo = 10if-fail
The if-fail action if fail condition flow. It belongs to the if category within the control area.
Action Syntax
if-fail [file]Valid sizes
Examples
// Basic Usage
if-fail [block]if-is-closed
The if-is-closed action Checks if your business is currently closed based on schedule. It belongs to the calendar category within the interaction area.
Action Syntax
if-is-closed [file]Return Value
This function returns a
$result = if-is-closed Valid sizes
Examples
// Basic Usage
$boolean = if-is-closed [blockname]if-is-open
The if-is-open action Checks if your business is currently open based on schedule. It belongs to the calendar category within the interaction area.
Action Syntax
if-is-open [file]Return Value
This function returns a
$result = if-is-open Valid sizes
Examples
// Basic Usage
$boolean = if-is-open [blockname]if-success
The if-success action if success condition flow. It belongs to the if category within the control area.
Action Syntax
if-success [file]Valid sizes
Examples
// Basic Usage
if-success [block]image
The image action stores an image in a variable for future use. It belongs to the images category within the ui area.
Action Syntax
image https://...image $variableReturn Value
This function returns a
$result = image Valid sizes
Examples
// Basic Usage
$response = image https://imageurlincrement
The increment action increment - hidden for $var++. It belongs to the math category within the data area.
Action Syntax
increment $variableReturn Value
This function returns a
$result = increment Examples
// Basic Usage
$number = increment $numvinit-all
The init-all action initalize all. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
auth
client
images
Examples
// Basic Usage
init-allinit-animation
The init-animation action initializes animation (lottie player). It belongs to the animation category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-animationinit-auth
The init-auth action initial auth. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-authinit-chat
The init-chat action Sets up chat functionality for your app. It belongs to the chat category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-chatinit-client
The init-client action initialized rhappsody client. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-clientinit-compiler
The init-compiler action initializes compiler (must be loaded already). It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = init-compiler Valid sizes
Tags
version
specific version. default is latest
Examples
// Basic Usage
init-compilerinit-help
The init-help action initialized inline rhappsody/rhyme help actions. It belongs to the help category within the system area.
Action Syntax
init-helpThis action takes no parameters and is used as a bare command.
Valid sizes
Examples
// Basic Usage
init-helpinit-images
The init-images action initializes / loads any saved images. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-imagesWork with instagram
Overview
The instagram action is part of the social set in Rhyme. Work with instagram.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
instagram "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
instagram "Example usage"Example 2: With Variables
$my-variable: "some value"
instagram $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
is-appgroup-available
The is-appgroup-available action tests if specified app group is available. It belongs to the appgroup category within the platform area.
Action Syntax
is-appgroup-available $variableis-appgroup-available @referenceReturn Value
This function returns a
$result = is-appgroup-available Valid sizes
Examples
// Basic Usage
$boolean = is-appgroup-available $nameis-date
The is-date action checks if a value is in date format (yyyy-mm-dd). It belongs to the logicfn category within the system area.
Action Syntax
is-date $variableReturn Value
This function returns a
$result = is-date Valid sizes
Examples
// Basic Usage
$boolean = is-date $varnameis-greater-than
The is-greater-than action checks if a value is greater than another value. It belongs to the logicfn category within the system area.
Action Syntax
is-greater-than $variable $variableis-greater-than $variable 123is-greater-than $variable "text"Return Value
This function returns a
is-group
The is-group action checks to see if value is a group (array). It belongs to the logicfn category within the system area.
Action Syntax
is-group $variableReturn Value
This function returns a
$result = is-group Valid sizes
Examples
// Basic Usage
$boolean = is-group $varnameis-item
The is-item action checks to see if value is an item (object). It belongs to the logicfn category within the system area.
Action Syntax
is-item $variableReturn Value
This function returns a
$result = is-item Valid sizes
Examples
// Basic Usage
$boolean = is-item $varnameis-less-than
The is-less-than action checks if a value is less than another value. It belongs to the logicfn category within the system area.
Action Syntax
is-less-than $variable $variableis-less-than $variable 123is-less-than $variable "text"Return Value
This function returns a
is-number
The is-number action checks to see if value is a number. It belongs to the logicfn category within the system area.
Action Syntax
is-number $variableReturn Value
This function returns a
$result = is-number Valid sizes
Examples
// Basic Usage
$boolean = is-number $varnameis-time
The is-time action checks if a value is in time format (hh:mm). It belongs to the logicfn category within the system area.
Action Syntax
is-time $variableReturn Value
This function returns a
$result = is-time Valid sizes
Examples
// Basic Usage
$boolean = is-time $varnameis-valid-email
The is-valid-email action checks if value is a valid email. It belongs to the validate category within the ui area.
Action Syntax
is-valid-email $variableis-valid-email "text"Return Value
This function returns a
$result = is-valid-email Valid sizes
Examples
// Basic Usage
$boolean = is-valid-email $varnameis-valid-phone
The is-valid-phone action checks if value is a valid phone. It belongs to the validate category within the ui area.
Action Syntax
is-valid-phone $variableis-valid-phone "text"Return Value
This function returns a
$result = is-valid-phone Valid sizes
Examples
// Basic Usage
$boolean = is-valid-phone $varnamekey
The key action global app key shortcut handler. It belongs to the keys category within the ui area.
Action Syntax
key deletekey escapeValid sizes
Examples
// Basic Usage
key deletelast-row
The last-row action Gets the last row of a table or group. It belongs to the row category within the data area.
Action Syntax
last-row of $variablelast-row $variableReturn Value
This function returns a
$result = last-row Valid sizes
Examples
// Basic Usage
$item = last-row of $GgroupRelated Actions
- `` -
launch-module
The launch-module action launches a loaded module. It belongs to the modules category within the platform area.
Action Syntax
launch-module @referenceValid sizes
Examples
// Basic Usage
launch-module @modulenameleft-key
The left-key action left arrow key. It belongs to the keys category within the ui area.
Action Syntax
left-key [file]left-key goto [file]left-key run [file]left-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
left-key [block]length-of
The length-of action Returns the length of a text string or variable. It belongs to the text category within the ui area.
Action Syntax
length-of $variablelength-of "text"Return Value
This function returns a
$result = length-of Valid sizes
Examples
// Basic Usage
$number = length-of $varWork with linkedin
Overview
The linkedin action is part of the social set in Rhyme. Work with linkedin.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
linkedin "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
linkedin "Example usage"Example 2: With Variables
$my-variable: "some value"
linkedin $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
list-actions
The list-actions action gets a full list of rhappsody actions. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-actions Valid sizes
Tags
set
filter by set
area
filter by area
Examples
// Basic Usage
list-actionslist-actionsets
The list-actionsets action returns a complete list of action sets. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-actionsets Valid sizes
Examples
// Basic Usage
list-actionsetslist-app-data
The list-app-data action list app data (private). It belongs to the data category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-app-data Valid sizes
Examples
// Basic Usage
list-app-datalist-app-images
The list-app-images action lists the current Rhappsody app images. It belongs to the images category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-app-images Valid sizes
Examples
// Basic Usage
list-app-imageslist-appgroups
The list-appgroups action list account app groups. It belongs to the account category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-appgroups Valid sizes
Examples
// Basic Usage
list-appgroupslist-apps
The list-apps action list all apps for the account. It belongs to the account category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-apps Valid sizes
Examples
// Basic Usage
list-appslist-areas
The list-areas action returns a list of action areas. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-areas Valid sizes
Examples
// Basic Usage
list-areaslist-color-palettes
The list-color-palettes action lists color palette names. It belongs to the color category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-color-palettes Valid sizes
Examples
// Basic Usage
list-color-paletteslist-colors
The list-colors action returns a list of rhappsody colors. It belongs to the color category within the ui area.
Action Syntax
list-colors "text"Return Value
This function returns a
$result = list-colors Valid sizes
Examples
// Basic Usage
$group = list-colors "base"list-compilers
The list-compilers action lists cached compilers. It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-compilers Valid sizes
Examples
// Basic Usage
list-compilerslist-dynamic-actions
The list-dynamic-actions action lists the names of dynamic-actions. It belongs to the actions category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
list-dynamic-actionslist-fonts
The list-fonts action Gets a list of all fonts currently loaded in your app. It belongs to the fonts category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-fonts Valid sizes
Examples
// Basic Usage
list-fontslist-icons
The list-icons action lists the icons stored and available for offline use. It belongs to the icons category within the ui area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-icons Valid sizes
Examples
// Basic Usage
list-iconslist-images
The list-images action lists images saved in IDB using the set-image action. It belongs to the images category within the ui area.
Action Syntax
list-images $variableReturn Value
This function returns a
$result = list-images Valid sizes
Examples
// Basic Usage
list-images $Limageslist-inbox
The list-inbox action lists the current apps inbox contents. It belongs to the inbox category within the external area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-inbox Valid sizes
Examples
// Basic Usage
list-inboxlist-public-app-data
The list-public-app-data action list app data (public). It belongs to the data category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-public-app-data Valid sizes
Examples
// Basic Usage
list-public-app-datalist-public-user-data
The list-public-user-data action lists user data (public). It belongs to the users category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-public-user-data Valid sizes
Examples
// Basic Usage
list-public-user-datalist-recipes
The list-recipes action lists available recipes. It belongs to the recipes category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-recipes Valid sizes
Examples
// Basic Usage
list-recipeslist-saved
The list-saved action lists all previously saves variables. It belongs to the localstorage category within the storage area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-saved Valid sizes
Examples
// Basic Usage
list-savedlist-secrets
The list-secrets action lists all secrets for the current app. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-secrets Valid sizes
Examples
// Basic Usage
list-secretslist-user-data
The list-user-data action lists user data (private). It belongs to the users category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-user-data Valid sizes
Examples
// Basic Usage
list-user-datalist-videos
The list-videos action lists videos saved in IDB using the set-image action. It belongs to the video category within the media area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-videos Valid sizes
Examples
// Basic Usage
list-videosload
The load action loads a saved variable on local device. It belongs to the localstorage category within the storage area.
Action Syntax
load $variableload $variable into $variableValid sizes
Examples
// Basic Usage
load $varnameload-app
The load-app action loads an app record from the db. It belongs to the appdev category within the platform area.
Action Syntax
load-app @referenceload-app $variableReturn Value
This function returns a
$result = load-app Valid sizes
Examples
// Basic Usage
$item = load-app @apptagload-app-data
The load-app-data action loads app data (private). It belongs to the data category within the data area.
Action Syntax
load-app-data $variableReturn Value
This function returns a
$result = load-app-data Valid sizes
Examples
// Basic Usage
$varrec = load-app-data $varnameload-audio
The load-audio action Loads an audio file into memory for later playback. It belongs to the audio category within the media area.
Action Syntax
load-audio ~sound https://...load-audio ~sound $variableValid sizes
Examples
// Basic Usage
load-audio ~song https://example.com/song.mp3// Using Variables
// Display dynamic content from variables
load-audio ~song $url-variableload-binary-file
The load-binary-file action Loads binary data from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-binary-file https://...load-binary-file $variableReturn Value
This function returns a
$result = load-binary-file Valid sizes
Examples
// Basic Usage
$varrec = load-binary-file https://someurlload-compiler
The load-compiler action loads WASM compiler binary. It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = load-compiler Valid sizes
Tags
version
specifies version. default is latest. can be beta, dev, local, or specific number
load-json-file
The load-json-file action Loads JSON data from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-json-file https://...load-json-file $variableReturn Value
This function returns a
$result = load-json-file Valid sizes
Examples
// Basic Usage
$varrec = load-json-file https://someurlload-public-app-data
The load-public-app-data action loads app data (public). It belongs to the data category within the data area.
Action Syntax
load-public-app-data $variableReturn Value
This function returns a
$result = load-public-app-data Valid sizes
Examples
// Basic Usage
$varrec = load-public-app-data $varnameload-public-user-data
The load-public-user-data action loads user data (public). It belongs to the users category within the system area.
Action Syntax
load-public-user-data $variableReturn Value
This function returns a
$result = load-public-user-data Valid sizes
Examples
// Basic Usage
$varrec = load-public-user-data $varnameload-saved
The load-saved action loads all previously saves variables. It belongs to the localstorage category within the storage area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = load-saved Valid sizes
Examples
// Basic Usage
load-savedload-source
The load-source action loads app source code. It belongs to the appdev category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = load-source Valid sizes
Examples
// Basic Usage
load-sourceload-text-file
The load-text-file action Loads text content from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-text-file https://...load-text-file $variableReturn Value
This function returns a
$result = load-text-file Valid sizes
Examples
// Basic Usage
$varrec = load-text-file https://someurlload-user-data
The load-user-data action loads user data (private). It belongs to the users category within the system area.
Action Syntax
load-user-data $variableReturn Value
This function returns a
$result = load-user-data Valid sizes
Examples
// Basic Usage
$varrec = load-user-data $varnamelogic
The logic action logic operations. It belongs to the logic category within the system area.
Action Syntax
logic $variable and $variablelogic $variable or $variablelogic $variable xor $variableReturn Value
This function returns a
loop
The loop action loop over a variable. It belongs to the loops category within the control area.
Action Syntax
loop 123 timesloop $variable timesValid sizes
Examples
// Basic Usage
loop 10 times// Using Variables
// Display dynamic content from variables
loop $number timeslowercase
The lowercase action Converts text to all lowercase letters. It belongs to the text category within the ui area.
Action Syntax
lowercase "text"lowercase $variableReturn Value
This function returns a
$result = lowercase Valid sizes
Examples
// Basic Usage
$text = lowercase "REALLY IMPORTANT"manager-login
The manager-login action manager-login. It belongs to the auth category within the external area.
Action Syntax
manager-login @reference $variablemanager-login $variable $variableReturn Value
This function returns a
$result = manager-login Valid sizes
Examples
// Basic Usage
$item = manager-login @name $passcodemax
The max action Finds the maximum value from a set of numbers in an array. It belongs to the math category within the data area.
Action Syntax
max $variableReturn Value
This function returns a
$result = max Examples
// Basic Usage
max $arraymissing
The missing action logic fn to test for missing variable. It belongs to the logicfn category within the system area.
Action Syntax
missing $variableReturn Value
This function returns a
$result = missing Valid sizes
Examples
// Basic Usage
$boolean = missing $varnamemodulo
The modulo action calculate the modulo (remainder) of a division. It belongs to the math category within the data area.
Action Syntax
modulo $variable by $variablemodulo $variable by 123Return Value
This function returns a
month-names
The month-names action gets the localized month names. It belongs to the datetime category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = month-names Valid sizes
Examples
// Basic Usage
$mn = month-namesmultiply
The multiply action multiply value. It belongs to the math category within the data area.
Action Syntax
multiply $variable by $variablemultiply $variable by 123Return Value
This function returns a
my-approups
The my-approups action lists your rhappsody account app groups. It belongs to the appgroup category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = my-approups Valid sizes
Examples
// Basic Usage
my-approupsnew-app
The new-app action creates a new app (source). It belongs to the appdev category within the platform area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = new-app Valid sizes
Tags
mobile
scaffold for a mobile app
Examples
// Basic Usage
new-appnew-appgroup
The new-appgroup action adds a new app group to your account. It belongs to the appgroup category within the platform area.
Action Syntax
new-appgroup $variablenew-appgroup "text"Return Value
This function returns a
$result = new-appgroup Valid sizes
Examples
// Basic Usage
$response = new-appgroup $namenew-profile
The new-profile action Creates a fresh profile with default values, replacing any existing data. It belongs to the profile category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
new-profilenoop
The noop action does nothing. just a placeholder action. It belongs to the debug category within the dev area.
Action Syntax
noopThis action takes no parameters and is used as a bare command.
Description: just does nothing
Examples
// Basic Usage
noopnot
The not action a negation action for logic statements like if and when. It belongs to the logic category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
notnot-equals
The not-equals action not equals. It belongs to the logicfn category within the system area.
Action Syntax
not-equals 123not-equals "text"not-equals $variablenot-equals true|falseReturn Value
This function returns a
$result = not-equals Valid sizes
Examples
// Basic Usage
$boolean = not-equals 10on-incoming-chat-message
The on-incoming-chat-message action event handler for incoming chat message. It belongs to the chat category within the platform area.
Action Syntax
on-incoming-chat-message [file]Valid sizes
Examples
// Basic Usage
on-incoming-chat-message [blocktorun]on-notification
The on-notification action event handler for notifications. It belongs to the notifications category within the interaction area.
Action Syntax
on-notification $variableon-notification @referenceon-notification $variable [file]on-notification @reference [file]Valid sizes
Examples
// Basic Usage
on-notification $channelopen-browser
The open-browser action opens a browser with specified URL. It belongs to the browser category within the ui area.
Action Syntax
open-browser https://...open-browser $variableTags
new-window
opens in a new window (default is tab)
Examples
// Basic Usage
open-browser https://myurl// Using Variables
// Display dynamic content from variables
open-browser $urlwithvariableopen-browser-window
The open-browser-window action opens a new browser window. It belongs to the browser category within the ui area.
Action Syntax
open-browser-window https://...open-browser-window $variableValid sizes
Examples
// Basic Usage
open-browser-window https://myurl// Using Variables
// Display dynamic content from variables
open-browser-window $urlwithvariableopen-menu
The open-menu action opens a menu. It belongs to the menus category within the ui area.
Action Syntax
open-menu EValid sizes
Examples
// Basic Usage
open-menu *fooopenai-chat
The openai-chat action sends message to OpenAI. It belongs to the openai category within the plugins area.
Action Syntax
openai-chat "text"openai-chat $variableReturn Value
This function returns a
$result = openai-chat Valid sizes
Tags
full
returns a full response including all details
model
specifies the model name to use
pause-audio
The pause-audio action Pauses any currently playing audio. It belongs to the audio category within the media area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
pause-audioperson
The person action person, member, user, employee. It belongs to the resources category within the external area.
Action Syntax
person "text"Valid sizes
Tags
email
phone
Examples
// Basic Usage
person "name"pick-random
The pick-random action Selects a random item from a group of options. It belongs to the random category within the numbers area.
Action Syntax
pick-random $variablepick-random from $variableValid sizes
Examples
// Basic Usage
$any = pick-random $group-varplay-audio
The play-audio action Plays a previously loaded audio file. It belongs to the audio category within the media area.
Action Syntax
play-audio ~soundValid sizes
Examples
// Basic Usage
play-audio ~songThe print action print text to ui for app development and testing. It belongs to the utils category within the undefined area.
Action Syntax
print "text"print $variableExamples
// Basic Usage
print "debug output here"// Using Variables
// Display dynamic content from variables
print $outputtextprint-error
The print-error action prints inline error message. It belongs to the print category within the dev area.
Action Syntax
print-error "text"print-error $variableValid sizes
Examples
// Basic Usage
print-error "message"// Using Variables
// Display dynamic content from variables
print-error $messageprint-header
The print-header action Prints bold header text for debugging and testing. It belongs to the print category within the dev area.
Action Syntax
print-header "text"print-header $variableValid sizes
Examples
// Basic Usage
print-header "debug output here"// Using Variables
// Display dynamic content from variables
print-header $output-textprofile
The profile action defines an app user’s profile record data. It belongs to the profile category within the data area.
Action Syntax
profile $variable "text"profile $variable "text" "text"profile $variable "text" 123profile $variable "text" true|falseprofile $variable "text" $variableprofile $variable "text" YYYY-MM-DDprofile $variable "text" +imagetagprofile $variable "text" #colorValid sizes
Tags
email
email value
protect-with-password
The protect-with-password action protect app with basic password. It belongs to the auth category within the external area.
Action Syntax
protect-with-password 123protect-with-password "text"Valid sizes
Examples
// Basic Usage
protect-with-password 1234proxy
The proxy action sets proxy mode. It belongs to the http category within the network area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
proxypublish-bin
The publish-bin action publishes binary to regional public R2. It belongs to the publish category within the appdev area.
Action Syntax
publish-bin $variableReturn Value
This function returns a
$result = publish-bin Valid sizes
Examples
// Basic Usage
$response = publish-bin $binpublish-html
The publish-html action publishes launch html to regional public R2. It belongs to the publish category within the appdev area.
Action Syntax
publish-html $variableReturn Value
This function returns a
$result = publish-html Valid sizes
Examples
// Basic Usage
$response = publish-html $binpublish-private
The publish-private action publishes binary to regional private R2. It belongs to the publish category within the appdev area.
Action Syntax
publish-private "text" $variableReturn Value
This function returns a
$result = publish-private Valid sizes
Examples
// Basic Usage
$response = publish-private "name" $varnamerandom-between
The random-between action generates a random integer between two numbers. It belongs to the random category within the numbers area.
Action Syntax
random-between 123 and 123random-between $variable and 123random-between 123 and $variablerandom-between $variable and $variableReturn Value
This function returns a
random-dice-roll
The random-dice-roll action generate a random dice roll from a text D&D style spec like “3d6” or “1d20 + 4”. It belongs to the random category within the numbers area.
Action Syntax
random-dice-roll "text"random-dice-roll $variableReturn Value
This function returns a
$result = random-dice-roll Valid sizes
Examples
// Basic Usage
$NUMBER = random-dice-roll "3d6"random-digits
The random-digits action generate a string of random digits with the specified length. Default length is 6. It belongs to the random category within the numbers area.
Action Syntax
random-digits length 123random-digits length $variableReturn Value
This function returns a
$result = random-digits Valid sizes
Examples
// Basic Usage
$text = random-digits length 10random-row
The random-row action gets a random row from a table of data. It belongs to the row category within the data area.
Action Syntax
random-row of $variableReturn Value
This function returns a
$result = random-row Valid sizes
Examples
// Basic Usage
$item = random-row of $tablerandom-text
The random-text action Creates random text with letters and numbers for passwords or tokens. It belongs to the random category within the numbers area.
Action Syntax
random-text !set:iconrandom-text length 123random-text length $variableReturn Value
This function returns a
random-uuid
The random-uuid action generate a random uuidv4. It belongs to the random category within the numbers area.
Action Syntax
random-uuidThis action takes no parameters and is used as a bare command.
Return Value
This function returns a
$result = random-uuid Valid sizes
Examples
// Basic Usage
random-uuidregister-actionset
The register-actionset action registers/loads a remote actionset. It belongs to the actions category within the system area.
Action Syntax
register-actionset https://...Return Value
This function returns a
$result = register-actionset Valid sizes
Examples
// Basic Usage
$response = register-actionset https://actionsetreporeload
The reload action reloads/refreshes browser window. Restarts app from scratch. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
reloadremember
The remember action a modifier that forces a read once cache/consulation of a value before a call to the network. It belongs to the variables category within the external area.
Action Syntax
rememberThis action takes no parameters and is used as a bare command.
Examples
// Basic Usage
rememberremove-secret
The remove-secret action removes a secret for an app. It belongs to the secrets category within the system area.
Action Syntax
remove-secret 123remove-secret $variableReturn Value
This function returns a
$result = remove-secret Valid sizes
Examples
// Basic Usage
$item = remove-secret 12render-recipe
The render-recipe action renders an app using a recipe. It belongs to the recipes category within the platform area.
Action Syntax
render-recipe $variable with $variableReturn Value
This function returns a
$result = render-recipe Valid sizes
Examples
// Basic Usage
$text = render-recipe $recipevar with $argsrepeat
The repeat action repeat an action or group of actions multiple times. It belongs to the flow category within the system area.
Action Syntax
repeat 123 timesrepeat $variable timesTags
index-name
use this name as the index variable. Default is $index
Examples
// Basic Usage
repeat 10 times// Using Variables
// Display dynamic content from variables
repeat $foo timesresend-send-email
The resend-send-email action sends an email using resend. It belongs to the resend category within the plugins area.
Action Syntax
resend-send-email in 30mresend-send-email true|false YYYY-MM-DDReturn Value
This function returns a
$result = resend-send-email Valid sizes
Examples
// Basic Usage
$response = resend-send-email in 3dreset-client
The reset-client action resets the client. Note: this will clear all associated profile information. It belongs to the client category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
reset-clientresize-image
The resize-image action resizes an image. It belongs to the images category within the ui area.
Action Syntax
resize-image $variable width 123resize-image $variable width 123 height 123Return Value
This function returns a
restore-profile
The restore-profile action Loads your saved profile data or creates a new one if needed. It belongs to the profile category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
restore-profileresume
The resume action resumes as flow (after wait/break/pause). It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
resumereturn
The return action return values. It belongs to the exec category within the system area.
Action Syntax
return $variablereturn "text"return 123return true|falsereturn ITValid sizes
Examples
// Basic Usage
return $varnameright-key
The right-key action right arrow key. It belongs to the keys category within the ui area.
Action Syntax
right-key [file]right-key goto [file]right-key run [file]right-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
right-key [block]round
The round action rounds a number to a specified number of decimals. It belongs to the math category within the data area.
Action Syntax
round $variableReturn Value
This function returns a
$result = round Valid sizes
Tags
digits
number of decimals to round to
Examples
// Basic Usage
$number = round $varround-down
The round-down action rounds a number down to nearest integer. It belongs to the math category within the data area.
Action Syntax
round-down $variableround-down 123Return Value
This function returns a
$result = round-down Valid sizes
Examples
// Basic Usage
$number = round-down $numberround-up
The round-up action rounds a number up to nearest integer. It belongs to the math category within the data area.
Action Syntax
round-up $variableround-up 123Return Value
This function returns a
$result = round-up Valid sizes
Examples
// Basic Usage
$number = round-up $numberrun
The run action runs a block one time. It belongs to the exec category within the system area.
Action Syntax
run [file]run $variableValid sizes
Examples
// Basic Usage
run [block]// Using Variables
// Display dynamic content from variables
run $blockvarsave
The save action saves a variable to local device. It belongs to the localstorage category within the storage area.
Action Syntax
save $variableValid sizes
Examples
// Basic Usage
save $varnamesave-app-data
The save-app-data action saves app data (private). It belongs to the data category within the data area.
Action Syntax
save-app-data $variablesave-app-data $variable as $variableReturn Value
This function returns a
$result = save-app-data Valid sizes
Examples
// Basic Usage
$response = save-app-data $varnamesave-app-image
The save-app-image action saves an app image. It belongs to the images category within the ui area.
Action Syntax
save-app-image +imagetag $variablesave-app-image +imagetag https://...Return Value
This function returns a
$result = save-app-image Valid sizes
Examples
// Basic Usage
$response = save-app-image %savetag $imagedatasave-public-app-data
The save-public-app-data action saves app data (public). It belongs to the data category within the data area.
Action Syntax
save-public-app-data $variablesave-public-app-data $variable as $variableReturn Value
This function returns a
$result = save-public-app-data Valid sizes
Examples
// Basic Usage
$response = save-public-app-data $varnamesave-public-user-data
The save-public-user-data action saves user data (public). It belongs to the users category within the system area.
Action Syntax
save-public-user-data $variablesave-public-user-data $variable as $variableReturn Value
This function returns a
$result = save-public-user-data Valid sizes
Examples
// Basic Usage
$response = save-public-user-data $varnamesave-source
The save-source action saves current app source code. It belongs to the source category within the appdev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = save-source Valid sizes
Examples
// Basic Usage
save-sourcesave-user-data
The save-user-data action saves user data (private). It belongs to the users category within the system area.
Action Syntax
save-user-data $variablesave-user-data $variable as $variableReturn Value
This function returns a
$result = save-user-data Valid sizes
Examples
// Basic Usage
$response = save-user-data $varnamesay
The say action use the browser text to speech. It belongs to the speech category within the voice area.
Action Syntax
say "text"say $variableExamples
// Basic Usage
say "text"// Using Variables
// Display dynamic content from variables
say $speechtextschedule
The schedule action Creates and manages business schedules with hours and dates. It belongs to the calendar category within the interaction area.
Action Syntax
schedule "text"schedule 123 HH:MM HH:MMschedule 123 HH:MM HH:MM "text"schedule 123 HH:MM "text"schedule YYYY-MM-DD "text"schedule YYYY-MM-DD YYYY-MM-DD "text"Valid sizes
Tags
closed
sets date as closed
secret
The secret action define secret value. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
secretsend-email
The send-email action sends an email. It belongs to the email category within the external area.
Action Syntax
send-emailThis action takes no parameters and is used as a bare command.
Return Value
This function returns a
$result = send-email Valid sizes
Examples
// Basic Usage
send-emailUsage Guide
Before using send-email, you must configure the email using these actions:
send-notification
The send-notification action low level send notification. It belongs to the notifications category within the interaction area.
Action Syntax
send-notification "text"send-notification $variableReturn Value
This function returns a
$result = send-notification Valid sizes
Tags
channel
the channel to send notification on
Examples
// Basic Usage
$response = send-notification "message"send-to-inbox
The send-to-inbox action sends message to inbox. It belongs to the inbox category within the external area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = send-to-inbox Valid sizes
Examples
// Basic Usage
send-to-inboxserver-run
The server-run action runs specified block on server/remote. It belongs to the exec category within the system area.
Action Syntax
server-run [file]Return Value
This function returns a
$result = server-run Valid sizes
Examples
// Basic Usage
$response = server-run [record-order]set
The set action explicit set of a variable. It belongs to the variables category within the external area.
Action Syntax
set $variable "text"set $variable 123set $variable [file]set $variable HH:MMset $variable true|falseset $variable YYYY-MM-DDset $variable 30mset $variable $variableset $variable ITValid sizes
Tags
temp
marks the value as a temp variable
set-active-schedule
The set-active-schedule action Switches to a different schedule by name. It belongs to the calendar category within the interaction area.
Action Syntax
set-active-schedule "text"Return Value
This function returns a
$result = set-active-schedule Valid sizes
Examples
// Basic Usage
$text = set-active-schedule "My Schedule"set-ai-service
The set-ai-service action sets the apps AI service provider. It belongs to the ai category within the external area.
Action Syntax
set-ai-service groqset-ai-service openaiset-ai-service anthropicValid sizes
Examples
// Basic Usage
set-ai-service groqset-animation
The set-animation action sets/defines an animation tag. It belongs to the animation category within the ui area.
Action Syntax
set-animation +imagetag https://...set-animation +imagetag +imagetagValid sizes
Tags
save
persists the animation in local storage. Use for static animations
set-announcement
The set-announcement action sets an app wide banner announcement. It belongs to the announcements category within the interaction area.
Action Syntax
set-announcement "text"set-announcement $variableset-announcement blkReturn Value
This function returns a
$result = set-announcement Valid sizes
Examples
// Basic Usage
$response = set-announcement "text"set-app-bin
The set-app-bin action sets the app binary manually (RHDEV.bin). It belongs to the appdev category within the platform area.
Action Syntax
set-app-bin $variableValid sizes
Examples
// Basic Usage
set-app-bin $varnameset-app-source
The set-app-source action sets the app source. This replaces the current source. Be careful!. It belongs to the source category within the appdev area.
Action Syntax
set-app-source $variableValid sizes
Examples
// Basic Usage
set-app-source $sourceset-app-title
The set-app-title action sets the app title string. It belongs to the config category within the system area.
Action Syntax
set-app-title "text"Valid sizes
Examples
// Basic Usage
set-app-title "title"set-brand-color
The set-brand-color action sets the brand color. It belongs to the color category within the ui area.
Action Syntax
set-brand-color #colorValid sizes
Examples
// Basic Usage
set-brand-color #brandcolorset-build-mode
The set-build-mode action sets build mode. It belongs to the appdev category within the platform area.
Action Syntax
set-build-mode true|falseValid sizes
Examples
// Basic Usage
set-build-mode trueset-css-variable
The set-css-variable action sets a CSS variable. It belongs to the advanced category within the undefined area.
Action Syntax
set-css-variable $variable "text" // sets Rhappsody CSS variableset-css-variable $variable $variable // sets variable to other variable ValueExamples
// Basic Usage
set-css-variable $cssvarname "value" // sets Rhappsody CSS variableset-debug-ui
The set-debug-ui action sets UI debug mode. It belongs to the config category within the system area.
Action Syntax
set-debug-ui true|falseValid sizes
Examples
// Basic Usage
set-debug-ui trueset-default
The set-default action sets a default value for a variable if it does not already exist. It belongs to the variables category within the external area.
Action Syntax
set-default $variable "text"set-default $variable 123set-default $variable [file]set-default $variable HH:MMset-default $variable YYYY-MM-DDset-default $variable 30mset-default $variable $variableset-default $variable ITValid sizes
Examples
// Basic Usage
set-default $var "text value"set-default-font
The set-default-font action Makes a previously loaded font the default for your app. It belongs to the fonts category within the ui area.
Action Syntax
set-default-font %fontValid sizes
Examples
// Basic Usage
set-default-font ^font-tagset-dev-mode
The set-dev-mode action sets dev mode. It belongs to the platform category within the system area.
Action Syntax
set-dev-mode true|falseValid sizes
Examples
// Basic Usage
set-dev-mode trueset-email-bcc
The set-email-bcc action sets the email bcc field. It belongs to the email category within the external area.
Action Syntax
set-email-bcc "text"set-email-bcc $variableValid sizes
Examples
// Basic Usage
set-email-bcc "bcc"// Using Variables
// Display dynamic content from variables
set-email-bcc $bccset-email-body
The set-email-body action sets the email body field. It belongs to the email category within the external area.
Action Syntax
set-email-body "text"set-email-body blkset-email-body $variableValid sizes
Examples
// Basic Usage
set-email-body "body"// Using Variables
// Display dynamic content from variables
set-email-body $bodyset-email-cc
The set-email-cc action sets the email cc field. It belongs to the email category within the external area.
Action Syntax
set-email-cc "text"set-email-cc $variableValid sizes
Examples
// Basic Usage
set-email-cc "cc"// Using Variables
// Display dynamic content from variables
set-email-cc $ccset-email-from
The set-email-from action sets the email from field. It belongs to the email category within the external area.
Action Syntax
set-email-from "text"set-email-from $variableValid sizes
Examples
// Basic Usage
set-email-from "from"// Using Variables
// Display dynamic content from variables
set-email-from $fromset-email-service
The set-email-service action sets the email service the app will use. It belongs to the email category within the external area.
Action Syntax
set-email-service rhappsodyset-email-service resendValid sizes
Examples
// Basic Usage
set-email-service rhappsodyset-email-subject
The set-email-subject action sets the email subject field. It belongs to the email category within the external area.
Action Syntax
set-email-subject "text"set-email-subject $variableValid sizes
Examples
// Basic Usage
set-email-subject "sub"// Using Variables
// Display dynamic content from variables
set-email-subject $subjectset-email-to
The set-email-to action sets the email to field. It belongs to the email category within the external area.
Action Syntax
set-email-to "text"set-email-to $variableValid sizes
Examples
// Basic Usage
set-email-to "to"// Using Variables
// Display dynamic content from variables
set-email-to $toset-groq-api-key
The set-groq-api-key action Stores your Groq API key for AI chat features. It belongs to the groq category within the plugins area.
Action Syntax
set-groq-api-key "text"Valid sizes
Examples
// Basic Usage
set-groq-api-key "value"set-http-body
The set-http-body action sets HTTP request body. It belongs to the network category within the external area.
Action Syntax
set-http-body ITset-http-body $variableValid sizes
Examples
// Basic Usage
set-http-body {item}// Using Variables
// Display dynamic content from variables
set-http-body $variableset-http-header
The set-http-header action Sets a custom header for HTTP requests. It belongs to the http category within the network area.
Action Syntax
set-http-header "text" "text"set-http-header "text" $variableset-http-header $variable $variableValid sizes
Examples
// Basic Usage
set-http-header "name" "value"// Using Variables
// Display dynamic content from variables
set-http-header "name" $value-varset-http-timeout
The set-http-timeout action sets the timeout for the http-* actions. It belongs to the http category within the network area.
Action Syntax
set-http-timeout 30mValid sizes
Examples
// Basic Usage
set-http-timeout 10mset-iconset
The set-iconset action sets the default iconset. It belongs to the icons category within the ui area.
Action Syntax
set-iconset !set:iconset-iconset $variableExamples
// Basic Usage
set-iconset !mdi// Using Variables
// Display dynamic content from variables
set-iconset $iconsetset-image
The set-image action sets/defines an image tag. It belongs to the images category within the ui area.
Action Syntax
set-image +imagetag https://...set-image +imagetag +imagetagValid sizes
Tags
save
persists the image in local storage. Use for static images
set-language
The set-language action sets the default app language. It belongs to the language category within the media area.
Action Syntax
set-language arabicset-language germanset-language englishset-language spanishset-language frenchset-language italianset-language japaneseset-language koreanset-language portugueseset-language russianset-language mandarinset-language greekset-language hebrewset-language hindiset-language $variableValid sizes
Examples
// Basic Usage
set-language arabic// Using Variables
// Display dynamic content from variables
set-language $langset-message-body
The set-message-body action sets the message body field. It belongs to the inbox category within the external area.
Action Syntax
set-message-body "text"set-message-body $variableValid sizes
Examples
// Basic Usage
set-message-body "body"// Using Variables
// Display dynamic content from variables
set-message-body $bodyset-message-from
The set-message-from action sets the message from field. It belongs to the inbox category within the external area.
Action Syntax
set-message-from "text"set-message-from $variableValid sizes
Examples
// Basic Usage
set-message-from "from"// Using Variables
// Display dynamic content from variables
set-message-from $fromset-message-subject
The set-message-subject action sets the message subject field. It belongs to the inbox category within the external area.
Action Syntax
set-message-subject "text"set-message-subject $variableValid sizes
Examples
// Basic Usage
set-message-subject "sub"// Using Variables
// Display dynamic content from variables
set-message-subject $subjectset-mock-mode
The set-mock-mode action sets mock mode. It belongs to the platform category within the system area.
Action Syntax
set-mock-mode true|falseValid sizes
Examples
// Basic Usage
set-mock-mode trueset-private-key
The set-private-key action sets app private key. It belongs to the appauth category within the system area.
Action Syntax
set-private-key "text"Valid sizes
Examples
// Basic Usage
set-private-key "rh_private_appkey"set-public-key
The set-public-key action sets public key. Required for secrets and users support. It belongs to the appauth category within the system area.
Action Syntax
set-public-key "text"Valid sizes
Examples
// Basic Usage
set-public-key "publickey"set-resend-api-key
The set-resend-api-key action sets the RESEND email plugin API key. It belongs to the resend category within the plugins area.
Action Syntax
set-resend-api-key "text"Valid sizes
Examples
// Basic Usage
set-resend-api-key "value"set-secret
The set-secret action sets a secret key for the current app. It belongs to the secrets category within the system area.
Action Syntax
set-secret $variable "text"Valid sizes
Examples
// Basic Usage
set-secret $openapikey "ffff"set-sound
The set-sound action defines an app sound. It belongs to the sounds category within the media area.
Action Syntax
set-sound ~sound to https://...set-sound ~sound to ~soundExamples
// Basic Usage
set-sound ~beep to https://soundfileset-start-block
The set-start-block action Defines which block your app starts running from. It belongs to the flow category within the system area.
Action Syntax
set-start-block [file]Valid sizes
Examples
// Basic Usage
set-start-block [block]set-target-ag
The set-target-ag action sets the target app group. It belongs to the appdev category within the platform area.
Action Syntax
set-target-ag $variableset-target-ag @referenceValid sizes
Examples
// Basic Usage
set-target-ag $agset-target-aid
The set-target-aid action sets the target or working app id. It belongs to the appdev category within the platform area.
Action Syntax
set-target-aid $variableset-target-aid "text"Valid sizes
Examples
// Basic Usage
set-target-aid $aidset-video
The set-video action sets/defines a video tag. It belongs to the video category within the media area.
Action Syntax
set-video +imagetag https://...set-video +imagetag +imagetagValid sizes
Tags
save
persists the video in local storage. Use for videos which to do not change often
set-voice
The set-voice action sets the voice for the say command. It belongs to the speech category within the voice area.
Action Syntax
set-voice "text"set-voice $variableExamples
// Basic Usage
set-voice "michael"// Using Variables
// Display dynamic content from variables
set-voice $voicenameset-voice-language
The set-voice-language action sets the voice language. It belongs to the speech category within the voice area.
Action Syntax
set-voice-language "text"set-voice-language $variableExamples
// Basic Usage
set-voice-language "En"// Using Variables
// Display dynamic content from variables
set-voice-language $valueshield
The shield action converts value to a shielded (secure, encrypted) value. It belongs to the server category within the platform area.
Action Syntax
shield $variableReturn Value
This function returns a
$result = shield Valid sizes
Examples
// Basic Usage
$item = shield $anyshow
The show action shows a hidden ui element. It belongs to the layout category within the ui area.
Action Syntax
show EValid sizes
Examples
// Basic Usage
show *targetslide-down
The slide-down action slide down. It belongs to the navigation category within the interaction area.
Action Syntax
slide-down [file]Valid sizes
Examples
// Basic Usage
slide-down [block]slide-left
The slide-left action navigate to a block sliding left. It belongs to the navigation category within the interaction area.
Action Syntax
slide-left [file]Valid sizes
Examples
// Basic Usage
slide-left [block]slide-right
The slide-right action navigate to a block sliding right. It belongs to the navigation category within the interaction area.
Action Syntax
slide-right [file]Valid sizes
Examples
// Basic Usage
slide-right [block]slide-up
The slide-up action navigate to a block sliding right. It belongs to the navigation category within the interaction area.
Action Syntax
slide-up [file]Valid sizes
Examples
// Basic Usage
slide-up [block]slot
The slot action a slot, booking, meeting etc. It belongs to the resources category within the external area.
Action Syntax
slot HH:MMslot HH:MM "text"slot HH:MM HH:MMslot HH:MM HH:MM "text"Examples
// Basic Usage
slot 09:00sort-column
The sort-column action sorts a column of data. It belongs to the column category within the data area.
Action Syntax
sort-column $variableReturn Value
This function returns a
$result = sort-column Valid sizes
Examples
// Basic Usage
$group = sort-column $coldatasort-group
The sort-group action sorts a group. It belongs to the group category within the data area.
Action Syntax
sort-group $variableReturn Value
This function returns a
$result = sort-group Valid sizes
Tags
reverse
sort the group in reverse
Examples
// Basic Usage
$group = sort-group $Ggroupsort-table
The sort-table action sorts a table by a specify column name. It belongs to the table category within the ui area.
Action Syntax
sort-table $variable by "text"sort-table $variable by $variableReturn Value
This function returns a
source-block-list
The source-block-list action gets a list of blocks from the source. It belongs to the source category within the appdev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = source-block-list Valid sizes
Examples
// Basic Usage
source-block-listsource-delete-block
The source-delete-block action deletes a source block. It belongs to the source category within the appdev area.
Action Syntax
source-delete-block $variablesource-delete-block "text"Valid sizes
Examples
// Basic Usage
source-delete-block $namesource-get-block
The source-get-block action gets source block from blocks object. It belongs to the source category within the appdev area.
Action Syntax
source-get-block $variablesource-get-block "text"Return Value
This function returns a
$result = source-get-block Valid sizes
Examples
// Basic Usage
$text = source-get-block $namesource-join-blocks
The source-join-blocks action splits joins source blocks into a single source file. It belongs to the source category within the appdev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = source-join-blocks Valid sizes
Examples
// Basic Usage
source-join-blockssource-split-blocks
The source-split-blocks action splits single source file into blocks. It belongs to the source category within the appdev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = source-split-blocks Valid sizes
Examples
// Basic Usage
source-split-blockssource-update-block
The source-update-block action updates a block in a app block group object. It belongs to the source category within the appdev area.
Action Syntax
source-update-block $variablesource-update-block "text"Return Value
This function returns a
$result = source-update-block Valid sizes
Examples
// Basic Usage
$item = source-update-block $contentspace-between-lines
The space-between-lines action controls the space between lines. It belongs to the styling category within the ui area.
Action Syntax
space-between-lines 123space-between-lines nonespace-between-lines tinyspace-between-lines smallspace-between-lines largeValid sizes
Examples
// Basic Usage
space-between-lines 15space-key
The space-key action space key. It belongs to the keys category within the ui area.
Action Syntax
space-key [file]space-key goto [file]space-key run [file]space-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
space-key [block]spanish
The spanish action conditional spanish. It belongs to the language category within the media area.
Action Syntax
spanishThis action takes no parameters and is used as a bare command.
Valid sizes
Examples
// Basic Usage
spanishsplit-text
The split-text action Splits text into an array of words by whitespace. It belongs to the text category within the ui area.
Action Syntax
split-text "text"split-text $variableReturn Value
This function returns a
$result = split-text Valid sizes
Examples
// Basic Usage
$group = split-text "hello world welcome to rhappsody"stack
Work with stack
Overview
The stack action is part of the stacks set in Rhyme. Work with stack.
Category: Stacks
Area: 📐 Layout
Basic Usage
stack "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
stack "Example usage"Example 2: With Variables
$my-variable: "some value"
stack $my-variableTips
- This action is part of the stacks set
- Common use case: Arranging UI elements
Related Actions
Related actions from the stacks set will be listed here.
stop-audio
The stop-audio action Stops any currently playing audio. It belongs to the audio category within the media area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
stop-audiostore-profile
The store-profile action Saves your current profile data to device for future use. It belongs to the profile category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
store-profilestyle
The style action defined style for a .element. It belongs to the styling category within the ui area.
Action Syntax
style .elementValid sizes
Examples
// Basic Usage
style .elementsu-account
The su-account action retrieves the details of an account. It belongs to the platform category within the system area.
Action Syntax
su-account "text"Return Value
This function returns a
$result = su-account Valid sizes
Examples
// Basic Usage
$response = su-account "email"su-accounts
The su-accounts action returns a summary of all platform accounts. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
su-accountssu-platform
The su-platform action enables platform app. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
su-platformsubscribe
The subscribe action subscribe to app notification channel. It belongs to the notifications category within the interaction area.
Action Syntax
subscribe @referencesubscribe $variableReturn Value
This function returns a
$result = subscribe Valid sizes
Examples
// Basic Usage
$response = subscribe @channelsubtract
The subtract action subtracts a number from another number. It belongs to the math category within the data area.
Action Syntax
subtract subtractsubtract 123 from $variablesubtract $variable from $variableReturn Value
This function returns a
sync-time-to-server
The sync-time-to-server action syncs time from Interet server source. It belongs to the datetime category within the data area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = sync-time-to-server Valid sizes
Examples
// Basic Usage
sync-time-to-servertest
The test action test action. It belongs to the test category within the dev area.
Action Syntax
test 123 123Valid sizes
Examples
// Basic Usage
test 10 20test-owner-auth
The test-owner-auth action tests owner/sb authenticated action end to end. It belongs to the test category within the dev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = test-owner-auth Valid sizes
Examples
// Basic Usage
test-owner-authtest-server
The test-server action tests a server action. It belongs to the test category within the dev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = test-server Valid sizes
Examples
// Basic Usage
test-servertimer-start
The timer-start action a timer for low level debugging purposes. It belongs to the debug category within the dev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
timer-starttimer-stop
The timer-stop action a timer for low level debugging purposes. It belongs to the debug category within the dev area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = timer-stop Valid sizes
Examples
// Basic Usage
timer-stoptoggle-menu
The toggle-menu action toggles a menu open/close. It belongs to the menus category within the ui area.
Action Syntax
toggle-menu EValid sizes
Examples
// Basic Usage
toggle-menu *idtop-left
Work with top left
Overview
The top-left action is part of the stacks set in Rhyme. Work with top left.
Category: Stacks
Area: 📐 Layout
Basic Usage
top-left "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
top-left "Example usage"Example 2: With Variables
$my-variable: "some value"
top-left $my-variableTips
- This action is part of the stacks set
- Common use case: Arranging UI elements
Related Actions
Related actions from the stacks set will be listed here.
Work with twitter
Overview
The twitter action is part of the social set in Rhyme. Work with twitter.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
twitter "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
twitter "Example usage"Example 2: With Variables
$my-variable: "some value"
twitter $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.
typed-getters-example
example demonstrating typed getter patterns
Overview
The typed-getters-example action is part of the examples set in Rhyme. example demonstrating typed getter patterns. example demonstrating typed getter patterns
Category: Examples
Area: 🔧 Development & Testing
Basic Usage
typed-getters-example "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
typed-getters-example "Example usage"Example 2: With Variables
$my-variable: "some value"
typed-getters-example $my-variableTips
- This action is part of the examples set
- Common use case: Debugging your app
Related Actions
Related actions from the examples set will be listed here.
unpack-row
The unpack-row action unpacks the individual row values into seperate values. It belongs to the row category within the data area.
Action Syntax
unpack-row $variableValid sizes
Examples
// Basic Usage
unpack-row $Irowvarunshield
The unshield action unshield a shielded value. It belongs to the shield category within the system area.
Action Syntax
unshield $variableValid sizes
Examples
// Basic Usage
$any = unshield $valueunsubscribe
The unsubscribe action unsubscribes from notification channel. It belongs to the notifications category within the interaction area.
Action Syntax
unsubscribe @referenceunsubscribe $variableReturn Value
This function returns a
$result = unsubscribe Valid sizes
Examples
// Basic Usage
$response = unsubscribe @channelup-key
The up-key action up arrow key. It belongs to the keys category within the ui area.
Action Syntax
up-key [file]up-key goto [file]up-key run [file]up-key toggle-between [file] and [file]Valid sizes
Examples
// Basic Usage
up-key [block]upload-app-image
The upload-app-image action Uploads an image for use within your app interface. It belongs to the images category within the ui area.
Action Syntax
upload-app-image +imagetagReturn Value
This function returns a
$result = upload-app-image Valid sizes
Tags
ar
desired aspect ratio for the uploaded image
Examples
// Basic Usage
$response = upload-app-image %imagetaguppercase
The uppercase action Converts text to all uppercase letters. It belongs to the text category within the ui area.
Action Syntax
uppercase "text"uppercase $variableReturn Value
This function returns a
$result = uppercase Valid sizes
Examples
// Basic Usage
$text = uppercase "really important"use
The use action loads platform plugin or component and makes available for use. It belongs to the platform category within the system area.
Action Syntax
use "text"Valid sizes
Examples
// Basic Usage
use "plugin"use-modules
The use-modules action loads and makes available modules within the larger app. It belongs to the modules category within the platform area.
Action Syntax
use-modules @referenceuse-modules @reference @referenceuse-modules @reference @reference @referenceuse-modules @reference @reference @reference @referenceuse-modules @reference @reference @reference @reference @referenceReturn Value
This function returns a
user
The user action defines an app user. It belongs to the users category within the system area.
Action Syntax
user @reference 123user @reference 123 useruser @reference 123 adminuser @reference 123 manageruser @reference 123 editorValid sizes
Tags
public
makes the user name and role visible on client side app
user-data
The user-data action stub action for all server user data ACTIONS. It belongs to the users category within the system area.
Action Syntax
user-data $variableReturn Value
This function returns a
$result = user-data Valid sizes
Examples
// Basic Usage
$response = user-data $varnameuser-login
The user-login action user-login. It belongs to the auth category within the external area.
Action Syntax
user-login @reference $variableuser-login $variable $variableReturn Value
This function returns a
$result = user-login Valid sizes
Examples
// Basic Usage
$item = user-login @name $passcodevardump
The vardump action vardump action (triggered when we have $varname
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
vardumpvarref
The varref action this is just a demo action. It belongs to the variables category within the external area.
Action Syntax
varrefThis action takes no parameters and is used as a bare command.
Description: bare description
Examples
// Basic Usage
varrefvarset
The varset action varset. It belongs to the variables category within the external area.
Action Syntax
varset "text"varset 123varset [file]varset HH:MMvarset YYYY-MM-DDvarset 30mvarset $variablevarset ITvarset EXPRvarset blkValid sizes
Examples
// Basic Usage
varset "text value"// Using Variables
// Display dynamic content from variables
varset $othervarvibrate
The vibrate action vibrates the device (if supported). It belongs to the effects category within the undefined area.
Action Syntax
vibrate 30mExamples
// Basic Usage
vibrate 1swait
The wait action wait for interaction before continuing. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
waitwaitfor
The waitfor action waits for a value from an input into a variable. It belongs to the exec category within the system area.
Action Syntax
waitforThis action takes no parameters and is used as a bare command.
Description: waits for input
Valid sizes
Examples
// Basic Usage
waitforwhen
The when action when - a synonymn for if. It belongs to the logic category within the system area.
Action Syntax
when $variableValid sizes
Examples
// Basic Usage
when $varyoutube
Work with youtube
Overview
The youtube action is part of the social set in Rhyme. Work with youtube.
Category: Social
Area: 🎨 UI & Presentation
Basic Usage
youtube "Example usage"Parameters
Documentation for this action’s parameters is coming soon.
Examples
Example 1: Basic Usage
youtube "Example usage"Example 2: With Variables
$my-variable: "some value"
youtube $my-variableTips
- This action is part of the social set
- Common use case: Creating visual elements and layouts
Related Actions
Related actions from the social set will be listed here.