Icon Button

Icon Button is an icon-type button component.

Note

Compared to normal Buttons, drawer menus and normal menus can be opened.

Property

No	Item	Input Value	Default Value	Action Property	Type	Action Default Value	Description
1	ID	String	Auto-generated	id	string	Auto-generated	The [id] property cannot be set by actions.
2	Width	String	40	width	string	40	Component width
3	Height	String	40	height	string	40	Component height
4	X	String		x	string		X coordinate position
5	Y	String		y	string		Y coordinate position
6	Lock	Boolean	OFF	lock	boolean	false	When ON, the component stays fixed even when the screen is scrolled. When OFF, the component moves along with the screen scroll. Added in v4.1.0.
7	Size	Selection 1.Small 2.Medium 3.Large 4.None	None	size	string	none	Icon button size
8	Color	String Color Picker		color	string		Icon button color
9	Badge Color	String Color Picker		badgeColor	string		Badge color
10	Badge Label Color	String Color Picker		badgeLabelColor	string		Badge Label color Added in v3.4.0
11	Disabled	Boolean	OFF	disabled	boolean	false	Component disabled/enabled state
12	Visibility	Boolean	ON	visibility	boolean	true	Component show/hide
13	Icon	Selection	AddCircle	icon	string	AddCircle	Icon to display
14	Badge Content	Number		badgeContent	number		Number to display in badge
15	Alert Dialog	Boolean	OFF				Alert dialog show/hide
16	Alert Values L	Table format Detail 3	Detail 3				Alert dialog content
17	Tooltip	String		tooltip	string		Tooltip text
18	Click Event	Selection 1.None 2.NEXT UI 3.URL 4.WINDOW 5.Action 6.Upload 7.Drawer 8.Menu 9.Dialog 10. Detached Action	None				Event setting for click Detached Action became selectable in v4.1.0.
19	NEXT UI	Selection 1.None 2.[UI Label]		nextUi	string		Destination UI
20	URL	String		url	string		Destination URL
21	Drawer	Table format [Details 1]	[Details 1]	drawerItems	array of object	[Details 1]	Drawer menu items
22	Drawer Width	Number		drawerWidth	number		Drawer width
23	Menu	Table format [Details 2]	[Details 2]	menuItems	array of object	[Details 2]	Menu items
24	DIALOG UI	Selection 1.None 2.[Dialog UI Label]		dialogUi	string		Destination dialog UI Added in v3.3.0
25	Detached Action	Selection 1. [Detached Action ID]		detachedAction	string		Set a detached action Added in v4.1.0.

Note

• ^L: This is a Multilingual Property.
• "badgeContent" must be entered as a number greater than or equal to 1. If no value is entered or the value is less than 0, no badge will be displayed.
• If 「""」 or「null」 is set to [batchContent] from the action, the following behavior will occur.
  • If「""」 is set from the action, the badge will be displayed, but the number will not be displayed.
  • If「null」 is set from the action, the badge will not be displayed.
• If "Upload" is selected for [Click Event], the following behavior will occur.
  • Clicking the button launches the OS file selection dialog.
  • Mobile/tablet 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 "Alert Value" property is displayed when the"Alert Dialog" is turned on.
• Alert dialog-related properties cannot be set or retrieved from actions.
• When setting the "Size" property from an action, you can choose from the following values:
  1. small
  2. medium
  3. large
  4. none
• If you select none for the "Size" property, you can configure the "Width" and "Height" properties.
• 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%
• The "Width" and "Height" properties are always based on the "Width" value, so the icon button will automatically keep both dimensions the same size.
• If you specify "Width" and "Height" using the calc() function, it will not affect the appearance of the icon button.
• 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.
• 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 4] External Service Site Integration" below.
• If you select “Dialog” for the "Click Event", the context menu will display "Dialog", where you can define actions such as "Open" and "Close". For details, see "[Details 5] Dialog Integration" below.

[Details 1] Drawer

The default status is registered as follows. Register from the "Add" button. To delete, select the check box and click the "Delete" button.

Select	ID	Icon	Label	Click Event	NEXT UI	Detached Action	URL	Divider
Checkbox	item1	MoveToInbox	Inbox	None				No
Checkbox	item2	Mail	Starred	None				No
Checkbox	item3	MoveToInbox	Send Email	None				No
Checkbox	item4	Mail	Drafts	None				Yes
Checkbox	item5	MoveToInbox	All Mail	None				No
Checkbox	item6	Mail	Trash	None				No
Checkbox	item7	MoveToInbox	Spam	None				No

[{"id":"item1","Icon":"MoveToInbox","label":"Inbox","Clickevent":"None","NextUi":"","url":"","divider":false},{"id":"item2","Icon":"Mail","label":"Starred","Clickevent":"None","NextUi":"","url":"","divider":false},{"id":"item3","Icon":"MoveToInbox","label":"Send Email","Clickevent":"None","NextUi":"","url":"","divider":false},{"id":"item4","Icon":"Mail","label":"Drafts","Clickevent":"None","NextUi":"","url":"","divider":true},{"id":"item5","Icon":"MoveToInbox","label":"All Mail","Clickevent":"None","NextUi":"","url":"","divider":false},{"id":"item6","Icon":"Mail","label":"Trash","Clickevent":"None","NextUi":"","url":"","divider":false},{"id":"item7","Icon":"MoveToInbox","label":"Spam","Clickevent":"None","NextUi":"","url":"","divider":false}]

Note

• The options for the click event of the drawer are None | Next UI | URL | Action | Detached Action.
• If you select the click event "Action" in the drawer, you will be able to launch the action editor from the context menu of the component.
• If the separator is set to "Yes (true)", a separator will be added under the menu element.
• Do not set the authentication UI in "NEXT UI". Please note that setting the authentication UI in "NEXT UI" may result in incorrect behavior.

[Details 2] Menu

A menu is the choices that appear when you click on an icon button. The default status is registered as follows. Register from the "Add" button. To delete, select the check box and click the "Delete" button.

Select	ID	ICON	LABEL	CLICK EVENT	NEXT UI	Detached Action	URL	DIVIDER
Checkbox	Profile	AccountCircle	Profile	None				No
Checkbox	MFA_Setting	Settings	MFA Setting	NextUi	MFA Setting Step1			No
Checkbox	Change_Password	LockReset	Change password	NextUi	Change Password			No
Checkbox	Sign_Out	Logout	Sign out	NextUi	Sign Out			No

Note

• The options for the menu click event are None | Next UI | URL | Action | Detached Action.
• If you select the click event "Action" in the menu, you will be able to launch the action editor from the context menu of the component.
• If the separator is set to "Yes (true)", a separator will be added below the menu element.
• Do not set the authentication UI in "NEXT UI". Please note that setting the authentication UI in "NEXT UI" may result in incorrect operation.

[Details 3] 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 4] 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.

Note

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

Note

• When sending parameters from an external site, add them as GET parameters when navigating to callback.html.

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.

Note

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

[Details 5] Dialog Integration

You can only navigate to a dialog UI from a screen UI.
Follow these steps to define navigation to a dialog UI:

1. Select "Dialog" for the "Click Event".
2. In the displayed "DIALOG UI" field, set the dialog UI to navigate to.

Note

If you want to open a dialog via an action, use "$fn.openDialog()".

3. Define the "Open" dialog action.
   • You can pass parameters such as $param.{queryParameter} when navigating to the dialog UI.
4. Define the "Close" dialog action.
   • Use $param.{queryParameterName} to retrieve information from the target dialog UI.
   • Bind the retrieved values to the UI as needed.

Behavior during dialog integration:

1. When the configured component is clicked, the dialog UI pops up.
2. Perform processing in the dialog UI.
3. Execute "$fn.closeDialog()" on the dialog UI side.
4. The action defined in the "Close" window action will run.

Note

• If the dialog is displayed using "$fn.openDialog()", the canvas action of the source UI will execute when the dialog closes.
• If the dialog is displayed via the click event "Dialog", the close action of the source component will execute when the dialog closes.

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 "[Details 4] External Service Site Integration". For the click event "Dialog": The operation is described in "[Details 5] Dialog Integration". For the click event "Detached Action": Executes the detached action when clicked.