script.pyi 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. """Stub file for script.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `scripts/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Optional, Union, overload
  6. from reflex.components.component import Component
  7. from reflex.vars import Var, BaseVar, ComputedVar
  8. from reflex.event import EventHandler, EventChain, EventSpec
  9. def client_side(javascript_code) -> Var[EventChain]: ...
  10. class Script(Component):
  11. @overload
  12. @classmethod
  13. def create(cls, *children, src: Optional[Union[Var[str], str]] = None, strategy: Optional[Union[Var[str], str]] = None, on_blur: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_click: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_context_menu: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_double_click: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_error: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_focus: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_load: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mount: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_down: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_enter: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_leave: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_move: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_out: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_over: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_mouse_up: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_ready: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_scroll: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, on_unmount: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, **props) -> "Script": # type: ignore
  14. """Create an inline or user-defined script.
  15. If a string is provided as the first child, it will be rendered as an inline script
  16. otherwise the `src` prop must be provided.
  17. The following event triggers are provided:
  18. on_load: Execute code after the script has finished loading.
  19. on_ready: Execute code after the script has finished loading and every
  20. time the component is mounted.
  21. on_error: Execute code if the script fails to load.
  22. Args:
  23. *children: The children of the component.
  24. src: Required unless inline script is used
  25. strategy: When the script will execute: afterInteractive | beforeInteractive | lazyOnload
  26. **props: The props of the component.
  27. Returns:
  28. The component.
  29. Raises:
  30. ValueError: when neither children nor `src` are specified.
  31. """
  32. ...