Skip to main content
Version: 3.1.0-Beta 🚧

Icon

An Icon component can be used to add icons(sourced from icon library). It supports events like on hover and on click.

Properties

Properties
Description
Expected Value
IconUse this to choose an icon form the list of available icons.You can also use the search bar in it to look for the icons.

Events

Event
Description
On hoverTriggers whenever the cursor is hovered over the icon.
On clickTriggers whenever the icon is clicked.

Just like any other event on ToolJet, you can set multiple handlers for any of the above-mentioned events.

info

Check Action Reference docs to get the detailed information about all the Actions.

Component Specific Actions (CSA)

Following actions of the component can be controlled using the component specific actions(CSA):

Actions
Description
How To Access
setVisibilityYou can toggle the visibility of the Icon component via a component-specific action within any event handler.Employ a RunJS query to execute component-specific actions such as await components.icon1.setVisibility(false).
clickYou can trigger the click action on Icon component via a component-specific action within any event handler.Employ a RunJS query to execute component-specific actions such as await components.icon1.click().

Exposed Variables

There are currently no exposed variables for the component.

General

Tooltip: Set a tooltip text to specify the information when the user moves the mouse pointer over the component.

Layout

Layout
Description
Expected Value
Show on desktopToggle on or off to display desktop view.You can programmatically determining the value by clicking on fx to set the value {{true}} or {{false}}.
Show on mobileToggle on or off to display mobile view.You can programmatically determining the value by clicking on fx to set the value {{true}} or {{false}}.

Styles

Style
Description
Expected Value
Icon colorYou can change the color of the Icon component by entering the Hex color code or choosing a color of your choice from the color picker.
VisibilityThis is to control the visibility of the component.If {{false}} the component will not visible after the app is deployed.
Box shadowThis property adds a shadow to the component.You can use different values for box shadow property like offsets, blur, spread, and the color code.
info

Any property having fx button next to its field can be programmatically configured.