feat: add link_target parameter to Button component (#12524)

* feat: add link_target parameter to Button component

- Add link_target parameter with options: _self, _blank, _parent, _top
- Default to _self for backward compatibility
- Add rel='noopener noreferrer' for security when using _blank
- Update documentation
- Closes #12509

* add changeset

* Lint + fix

* Lint

* fix: add link_target parameter to Button template components

- Add link_target to ClearButton, DuplicateButton, LoginButton, DeepLinkButton
- Fixes test_template_component_configs test failure
- Ensures all Button templates have the same parameters as Button

---------

Co-authored-by: gradio-pr-bot <[email protected]>
Co-authored-by: Freddy Boulton <[email protected]>

Author: 3 people

.changeset/empty-jobs-shake.md

@@ -0,0 +1,6 @@
+---
+"@gradio/button": minor
+"gradio": minor
+---
+
+feat:feat: add link_target parameter to Button component

gradio/components/button.py

@@ -34,6 +34,7 @@ def __init__(
         size: Literal["sm", "md", "lg"] = "lg",
         icon: str | Path | None = None,
         link: str | None = None,
+        link_target: Literal["_self", "_blank", "_parent", "_top"] = "_self",
         visible: bool | Literal["hidden"] = True,
         interactive: bool = True,
         elem_id: str | None = None,
@@ -53,6 +54,7 @@ def __init__(
             size: size of the button. Can be "sm", "md", or "lg".
             icon: URL or path to the icon file to display within the button. If None, no icon will be displayed.
             link: URL to open when the button is clicked. If None, no link will be used.
+            link_target: determines where to open the linked URL. "_self" (default, same tab), "_blank" (new tab), "_parent" (parent frame), "_top" (top frame).
             visible: If False, component will be hidden. If "hidden", component will be visually hidden and not take up space in the layout but still exist in the DOM
             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.
@@ -81,6 +83,7 @@ def __init__(
         self.variant = variant
         self.size = size
         self.link = link
+        self.link_target = link_target
 
     @property
     def skip_api(self):

gradio/components/clear_button.py

@@ -40,6 +40,7 @@ def __init__(
         size: Literal["sm", "md", "lg"] = "lg",
         icon: str | Path | None = None,
         link: str | None = None,
+        link_target: Literal["_self", "_blank", "_parent", "_top"] = "_self",
         visible: bool | Literal["hidden"] = True,
         interactive: bool = True,
         elem_id: str | None = None,
@@ -52,6 +53,25 @@ def __init__(
         api_name: str | None = None,
         api_visibility: Literal["public", "private", "undocumented"] = "undocumented",
     ):
+        """
+        Parameters:
+            value: default text for the button to display. If a function is provided, the function will be called each time the app loads to set the initial value of this component.
+            every: continuously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            inputs: components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
+            variant: sets the background and text color of the button. Use 'primary' for main call-to-action buttons, 'secondary' for a more subdued style, 'stop' for a stop button, 'huggingface' for a black background with white text, consistent with Hugging Face's button styles.
+            size: size of the button. Can be "sm", "md", or "lg".
+            icon: URL or path to the icon file to display within the button. If None, no icon will be displayed.
+            link: URL to open when the button is clicked. If None, no link will be used.
+            visible: If False, component will be hidden. If "hidden", component will be visually hidden and not take up space in the layout but still exist in the DOM
+            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.
+            key: in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.
+            preserved_by_key: A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.
+            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.
+        """
         super().__init__(
             value,
             every=every,
@@ -60,6 +80,7 @@ def __init__(
             size=size,
             icon=icon,
             link=link,
+            link_target=link_target,
             visible=visible,
             interactive=interactive,
             elem_id=elem_id,

gradio/components/deep_link_button.py

@@ -39,6 +39,7 @@ def __init__(
         size: Literal["sm", "md", "lg"] = "lg",
         icon: str | Path | None = utils.get_icon_path("link.svg"),
         link: str | None = None,
+        link_target: Literal["_self", "_blank", "_parent", "_top"] = "_self",
         visible: bool | Literal["hidden"] = True,
         interactive: bool = True,
         elem_id: str | None = None,  # noqa: ARG002
@@ -63,6 +64,7 @@ def __init__(
             size=size,
             icon=icon,
             link=link,
+            link_target=link_target,
             visible=visible,
             interactive=interactive,
             elem_id=f"gradio-share-link-button-{self.n_created}",

gradio/components/duplicate_button.py

@@ -34,6 +34,7 @@ def __init__(
         size: Literal["sm", "md", "lg"] = "sm",
         icon: str | Path | None = None,
         link: str | None = None,
+        link_target: Literal["_self", "_blank", "_parent", "_top"] = "_self",
         visible: bool | Literal["hidden"] = True,
         interactive: bool = True,
         elem_id: str | None = None,
@@ -73,6 +74,7 @@ def __init__(
             size=size,
             icon=icon,
             link=link,
+            link_target=link_target,
             visible=visible,
             interactive=interactive,
             elem_id=elem_id,

gradio/components/login_button.py

@@ -49,6 +49,7 @@ def __init__(
         size: Literal["sm", "md", "lg"] = "lg",
         icon: str | Path | None = utils.get_icon_path("huggingface-logo.svg"),
         link: str | None = None,
+        link_target: Literal["_self", "_blank", "_parent", "_top"] = "_self",
         visible: bool | Literal["hidden"] = True,
         interactive: bool = True,
         elem_id: str | None = None,
@@ -72,6 +73,7 @@ def __init__(
             size=size,
             icon=icon,
             link=link,
+            link_target=link_target,
             visible=visible,
             interactive=interactive,
             elem_id=elem_id,

js/button/Index.svelte

@@ -28,6 +28,7 @@
 	min_width={gradio.shared.min_width}
 	visible={gradio.shared.visible}
 	disabled={!gradio.shared.interactive}
+	link_target={gradio.props.link_target}
 	on:click={handle_click}
 >
 	{gradio.props.value ?? ""}

js/button/shared/Button.svelte

@@ -10,6 +10,7 @@
 	export let size: "sm" | "md" | "lg" = "lg";
 	export let value: string | null = null;
 	export let link: string | null = null;
+	export let link_target: "_self" | "_blank" | "_parent" | "_top" = "_self";
 	export let icon: FileData | null = null;
 	export let disabled = false;
 	export let scale: number | null = null;
@@ -19,7 +20,8 @@
 {#if link && link.length > 0}
 	<a
 		href={link}
-		rel="noopener noreferrer"
+		target={link_target}
+		rel={link_target === "_blank" ? "noopener noreferrer" : undefined}
 		class:hidden={visible === false || visible === "hidden"}
 		class:disabled
 		aria-disabled={disabled}