tags: [gradio-custom-component, SimpleTextbox] title: gradio_mycomponent short_description: hello world component colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py

gradio_mycomponent

hello world component

Installation

pip install gradio_mycomponent

Usage

import gradio as gr
from gradio_mycomponent import MyComponent


example = MyComponent().example_value()

demo = gr.Interface(
    lambda x:x,
    MyComponent(),  # interactive version of your component
    MyComponent(),  # static version of your component
    # examples=[[example]],  # uncomment this line to view the "example version" of your component
)


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

MyComponent

Initialization

str | Callable | None

str | None

str | None

float | None

bool | None

int | None

int

bool | None

bool

bool

str | None

list[str] | str | None

bool

Events

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, passes text value as a {str} into the function.
• As input: Should return, expects a {str} returned from function and sets textarea value to it.

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