Spaces:
Running
Running
| """gr.Checkbox() component.""" | |
| from __future__ import annotations | |
| from typing import Any, Callable | |
| from gradio_client.documentation import document | |
| from gradio.components.base import FormComponent | |
| from gradio.events import Events | |
| class Checkbox(FormComponent): | |
| """ | |
| Creates a checkbox that can be set to `True` or `False`. Can be used as an input to pass a boolean value to a function or as an output | |
| to display a boolean value. | |
| Demos: sentence_builder, hello_world_3 | |
| """ | |
| EVENTS = [Events.change, Events.input, Events.select] | |
| def __init__( | |
| self, | |
| value: bool | Callable = False, | |
| *, | |
| label: str | None = None, | |
| info: str | None = None, | |
| every: float | None = None, | |
| show_label: bool | None = None, | |
| container: bool = True, | |
| scale: int | None = None, | |
| min_width: int = 160, | |
| interactive: 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: if True, checked by default. 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. Appears above the component and is also 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. | |
| info: additional component description. | |
| 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: if True, will display label. | |
| container: If True, will place the component in a container - providing some extra padding around the border. | |
| scale: relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. | |
| min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. | |
| interactive: if True, this checkbox can be checked; if False, checking will be disabled. If not provided, this is inferred based on whether the component is used as an input or output. | |
| 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, | |
| info=info, | |
| every=every, | |
| show_label=show_label, | |
| container=container, | |
| scale=scale, | |
| min_width=min_width, | |
| interactive=interactive, | |
| visible=visible, | |
| elem_id=elem_id, | |
| elem_classes=elem_classes, | |
| render=render, | |
| key=key, | |
| value=value, | |
| ) | |
| def api_info(self) -> dict[str, Any]: | |
| return {"type": "boolean"} | |
| def example_payload(self) -> bool: | |
| return True | |
| def example_value(self) -> bool: | |
| return True | |
| def preprocess(self, payload: bool | None) -> bool | None: | |
| """ | |
| Parameters: | |
| payload: the status of the checkbox | |
| Returns: | |
| Passes the status of the checkbox as a `bool`. | |
| """ | |
| return payload | |
| def postprocess(self, value: bool | None) -> bool | None: | |
| """ | |
| Parameters: | |
| value: Expects a `bool` value that is set as the status of the checkbox | |
| Returns: | |
| The same `bool` value that is set as the status of the checkbox | |
| """ | |
| return bool(value) | |