Spaces:
Runtime error
Runtime error
| """gr.Button() component.""" | |
| from __future__ import annotations | |
| from typing import Any, Callable, Literal | |
| from gradio_client.documentation import document, set_documentation_group | |
| from gradio.components.base import Component | |
| from gradio.events import Events | |
| set_documentation_group("component") | |
| class Button(Component): | |
| """ | |
| Used to create a button, that can be assigned arbitrary click() events. The label (value) of the button can be used as an input or set via the output of a function. | |
| Preprocessing: passes the button value as a {str} into the function | |
| Postprocessing: expects a {str} to be returned from a function, which is set as the label of the button | |
| Demos: blocks_inputs, blocks_kinematics | |
| """ | |
| EVENTS = [Events.click] | |
| def __init__( | |
| self, | |
| value: str | Callable = "Run", | |
| *, | |
| every: float | None = None, | |
| variant: Literal["primary", "secondary", "stop"] = "secondary", | |
| size: Literal["sm", "lg"] | None = None, | |
| icon: str | None = None, | |
| link: str | None = None, | |
| visible: bool = True, | |
| interactive: bool = True, | |
| elem_id: str | None = None, | |
| elem_classes: list[str] | str | None = None, | |
| render: bool = True, | |
| scale: int | None = None, | |
| min_width: int | None = None, | |
| ): | |
| """ | |
| Parameters: | |
| value: Default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component. | |
| every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute. | |
| variant: 'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button. | |
| size: Size of the button. Can be "sm" or "lg". | |
| icon: URL or path to the icon file to display within the button. If None, no icon will be displayed. Must be within the working directory of the Gradio app or an external URL. | |
| link: URL to open when the button is clicked. If None, no link will be used. | |
| visible: If False, component will be hidden. | |
| interactive: If False, the Button will be in a disabled state. | |
| 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. | |
| scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer. | |
| 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. | |
| """ | |
| super().__init__( | |
| every=every, | |
| visible=visible, | |
| elem_id=elem_id, | |
| elem_classes=elem_classes, | |
| render=render, | |
| value=value, | |
| interactive=interactive, | |
| scale=scale, | |
| min_width=min_width, | |
| ) | |
| self.icon = self.move_resource_to_block_cache(icon) | |
| self.variant = variant | |
| self.size = size | |
| self.link = link | |
| def skip_api(self): | |
| return True | |
| def preprocess(self, payload: str) -> str: | |
| return payload | |
| def postprocess(self, value: str) -> str: | |
| return value | |
| def example_inputs(self) -> Any: | |
| return None | |