reflex/reflex/experimental/hooks.py
Thomas Brandého b8b3f8910e
add more type annotations through the code (#4401)
* add more type annotations through the code

* add typing in reflex/utils

* misc typing

* more typings

* state typing

* keep typing

* typing init and utils

* more typing for components

* fix attempt for 3.9

* need more __future

* more typings

* type event plz

* type model

* type vars/base.py

* enable 'ANN001' for reflex folder (ignore tests and benchmarks)

* fix pyi

* add missing annotations

* use more precise error when ignoring
2025-01-29 01:12:47 +01:00

92 lines
2.3 KiB
Python

"""Add standard Hooks wrapper for React."""
from __future__ import annotations
from reflex.utils.imports import ImportVar
from reflex.vars import VarData
from reflex.vars.base import Var
def _compose_react_imports(tags: list[str]) -> dict[str, list[ImportVar]]:
return {"react": [ImportVar(tag=tag) for tag in tags]}
def const(name: str | list[str], value: str | Var) -> Var:
"""Create a constant Var.
Args:
name: The name of the constant.
value: The value of the constant.
Returns:
The constant Var.
"""
if isinstance(name, list):
return Var(_js_expr=f"const [{', '.join(name)}] = {value}")
return Var(_js_expr=f"const {name} = {value}")
def useCallback(func: str, deps: list) -> Var: # noqa: N802
"""Create a useCallback hook with a function and dependencies.
Args:
func: The function to wrap.
deps: The dependencies of the function.
Returns:
The useCallback hook.
"""
return Var(
_js_expr=f"useCallback({func}, {deps})" if deps else f"useCallback({func})",
_var_data=VarData(imports=_compose_react_imports(["useCallback"])),
)
def useContext(context: str) -> Var: # noqa: N802
"""Create a useContext hook with a context.
Args:
context: The context to use.
Returns:
The useContext hook.
"""
return Var(
_js_expr=f"useContext({context})",
_var_data=VarData(imports=_compose_react_imports(["useContext"])),
)
def useRef(default: str) -> Var: # noqa: N802
"""Create a useRef hook with a default value.
Args:
default: The default value of the ref.
Returns:
The useRef hook.
"""
return Var(
_js_expr=f"useRef({default})",
_var_data=VarData(imports=_compose_react_imports(["useRef"])),
)
def useState(var_name: str, default: str | None = None) -> Var: # noqa: N802
"""Create a useState hook with a variable name and setter name.
Args:
var_name: The name of the variable.
default: The default value of the variable.
Returns:
A useState hook.
"""
return const(
[var_name, f"set{var_name.capitalize()}"],
Var(
_js_expr=f"useState({default})",
_var_data=VarData(imports=_compose_react_imports(["useState"])),
),
)