"""Predefined button to sign out from Hugging Face in a Gradio Space."""
from __future__ import annotations
import warnings
from typing import Literal
from gradio_client.documentation import document
from gradio.components import Button
from gradio.events import Dependency
@document()
class LogoutButton(Button):
"""
Creates a Button to log out a user from a Space using OAuth.
Note: `LogoutButton` component is deprecated. Please use `gr.LoginButton` instead
which handles both the login and logout processes.
"""
is_template = True
def __init__(
self,
value: str = "Logout",
*,
every: float | None = None,
variant: Literal["primary", "secondary", "stop"] = "secondary",
size: Literal["sm", "lg"] | None = None,
icon: str
| None = "https://huggingface.co/front/assets/huggingface_logo-noborder.svg",
# Link to logout page (which will delete the session cookie and redirect to landing page).
link: str | None = "/logout",
visible: bool = True,
interactive: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
render: bool = True,
scale: int | None = 0,
min_width: int | None = None,
):
warnings.warn(
"The `gr.LogoutButton` component is deprecated. Please use `gr.LoginButton` instead which handles both the login and logout processes."
)
super().__init__(
value,
every=every,
variant=variant,
size=size,
icon=icon,
link=link,
visible=visible,
interactive=interactive,
elem_id=elem_id,
elem_classes=elem_classes,
render=render,
scale=scale,
min_width=min_width,
)