Introducing Gradio Clients

Watch

New to Gradio? Start here: Getting Started

See the Release History

State

gradio.State(ยทยทยท)

Description

A base class for defining methods that all input/output components should have.

Behavior

As input component: Passes a value of arbitrary type through.

Your function should accept one of these types:
def predict(
	value: Any
)
	...

As output component: Expects a value of arbitrary type, as long as it can be deepcopied.

Your function should return one of these types:
def predict(ยทยทยท) -> Any
	...	
	return value

Initialization

Parameters

Event Listeners

Description

Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.

Supported Event Listeners

The State component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener Description

State.change(fn, ยทยทยท)

Triggered when the value of the State changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.

Event Parameters

Parameters