---
tags: [gradio-custom-component, Button, button, icon]
title: gradio_iconbutton
short_description:
colorFrom: blue
colorTo: yellow
sdk: gradio
pinned: false
app_file: space.py
---
# `gradio_iconbutton`
<img alt="Static Badge" src="https://img.shields.io/badge/version%20-%200.0.1%20-%20orange">
Python library for easily interacting with trained machine learning models
## Installation
```bash
pip install gradio_iconbutton
```
## Usage
```python
import gradio as gr
from gradio_iconbutton import IconButton
example = IconButton().example_value()
with gr.Blocks() as demo:
with gr.Row():
IconButton("refresh", scale=0)
IconButton("folder", scale=1)
IconButton("folder_open")
IconButton("star")
if __name__ == "__main__":
demo.launch()
```
## `IconButton`
### Initialization
<table>
<thead>
<tr>
<th align="left">name</th>
<th align="left" style="width: 25%;">type</th>
<th align="left">default</th>
<th align="left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
str | Callable
```
</td>
<td align="left"><code>"Run"</code></td>
<td align="left">default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
Timer | float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">continuously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>
</tr>
<tr>
<td align="left"><code>inputs</code></td>
<td align="left" style="width: 25%;">
```python
Component | Sequence[Component] | set[Component] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>
</tr>
<tr>
<td align="left"><code>variant</code></td>
<td align="left" style="width: 25%;">
```python
Literal["primary", "secondary", "stop", "huggingface"]
```
</td>
<td align="left"><code>"secondary"</code></td>
<td align="left">sets the background and text color of the button. Use 'primary' for main call-to-action buttons, 'secondary' for a more subdued style, 'stop' for a stop button, 'huggingface' for a black background with white text, consistent with Hugging Face's button styles.</td>
</tr>
<tr>
<td align="left"><code>size</code></td>
<td align="left" style="width: 25%;">
```python
Literal["sm", "lg"] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">size of the button. Can be "sm" or "lg".</td>
</tr>
<tr>
<td align="left"><code>icon</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">URL or path to the icon file to display within the button. If None, no icon will be displayed.</td>
</tr>
<tr>
<td align="left"><code>link</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">URL to open when the button is clicked. If None, no link will be used.</td>
</tr>
<tr>
<td align="left"><code>visible</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">if False, component will be hidden.</td>
</tr>
<tr>
<td align="left"><code>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">if False, the IconButton will be in a disabled state.</td>
</tr>
<tr>
<td align="left"><code>elem_id</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>elem_classes</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">an optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>render</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">if False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
</tr>
<tr>
<td align="left"><code>key</code></td>
<td align="left" style="width: 25%;">
```python
int | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>
</tr>
<tr>
<td align="left"><code>scale</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>
</tr>
<tr>
<td align="left"><code>min_width</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>
</tr>
</tbody></table>
### Events
| name | description |
|:-----|:------------|
| `click` | Triggered when the IconButton is clicked. |
### User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- **As output:** Is passed, (Rarely used) the `str` corresponding to the button label when the button is clicked.
- **As input:** Should return, string corresponding to the button label.
```python
def predict(
value: str | None
) -> str | None:
return value
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gradio-iconbutton",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "button, gradio-custom-component, gradio-template-Button, icon",
"author": null,
"author_email": "YOUR NAME <YOUREMAIL@domain.com>",
"download_url": null,
"platform": null,
"description": "---\ntags: [gradio-custom-component, Button, button, icon]\ntitle: gradio_iconbutton\nshort_description: \ncolorFrom: blue\ncolorTo: yellow\nsdk: gradio\npinned: false\napp_file: space.py\n---\n\n# `gradio_iconbutton`\n<img alt=\"Static Badge\" src=\"https://img.shields.io/badge/version%20-%200.0.1%20-%20orange\"> \n\nPython library for easily interacting with trained machine learning models\n\n## Installation\n\n```bash\npip install gradio_iconbutton\n```\n\n## Usage\n\n```python\n\nimport gradio as gr\nfrom gradio_iconbutton import IconButton\n\n\nexample = IconButton().example_value()\n\nwith gr.Blocks() as demo:\n with gr.Row():\n IconButton(\"refresh\", scale=0)\n IconButton(\"folder\", scale=1)\n IconButton(\"folder_open\")\n IconButton(\"star\")\n\n\nif __name__ == \"__main__\":\n demo.launch()\n\n```\n\n## `IconButton`\n\n### Initialization\n\n<table>\n<thead>\n<tr>\n<th align=\"left\">name</th>\n<th align=\"left\" style=\"width: 25%;\">type</th>\n<th align=\"left\">default</th>\n<th align=\"left\">description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | Callable\n```\n\n</td>\n<td align=\"left\"><code>\"Run\"</code></td>\n<td align=\"left\">default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nTimer | float | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">continuously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>inputs</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nComponent | Sequence[Component] | set[Component] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>variant</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"primary\", \"secondary\", \"stop\", \"huggingface\"]\n```\n\n</td>\n<td align=\"left\"><code>\"secondary\"</code></td>\n<td align=\"left\">sets the background and text color of the button. Use 'primary' for main call-to-action buttons, 'secondary' for a more subdued style, 'stop' for a stop button, 'huggingface' for a black background with white text, consistent with Hugging Face's button styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>size</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"sm\", \"lg\"] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">size of the button. Can be \"sm\" or \"lg\".</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>icon</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">URL or path to the icon file to display within the button. If None, no icon will be displayed.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>link</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">URL to open when the button is clicked. If None, no link will be used.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>visible</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">if False, component will be hidden.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>interactive</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">if False, the IconButton will be in a disabled state.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_id</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_classes</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">an optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>render</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">if False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>key</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>scale</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>min_width</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `click` | Triggered when the IconButton is clicked. |\n\n\n\n### User function\n\nThe impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).\n\n- When used as an Input, the component only impacts the input signature of the user function.\n- When used as an output, the component only impacts the return signature of the user function.\n\nThe code snippet below is accurate in cases where the component is used as both an input and an output.\n\n- **As output:** Is passed, (Rarely used) the `str` corresponding to the button label when the button is clicked.\n- **As input:** Should return, string corresponding to the button label.\n\n ```python\n def predict(\n value: str | None\n ) -> str | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for easily interacting with trained machine learning models",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"button",
" gradio-custom-component",
" gradio-template-button",
" icon"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4d378e818b4ab8b86ed87043b0f7cfa4b1f7b9f5b81230cc4711c37cbd30b29d",
"md5": "2b5f2a5a7909503e4c35da244e32f6b4",
"sha256": "62a333e8c93ea4e12eaa91ddfae717c503f623e3c8394ddee2eaaa3b28c87d02"
},
"downloads": -1,
"filename": "gradio_iconbutton-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b5f2a5a7909503e4c35da244e32f6b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3594153,
"upload_time": "2025-09-18T13:42:21",
"upload_time_iso_8601": "2025-09-18T13:42:21.090606Z",
"url": "https://files.pythonhosted.org/packages/4d/37/8e818b4ab8b86ed87043b0f7cfa4b1f7b9f5b81230cc4711c37cbd30b29d/gradio_iconbutton-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-18 13:42:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gradio-iconbutton"
}
JSON