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`

Python library for easily interacting with trained machine learning models

Installation

pip install gradio_iconbutton

Usage

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

name	type	default	description
`value`	str \| Callable	`"Run"`	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.
`every`	Timer \| float \| None	`None`	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.
`inputs`	Component \| Sequence[Component] \| set[Component] \| None	`None`	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.
`variant`	Literal["primary", "secondary", "stop", "huggingface"]	`"secondary"`	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.
`size`	Literal["sm", "lg"] \| None	`None`	size of the button. Can be "sm" or "lg".
`icon`	str \| None	`None`	URL or path to the icon file to display within the button. If None, no icon will be displayed.
`link`	str \| None	`None`	URL to open when the button is clicked. If None, no link will be used.
`visible`	bool	`True`	if False, component will be hidden.
`interactive`	bool	`True`	if False, the IconButton will be in a disabled state.
`elem_id`	str \| None	`None`	an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
`elem_classes`	list[str] \| str \| None	`None`	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.
`render`	bool	`True`	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.
`key`	int \| str \| None	`None`	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.
`scale`	int \| None	`None`	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.
`min_width`	int \| None	`None`	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.

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.

def predict(
    value: str | None
) -> str | None:
    return value

Metadata

Release files for gradio-iconbutton 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for gradio-iconbutton 0.0.1
File	Interpreter	ABI	Platform	Actions Reset
gradio_iconbutton-0.0.1-py3-none-any.whl 3.6 MB Sep 18, 2025 Without provenance	Python 3	none	any	Details for gradio_iconbutton-0.0.1-py3-none-any.whl

Release files / gradio_iconbutton-0.0.1-py3-none-any.whl

Download URL	gradio_iconbutton-0.0.1-py3-none-any.whl
Size	3.6 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`62a333e8c93ea4e12eaa91ddfae717c503f623e3c8394ddee2eaaa3b28c87d02`
BLAKE2b-256 checksum How to use checksums	`4d378e818b4ab8b86ed87043b0f7cfa4b1f7b9f5b81230cc4711c37cbd30b29d`
Upload date	Sep 18, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.10.11`

Security for gradio-iconbutton 0.0.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

Sep 18, 2025 1 release file No provenance

gradio-iconbutton 0.0.1