Push Button

Push buttons are primarily regular button components for performing actions.

Properties

UI Dialog

Item	Input value	Option	Default value
ID	string		automatic
Label	string		Button
Width	string		90
Height	string		40
X	string
Y	string
Variant	select	CONTAINED, OUTLINED, TEXT	CONTAINED
Color	string, color picker
Disabled	boolean	on, off	off
Visibility	boolean	on, off	on
Start Icon	select		None
End Icon	select		None
Alert Dialog	select	on, off	off
Tooltip	select
Alert Value	table Details1		Details 1
Click Event	select	None, NEXT UI, URL, WINDOW, ACTION, UPLOAD	ACTION
NEXT UI	select	None, [UI Label]
URL	string

Action

Item	Properties	Data Type	Options	Default value
id	string		automatic
label	string		Button
width	string		90
height	string		40
x	string
y	string
variant	string	contained, outlined, text	outlined
color	string
disabled	boolean	true, false	false
visibility	boolean	true, false	true
tooltip	string
nextUi	string
url	string

Tips

Tips

• If "Upload" is selected for [Click Event], the following behavior will occur.
  • Clicking the button launches the OS file selection dialog.
  • Mobile devices can activate the camera when adding files and upload photographic images
    • For iOS devices, all images that are photographed are registered as "image.jpg". Therefore, please note that if a file with the same name already exists, it will be overwritten.
    • For Android devices, the photographed image will be registered as "unique-key.jpg".
    • Regardless of the OS, only jpg extension is available for image data upload from camera startup.
• If "Upload" is selected for "Click Event", unlike "NextUI" and "URL", an action can be defined. The built-in function "$fn.getUploadFiles" can be used in an action to obtain uploaded files as an object array. Note that the built-in function "$fn.getUploadFiles" cannot be used when "Action" is selected for "Click Event".
• Do not set the authentication UI to "NEXT UI". Note that setting the authentication UI to "NEXT UI" may result in incorrect operation.
• The following can be entered for the "Width" and "Height" property values. If you want to display in px, specify only numerical values; if you want to display in %, specify % as the unit. Operation will not be supported if you enter anything other than the following.
  • number
  • number%
  • calc() function
• The following can be entered for the [X] and [Y] property values. If you want to display in px, specify only numerical values. Operation will not be supported if you enter anything other than the following.
  • number
  • calc() function
• The calc() function is a CSS function that enables calculations. (e.g. calc(100% - 30px)) The units that can be used with the calc() function are "%" and "px" . Other units (e.g., em, rem, etc.) are not supported.
• When the calc() function is used to specify the size, the appearance in the editor may differ from the appearance in the application. Please confirm using the preview.
• The "Alert Value" property is displayed when the "Alert Dialog" is turned on.
• Alert dialog-related properties cannot be set or retrieved from actions.
• If "WINDOW" is selected for "Click Event", "Window Action" will appear in the context menu, and "Open" and "Close" actions can be defined. For details, see "[Details 2] External Service Site Integration” below.

[Details 1] Alert Value

The default status is registered as follows Edit the value columns for the items “Title”,“Contents”, “Cancel”, and “Submit”.

Item	Value
Title	Are you sure?
Contents	Once you execute, all the previous changes will be lost and existing users will not be able to view the last changes. This cannot be reverted.
Cancel	Cancel
Submit	Submit

[Details 2] External Service Site Integration

External Service Site Integration with WebPerformer-NX is possible with the following specifications

• If a callback URL is specified, the user will be redirected to that URL after processing the external service site.
• When migrating to a callback URL, pass data to the callback URL using query parameters

The definition procedure for External Service Site Integration that conforms to the above specifications is as follows

1. Select “WINDOW” in “Click Event”
2. Set the URL for the transition to the external service site in the URL field displayed.

Tips

URLs can also be set within an action. For dynamic URLs, leave the URL field empty and set it in the action described in step 3.

3. Define window action “Open”.
   • Dynamically create the URL to open the window.
   • Specify the following for the callback URL parameter. If you are not using a custom domain: {Parameter}=https://{envid}.webperformer.jp/callback.html If you are using a custom domain: {Parameter}=https://{customdomain}/callback.html
   • The created URL is set in the url property. Example) $ui.button_id.url
4. Define the window action “Close”.
   • Receive a parameter of the transition destination URL with $param.{query parameter name}.
   • Bind the obtained value to the UI if necessary.

External Service Site Integration works as follows.

1. Click on the settings component to open the external service site with the specified URL in a new tab.
2. Complete the external service site processing.
3. Navigate to the callback URL.
4. Close the external service site with the process from the callback page.
5. The action defined in the window action “Close” is executed.

Tips

• If the value of the URL property is empty, the user will be directed to the WebPerformer-NX application being release deployed.
• If an error occurs when executing the action of window action”Open”, the external service site cannot be displayed.

Event

Event name	Description
onclick	For the click event “Action”: Execute an action when clicked. For the click event “Upload”: The action is executed when the “Open (O)“button is clicked after the file is selected. For the click event “WINDOW”: The operation is described in “[Detail 2] External Service Site Integration”.