ToolJet/docs/versioned_docs/version-2.68.0/widgets/icon.md at fix/wf-bundle-error

mirror of https://github.com/ToolJet/ToolJet synced 2026-04-21 21:47:17 +00:00

* docs: jira

* docs: formatting + Client Credentials grant type

* docs: connection string pgsql

* docs: parameterized queries mysql

* docs: parameterized queries in PostgreSQL

* docs: update mysql example

* docs: TJDB sql editor

* docs: add metadata to REST API

* docs: add, update  postgresql media

* docs: add metadata to graphql

* docs: update parameterized queries

* docs: add parameterized queries for mssql

* docs: add SSL Cert to mysql

* docs: TJDB SQL restricted commands

* docs: update JIRA token location

* docs: update delete issue example

* docs: update find user by query example

* docs: remove session id from get assignable users

* docs: use correct image for get issues for board

* docs: update create issue example

* docs: update delete issue media

* docs: update assignable users media

* docs: update examples

* docs: update key desc

* docs: v2.68.0-Beta

2024-09-13 19:23:19 +05:30

4.2 KiB

Raw Permalink Blame History

id	title
icon	Icon

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

Properties

<div style={{ width:"100px"}}> Properties	<div style={{ width:"100px"}}> Description	<div style={{ width:"135px"}}> Expected Value
Icon	Use 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

To add an event, click on the Icon widget's configuration handle to open the widget properties on the components drawer on the right. Go to the Events section and click on + Add handler.

The Icon widget supports the following events:

<div style={{ width:"100px"}}> Event	<div style={{ width:"100px"}}> Description
On hover	This event is triggered when the cursor is hovered over the icon
On click	This event is triggered when 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):

<div style={{ width:"100px"}}> Actions	<div style={{ width:"135px"}}> Description	<div style={{ width:"135px"}}> How To Access
setVisibility	You 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)`
click	You 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 widget.

Layout

<div style={{ width:"100px"}}> Layout	<div style={{ width:"100px"}}> Description	<div style={{ width:"135px"}}> Expected Value
Show on desktop	Toggle 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 mobile	Toggle 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

<div style={{ width:"100px"}}> Style	<div style={{ width:"100px"}}> Description	<div style={{ width:"135px"}}> Expected Value
Icon color	You can change the color of the Icon widget by entering the Hex color code or choosing a color of your choice from the color picker.
Visibility	This is to control the visibility of the widget.	If `{{false}}` the widget will not visible after the app is deployed.
Box shadow	This property adds a shadow to the widget.	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. :::

4.2 KiB Raw Permalink Blame History