Spaces:
Running
Running
File size: 3,325 Bytes
b72ab63 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
"""gr.HTML() component."""
from __future__ import annotations
from typing import Any, Callable
from gradio_client.documentation import document
from gradio.components.base import Component
from gradio.events import Events
@document()
class HTML(Component):
"""
Creates a component to display arbitrary HTML output. As this component does not accept user input, it is rarely used as an input component.
Demos: blocks_scroll
Guides: key-features
"""
EVENTS = [Events.change]
def __init__(
self,
value: str | Callable | None = None,
*,
label: str | None = None,
every: float | None = None,
show_label: bool | None = None,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
render: bool = True,
key: int | str | None = None,
):
"""
Parameters:
value: Default value. If callable, the function will be called whenever the app loads to set the initial value of the component.
label: The label for this component. Is used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
show_label: This parameter has no effect.
visible: If False, component will be hidden.
elem_id: 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: 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: 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: if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.
"""
super().__init__(
label=label,
every=every,
show_label=show_label,
visible=visible,
elem_id=elem_id,
elem_classes=elem_classes,
render=render,
key=key,
value=value,
)
def example_payload(self) -> Any:
return "<p>Hello</p>"
def example_value(self) -> Any:
return "<p>Hello</p>"
def preprocess(self, payload: str | None) -> str | None:
"""
Parameters:
payload: string corresponding to the HTML
Returns:
(Rarely used) passes the HTML as a `str`.
"""
return payload
def postprocess(self, value: str | None) -> str | None:
"""
Parameters:
value: Expects a `str` consisting of valid HTML.
Returns:
Returns the HTML string.
"""
return value
def api_info(self) -> dict[str, Any]:
return {"type": "string"}
|