Introducing Gradio Clients

Watch
Gradio logo
  1. Components
  2. HTML

New to Gradio? Start here: Getting Started

See the Release History

To install Gradio from main, run the following command:

pip install https://gradio-builds.s3.amazonaws.com/02798ec170be7c9e8756dec24ef29c7f46fe2060/gradio-4.41.0-py3-none-any.whl

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

←

HighlightedText

Image

→

HTML

gradio.HTML(···)
import gradio as gr with gr.Blocks() as demo: with gr.Group(): gr.HTML(value="<p style='margin-top: 1rem, margin-bottom: 1rem'>This <em>example</em> was <strong>written</strong> in <a href='https://en.wikipedia.org/wiki/HTML' _target='blank'>HTML</a> </p>") demo.launch()

Description

Creates a component to display arbitrary HTML output. As this component does not accept user input, it is rarely used as an input component.

Behavior

As input component: (Rarely used) passes the HTML as a str.

Your function should accept one of these types:
def predict(
	value: str | None
)
	...

As output component: Expects a str consisting of valid HTML.

Your function should return one of these types:
def predict(···) -> str | None
	...	
	return value

Initialization

Parameters

Shortcuts

Class Interface String Shortcut Initialization

gradio.HTML

"html"

 Uses default values

Demos

import gradio as gr

demo = gr.Blocks()

with demo:
    inp = gr.Textbox(placeholder="Enter text.")
    scroll_btn = gr.Button("Scroll")
    no_scroll_btn = gr.Button("No Scroll")
    big_block = gr.HTML("""
    

    """)
    out = gr.Textbox()

    scroll_btn.click(lambda x: x,
               inputs=inp,
               outputs=out,
                scroll_to_output=True)
    no_scroll_btn.click(lambda x: x,
               inputs=inp,
               outputs=out)

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

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 HTML component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener Description

HTML.change(fn, ···)

Triggered when the value of the HTML 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
←

HighlightedText

Image

→