ToolJet/docs/docs/widgets/image.md
Shubhendra Singh Chauhan 307c2cd05a
[docs] updated sidebar and improved hierarchy (#2958)
* added pages for directories and updated sidebar

* added notion and openapi in sidebar.js
2022-05-04 08:10:46 +05:30

74 lines
No EOL
2 KiB
Markdown

---
id: image
title: Image
---
# Image
Image widget is used to display images in your app.
<div style={{textAlign: 'center'}}>
![ToolJet - Widget Reference - Image](/img/widgets/image/image.png)
</div>
## Events
<div style={{textAlign: 'center'}}>
![ToolJet - Widget Reference - Image](/img/widgets/image/events.png)
</div>
### On click
On click event is triggered when an image is clicked.
:::info
Check [Action Reference](/docs/actions/show-alert) docs to get the detailed information about all the **Actions**.
:::
## Properties
### URL
Enter the URL of the image to display it on the widget.
## Layout
### Show on desktop
Toggle on or off to display the widget in desktop view. You can programmatically determing the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}`.
### Show on mobile
Toggle on or off to display the widget in mobile view. You can programmatically determing the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}`.
## Styles
### Border type
Choose a border type for the image from available options:
- None
- Rounded
- Circle
- Thumbnail
### Background color
Add a background color to widget by providing the `HEX color code` or choosing the color of your choice from the color-picker.
### Padding
Adds padding between the image and widget border. It accepts any numerical value from `0` to `100`.
### Visibility
Toggle on or off to control the visibility of the widget. You can programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget 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 widget 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 widget 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**.
:::