Interaction
39 posts tagged with "Interaction"
.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.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].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.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.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
.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-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].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].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.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
.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".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.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 $varnameclear-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-announcementif-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]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 $channelschedule
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
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"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-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"slide-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]subscribe
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 @channelunsubscribe
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 @channel