docs/versioned_docs/version-3.0.0-LTS/widgets/image.md
The Image component is used to display images in your app.
<div style={{paddingTop:'24px'}}>| <div style={{ width:"100px"}}> Properties </div> | <div style={{ width:"100px"}}> Description </div> |
|---|---|
| URL | Enter the URL of the image to display it on the component. |
| Loading state | Loading 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 text | Used for alt text of images. |
| Zoom button | Toggle this to enable zoom options inside image. |
| Rotate button | Toggle this on to enable rotate button in the image. |
| <div style={{ width:"100px"}}> Event </div> | <div style={{ width:"100px"}}> Description </div> |
|---|---|
| On click | Triggers 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'}}>There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.
</div> <div style={{paddingTop:'24px'}}>There are currently no exposed variables for the component.
</div> <div style={{paddingTop:'24px'}}>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'}}>| <div style={{ width:"100px"}}> Property </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
|---|---|---|
| Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on fx to set the value and entering a logical expression. |
| Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on fx to set the value and entering a logical expression. |
| <div style={{ width:"100px"}}> Style </div> | <div style={{ width:"100px"}}> Description </div> |
|---|---|
| Border type | Choose a border type for the image from available options: None, Rounded, Circle, Thumbnail. |
| Image fit | Choose a image fit - similar to object fit for the image from available options: fill, cover, contain, scale-down |
| Background color | Add a background color to component by providing the HEX color code or choosing the color of your choice from the color-picker. |
| Padding | Adds padding between the image and component border. It accepts any numerical value from 0 to 100. |
| Visibility | Toggle 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}}. |
| Disable | This 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>