Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify is_external prop in rx.redirect and rx.link #4389

Merged
merged 10 commits into from
Dec 13, 2024
44 changes: 40 additions & 4 deletions reflex/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
overload,
)

import typing_extensions
from typing_extensions import (
Concatenate,
ParamSpec,
Expand Down Expand Up @@ -714,26 +715,61 @@ def fn():
)


@overload
def redirect(
path: str | Var[str],
is_external: Optional[bool] = None,
replace: bool = False,
) -> EventSpec: ...


@overload
@typing_extensions.deprecated("`external` is deprecated use `is_external` instead")
def redirect(
path: str | Var[str],
is_external: Optional[bool] = None,
replace: bool = False,
external: Optional[bool] = None,
) -> EventSpec: ...


def redirect(
path: str | Var[str],
external: Optional[bool] = False,
replace: Optional[bool] = False,
is_external: Optional[bool] = None,
replace: bool = False,
external: Optional[bool] = None,
) -> EventSpec:
"""Redirect to a new path.

Args:
path: The path to redirect to.
external: Whether to open in new tab or not.
is_external: Whether to open in new tab or not.
replace: If True, the current page will not create a new history entry.
external(Deprecated): Whether to open in new tab or not.

Returns:
An event to redirect to the path.
"""
if external is not None:
console.deprecate(
"The `external` prop in `rx.redirect`",
"use `is_external` instead.",
"0.6.6",
"0.7.0",
)

# is_external should take precedence over external.
is_external = (
(False if external is None else external)
if is_external is None
else is_external
)

return server_side(
"_redirect",
get_fn_signature(redirect),
path=path,
external=external,
external=is_external,
replace=replace,
)

Expand Down
Loading