Back to Tooljet

Image

docs/versioned_docs/version-2.50.0-LTS/widgets/image.md

3.20.154-lts4.0 KB
Original Source

Image

The Image component is used to display images in your app.

<div style={{paddingTop:'24px'}}>

Properties

<div style={{ width:"100px"}}> Properties </div><div style={{ width:"100px"}}> Description </div>
URLEnter the URL of the image to display it on the component.
Loading stateLoading state can be used to show a spinner as the image content. Loading state is commonly used with isLoading property of the queries to show a loading status while a query is being run. Switch the toggle On or click on fx to programmatically set the value {{true}} or {{false}}.
Alternative textUsed for alt text of images.
Zoom buttonToggle this to enable zoom options inside image.
Rotate buttonToggle this on to enable rotate button in the image.
</div> <div style={{paddingTop:'24px'}}>

Events

<div style={{ width:"100px"}}> Event </div><div style={{ width:"100px"}}> Description </div>
On clickTriggers whenever the user clicks on an image.

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

</div> <div style={{paddingTop:'24px'}}>

Component Specific Actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.

</div> <div style={{paddingTop:'24px'}}>

Exposed Variables

There are currently no exposed variables for the component.

</div> <div style={{paddingTop:'24px'}}>

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.

Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.

</div> <div style={{paddingTop:'24px'}}>

Devices

<div style={{ width:"100px"}}> Property </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
</div>
<div style={{paddingTop:'24px'}}>

Styles

<div style={{ width:"100px"}}> Style </div><div style={{ width:"100px"}}> Description </div>
Border typeChoose a border type for the image from available options: None, Rounded, Circle, Thumbnail.
Image fitChoose a image fit - similar to object fit for the image from available options: fill, cover, contain, scale-down
Background colorAdd a background color to component by providing the HEX color code or choosing the color of your choice from the color-picker.
PaddingAdds padding between the image and component border. It accepts any numerical value from 0 to 100.
VisibilityToggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the fx button next to it. If {{false}} the component will not be visible after the app is deployed. By default, it's set to {{true}}.
DisableThis is off by default, toggle on the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the fx button next to it. If set to {{true}}, the component will be locked and becomes non-functional. By default, its value is set to {{false}}.

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

</div>