ef93161840
* add the watermark class
* remove shortcut exposing badge publicly for now
* Rename as "sticky" because "watermark" has a negative connotation
* Add config `show_built_with_reflex`
This config option is available for authenticated users on various plan tiers
* py3.11 compatible f-string
* sticky badge inherit from A instead of using on_click/redirect
* fix integration test
* Move export checking logic to reflex CLI
* rx.logo: make it accessible to screen readers
Add role="img" aria_label="Reflex" and title="Reflex".
* Hide the built with reflex badge for localhost
* Revert "fix integration test"
This reverts commit a978684d70.
* experimental: do not show warning for internal imports
Only show experimental feature warnings when accessing the names through the
rx._x namespace.
If reflex internally imports the names via deep imports, then this bypasses the
warning to avoid showing it to users that have no control over how the
framework uses experimental features.
* add help link for show_built_with_reflex option
* pre-commit fixes
---------
Co-authored-by: Masen Furer <m_github@0x26.net>
450 lines
19 KiB
Python
450 lines
19 KiB
Python
"""Stub file for reflex/components/core/sticky.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
from typing import Any, Dict, Literal, Optional, Union, overload
|
|
|
|
from reflex.components.component import ComponentNamespace
|
|
from reflex.components.core.breakpoints import Breakpoints
|
|
from reflex.components.el.elements.inline import A
|
|
from reflex.components.el.elements.media import Svg
|
|
from reflex.components.radix.themes.typography.text import Text
|
|
from reflex.event import BASE_STATE, EventType
|
|
from reflex.style import Style
|
|
from reflex.vars.base import Var
|
|
|
|
class StickyLogo(Svg):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
width: Optional[Union[Var[Union[int, str]], int, str]] = None,
|
|
height: Optional[Union[Var[Union[int, str]], int, str]] = None,
|
|
xmlns: Optional[Union[Var[str], str]] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = None,
|
|
**props,
|
|
) -> "StickyLogo":
|
|
"""Create the simple Reflex logo SVG.
|
|
|
|
Returns:
|
|
The simple Reflex logo SVG.
|
|
"""
|
|
...
|
|
|
|
def add_style(self): ...
|
|
|
|
class StickyLabel(Text):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
as_child: Optional[Union[Var[bool], bool]] = None,
|
|
as_: Optional[
|
|
Union[
|
|
Literal[
|
|
"abbr",
|
|
"b",
|
|
"cite",
|
|
"del",
|
|
"div",
|
|
"em",
|
|
"i",
|
|
"ins",
|
|
"kbd",
|
|
"label",
|
|
"mark",
|
|
"p",
|
|
"s",
|
|
"samp",
|
|
"span",
|
|
"sub",
|
|
"sup",
|
|
"u",
|
|
],
|
|
Var[
|
|
Literal[
|
|
"abbr",
|
|
"b",
|
|
"cite",
|
|
"del",
|
|
"div",
|
|
"em",
|
|
"i",
|
|
"ins",
|
|
"kbd",
|
|
"label",
|
|
"mark",
|
|
"p",
|
|
"s",
|
|
"samp",
|
|
"span",
|
|
"sub",
|
|
"sup",
|
|
"u",
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
size: Optional[
|
|
Union[
|
|
Breakpoints[str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]],
|
|
Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
|
|
Var[
|
|
Union[
|
|
Breakpoints[
|
|
str, Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"]
|
|
],
|
|
Literal["1", "2", "3", "4", "5", "6", "7", "8", "9"],
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
weight: Optional[
|
|
Union[
|
|
Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
|
|
Literal["bold", "light", "medium", "regular"],
|
|
Var[
|
|
Union[
|
|
Breakpoints[str, Literal["bold", "light", "medium", "regular"]],
|
|
Literal["bold", "light", "medium", "regular"],
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
align: Optional[
|
|
Union[
|
|
Breakpoints[str, Literal["center", "left", "right"]],
|
|
Literal["center", "left", "right"],
|
|
Var[
|
|
Union[
|
|
Breakpoints[str, Literal["center", "left", "right"]],
|
|
Literal["center", "left", "right"],
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
trim: Optional[
|
|
Union[
|
|
Breakpoints[str, Literal["both", "end", "normal", "start"]],
|
|
Literal["both", "end", "normal", "start"],
|
|
Var[
|
|
Union[
|
|
Breakpoints[str, Literal["both", "end", "normal", "start"]],
|
|
Literal["both", "end", "normal", "start"],
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
color_scheme: Optional[
|
|
Union[
|
|
Literal[
|
|
"amber",
|
|
"blue",
|
|
"bronze",
|
|
"brown",
|
|
"crimson",
|
|
"cyan",
|
|
"gold",
|
|
"grass",
|
|
"gray",
|
|
"green",
|
|
"indigo",
|
|
"iris",
|
|
"jade",
|
|
"lime",
|
|
"mint",
|
|
"orange",
|
|
"pink",
|
|
"plum",
|
|
"purple",
|
|
"red",
|
|
"ruby",
|
|
"sky",
|
|
"teal",
|
|
"tomato",
|
|
"violet",
|
|
"yellow",
|
|
],
|
|
Var[
|
|
Literal[
|
|
"amber",
|
|
"blue",
|
|
"bronze",
|
|
"brown",
|
|
"crimson",
|
|
"cyan",
|
|
"gold",
|
|
"grass",
|
|
"gray",
|
|
"green",
|
|
"indigo",
|
|
"iris",
|
|
"jade",
|
|
"lime",
|
|
"mint",
|
|
"orange",
|
|
"pink",
|
|
"plum",
|
|
"purple",
|
|
"red",
|
|
"ruby",
|
|
"sky",
|
|
"teal",
|
|
"tomato",
|
|
"violet",
|
|
"yellow",
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
high_contrast: Optional[Union[Var[bool], bool]] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = None,
|
|
**props,
|
|
) -> "StickyLabel":
|
|
"""Create the sticky label.
|
|
|
|
Returns:
|
|
The sticky label.
|
|
"""
|
|
...
|
|
|
|
def add_style(self): ...
|
|
|
|
class StickyBadge(A):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
download: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
href: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
href_lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
media: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
ping: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
referrer_policy: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
rel: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
shape: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = None,
|
|
**props,
|
|
) -> "StickyBadge":
|
|
"""Create the sticky badge.
|
|
|
|
Returns:
|
|
The sticky badge.
|
|
"""
|
|
...
|
|
|
|
def add_style(self): ...
|
|
|
|
class StickyNamespace(ComponentNamespace):
|
|
label = staticmethod(StickyLabel.create)
|
|
logo = staticmethod(StickyLogo.create)
|
|
|
|
@staticmethod
|
|
def __call__(
|
|
*children,
|
|
download: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
href: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
href_lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
media: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
ping: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
referrer_policy: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
rel: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
shape: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
target: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], bool, int, str]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
|
|
on_blur: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_double_click: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_focus: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mount: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_scroll: Optional[EventType[[], BASE_STATE]] = None,
|
|
on_unmount: Optional[EventType[[], BASE_STATE]] = None,
|
|
**props,
|
|
) -> "StickyBadge":
|
|
"""Create the sticky badge.
|
|
|
|
Returns:
|
|
The sticky badge.
|
|
"""
|
|
...
|
|
|
|
sticky = StickyNamespace()
|