Helpers
KeyUpData

New to Gradio? Start here: Getting Started

To install Gradio from main, run the following command:

pip install https://gradio-builds.s3.amazonaws.com/ac9bf5ec9208b92579f36ee94a247ae3e676c02f/gradio-5.6.0-py3-none-any.whl

*Note: Setting share=True in launch() will not work.

←

DeletedFileData

LikeData

→

KeyUpData

gradio.KeyUpData(···)

Description

The gr.KeyUpData class is a subclass of gr.EventData that specifically carries information about the `.key_up()` event. When gr.KeyUpData is added as a type hint to an argument of an event listener method, a gr.KeyUpData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener.

Example Usage

import gradio as gr

def test(value, key_up_data: gr.KeyUpData):
    return {
        "component value": value,
        "input value": key_up_data.input_value,
        "key": key_up_data.key
    }

with gr.Blocks() as demo:
    d = gr.Dropdown(["abc", "def"], allow_custom_value=True)
    t = gr.JSON()
    d.key_up(test, d, t)
demo.launch()

Attributes

key: str

The key that was pressed.

input_value: str

The displayed value in the input textbox after the key was pressed. This may be different than the `value` attribute of the component itself, as the `value` attribute of some components (e.g. Dropdown) are not updated until the user presses Enter.

Demos

import gradio as gr def test(value, key_up_data: gr.KeyUpData): return { "component value": value, "input value": key_up_data.input_value, "key": key_up_data.key } with gr.Blocks() as demo: d = gr.Dropdown(["abc", "def"], allow_custom_value=True) t = gr.JSON() d.key_up(test, d, t) if __name__ == "__main__": demo.launch()

import gradio as gr

def test(value, key_up_data: gr.KeyUpData):
    return {
        "component value": value,
        "input value": key_up_data.input_value,
        "key": key_up_data.key
    }

with gr.Blocks() as demo:
    d = gr.Dropdown(["abc", "def"], allow_custom_value=True)
    t = gr.JSON()
    d.key_up(test, d, t)

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

←

DeletedFileData

LikeData

→