123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- """Stub file for reflex/components/base/script.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 Component
- from reflex.event import EventType
- from reflex.style import Style
- from reflex.vars.base import Var
- class Script(Component):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- src: Optional[Union[Var[str], str]] = None,
- strategy: Optional[
- Union[
- Literal["afterInteractive", "beforeInteractive", "lazyOnload"],
- Var[Literal["afterInteractive", "beforeInteractive", "lazyOnload"]],
- ]
- ] = 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[()]] = None,
- on_click: Optional[EventType[()]] = None,
- on_context_menu: Optional[EventType[()]] = None,
- on_double_click: Optional[EventType[()]] = None,
- on_error: Optional[EventType[()]] = None,
- on_focus: Optional[EventType[()]] = None,
- on_load: Optional[EventType[()]] = None,
- on_mount: Optional[EventType[()]] = None,
- on_mouse_down: Optional[EventType[()]] = None,
- on_mouse_enter: Optional[EventType[()]] = None,
- on_mouse_leave: Optional[EventType[()]] = None,
- on_mouse_move: Optional[EventType[()]] = None,
- on_mouse_out: Optional[EventType[()]] = None,
- on_mouse_over: Optional[EventType[()]] = None,
- on_mouse_up: Optional[EventType[()]] = None,
- on_ready: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "Script":
- """Create an inline or user-defined script.
- If a string is provided as the first child, it will be rendered as an inline script
- otherwise the `src` prop must be provided.
- The following event triggers are provided:
- on_load: Execute code after the script has finished loading.
- on_ready: Execute code after the script has finished loading and every
- time the component is mounted.
- on_error: Execute code if the script fails to load.
- Args:
- *children: The children of the component.
- src: Required unless inline script is used
- strategy: When the script will execute: afterInteractive (defer-like behavior) | beforeInteractive | lazyOnload (async-like behavior)
- on_load: Triggered when the script is loading
- on_ready: Triggered when the script has loaded
- on_error: Triggered when the script has errored
- style: The style of the component.
- key: A unique key for the component.
- id: The id for the component.
- class_name: The class name for the component.
- autofocus: Whether the component should take the focus once the page is loaded
- custom_attrs: custom attribute
- **props: The props of the component.
- Returns:
- The component.
- Raises:
- ValueError: when neither children nor `src` are specified.
- """
- ...
- script = Script.create
|