gradio_buttonplus

Advanced Button Component for Gradio UI

ButtonPlus Component Demo

{}
{}

Installation

pip install gradio_buttonplus

Usage


import gradio as gr
from gradio_buttonplus import ButtonPlus


with gr.Blocks(theme=gr.themes.Ocean()) as demo:
    gr.HTML("<h1><center>ButtonPlus Component Demo</center></h1>")
    with gr.Row():
        with gr.Column():
            btn = ButtonPlus("⚙️", help="This button triggers an action.")        
            btn_2 = ButtonPlus("Another Test", help="This is a demo test")
        


if __name__ == "__main__":
    demo.launch()

ButtonPlus

Initialization
Parameters 
value: str | I18nData | Callable
default = "Run"

default text for the button to display. If a function is provided, the function will be called each time the app loads to set the initial value of this component.

every: Timer | float | None
default = 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
default = 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"]
default = "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", "md", "lg"]
default = "lg"

size of the button. Can be "sm", "md", or "lg".

icon: str | Path | None
default = None

URL or path to the icon file to display within the button. If None, no icon will be displayed.

link: str | None
default = None

URL to open when the button is clicked. If None, no link will be used.

visible: bool | Literal["hidden"]
default = True

If False, component will be hidden. If "hidden", component will be visually hidden and not take up space in the layout but still exist in the DOM.

interactive: bool
default = True

if False, the ButtonPlus will be in a disabled state.

elem_id: str | None
default = 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
default = 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
default = 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 | tuple[int | str, ...] | None
default = None

in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.

preserved_by_key: list[str] | str | None
default = "value"

A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.

scale: int | None
default = 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
default = 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.

help: str | I18nData | None
default = None

A string of help text to display in a tooltip when hovering over the button.

Events
Parameters 
click

Triggered when the ButtonPlus 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 input: Is passed, (Rarely used) the str corresponding to the button label when the button is clicked.
  • As output: Should return, string corresponding to the button label.
def predict(
   value: str | None
) -> str | None:
   return value