clipboard.pyi 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. """Stub file for reflex/components/core/clipboard.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Dict, Literal, Optional, Union, overload
  6. from reflex.vars import Var, BaseVar, ComputedVar
  7. from reflex.event import EventChain, EventHandler, EventSpec
  8. from reflex.style import Style
  9. from typing import Dict, List, Union
  10. from reflex.components.base.fragment import Fragment
  11. from reflex.components.tags.tag import Tag
  12. from reflex.event import EventChain, EventHandler
  13. from reflex.utils.format import format_prop, wrap
  14. from reflex.utils.imports import ImportVar
  15. from reflex.vars import Var, get_unique_variable_name
  16. class Clipboard(Fragment):
  17. @overload
  18. @classmethod
  19. def create( # type: ignore
  20. cls,
  21. *children,
  22. targets: Optional[Union[Var[List[str]], List[str]]] = None,
  23. on_paste_event_actions: Optional[
  24. Union[Var[Dict[str, Union[bool, int]]], Dict[str, Union[bool, int]]]
  25. ] = None,
  26. style: Optional[Style] = None,
  27. key: Optional[Any] = None,
  28. id: Optional[Any] = None,
  29. class_name: Optional[Any] = None,
  30. autofocus: Optional[bool] = None,
  31. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  32. on_blur: Optional[
  33. Union[EventHandler, EventSpec, list, function, BaseVar]
  34. ] = None,
  35. on_click: Optional[
  36. Union[EventHandler, EventSpec, list, function, BaseVar]
  37. ] = None,
  38. on_context_menu: Optional[
  39. Union[EventHandler, EventSpec, list, function, BaseVar]
  40. ] = None,
  41. on_double_click: Optional[
  42. Union[EventHandler, EventSpec, list, function, BaseVar]
  43. ] = None,
  44. on_focus: Optional[
  45. Union[EventHandler, EventSpec, list, function, BaseVar]
  46. ] = None,
  47. on_mount: Optional[
  48. Union[EventHandler, EventSpec, list, function, BaseVar]
  49. ] = None,
  50. on_mouse_down: Optional[
  51. Union[EventHandler, EventSpec, list, function, BaseVar]
  52. ] = None,
  53. on_mouse_enter: Optional[
  54. Union[EventHandler, EventSpec, list, function, BaseVar]
  55. ] = None,
  56. on_mouse_leave: Optional[
  57. Union[EventHandler, EventSpec, list, function, BaseVar]
  58. ] = None,
  59. on_mouse_move: Optional[
  60. Union[EventHandler, EventSpec, list, function, BaseVar]
  61. ] = None,
  62. on_mouse_out: Optional[
  63. Union[EventHandler, EventSpec, list, function, BaseVar]
  64. ] = None,
  65. on_mouse_over: Optional[
  66. Union[EventHandler, EventSpec, list, function, BaseVar]
  67. ] = None,
  68. on_mouse_up: Optional[
  69. Union[EventHandler, EventSpec, list, function, BaseVar]
  70. ] = None,
  71. on_paste: Optional[
  72. Union[EventHandler, EventSpec, list, function, BaseVar]
  73. ] = None,
  74. on_scroll: Optional[
  75. Union[EventHandler, EventSpec, list, function, BaseVar]
  76. ] = None,
  77. on_unmount: Optional[
  78. Union[EventHandler, EventSpec, list, function, BaseVar]
  79. ] = None,
  80. **props
  81. ) -> "Clipboard":
  82. """Create a Clipboard component.
  83. Args:
  84. *children: The children of the component.
  85. targets: The element ids to attach the event listener to. Defaults to all child components or the document.
  86. on_paste_event_actions: Save the original event actions for the on_paste event.
  87. style: The style of the component.
  88. key: A unique key for the component.
  89. id: The id for the component.
  90. class_name: The class name for the component.
  91. autofocus: Whether the component should take the focus once the page is loaded
  92. custom_attrs: custom attribute
  93. **props: The properties of the component.
  94. Returns:
  95. The Clipboard Component.
  96. """
  97. ...
  98. def add_imports(self) -> dict[str, ImportVar]: ...
  99. def add_hooks(self) -> list[str]: ...
  100. clipboard = Clipboard.create