clipboard.pyi 4.0 KB

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