react_player.pyi 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. """Stub file for reflex/components/react_player/react_player.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Callable, Dict, Optional, Union, overload
  6. from reflex.components.component import NoSSRComponent
  7. from reflex.event import EventHandler, EventSpec
  8. from reflex.style import Style
  9. from reflex.vars.base import Var
  10. class ReactPlayer(NoSSRComponent):
  11. @overload
  12. @classmethod
  13. def create( # type: ignore
  14. cls,
  15. *children,
  16. url: Optional[Union[Var[str], str]] = None,
  17. playing: Optional[Union[Var[bool], bool]] = None,
  18. loop: Optional[Union[Var[bool], bool]] = None,
  19. controls: Optional[Union[Var[bool], bool]] = None,
  20. light: Optional[Union[Var[bool], bool]] = None,
  21. volume: Optional[Union[Var[float], float]] = None,
  22. muted: Optional[Union[Var[bool], bool]] = None,
  23. width: Optional[Union[Var[str], str]] = None,
  24. height: Optional[Union[Var[str], str]] = None,
  25. style: Optional[Style] = None,
  26. key: Optional[Any] = None,
  27. id: Optional[Any] = None,
  28. class_name: Optional[Any] = None,
  29. autofocus: Optional[bool] = None,
  30. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  31. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  32. on_buffer: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  33. on_buffer_end: Optional[
  34. Union[EventHandler, EventSpec, list, Callable, Var]
  35. ] = None,
  36. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  37. on_click_preview: Optional[
  38. Union[EventHandler, EventSpec, list, Callable, Var]
  39. ] = None,
  40. on_context_menu: Optional[
  41. Union[EventHandler, EventSpec, list, Callable, Var]
  42. ] = None,
  43. on_disable_pip: Optional[
  44. Union[EventHandler, EventSpec, list, Callable, Var]
  45. ] = None,
  46. on_double_click: Optional[
  47. Union[EventHandler, EventSpec, list, Callable, Var]
  48. ] = None,
  49. on_duration: Optional[
  50. Union[EventHandler, EventSpec, list, Callable, Var]
  51. ] = None,
  52. on_enable_pip: Optional[
  53. Union[EventHandler, EventSpec, list, Callable, Var]
  54. ] = None,
  55. on_ended: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  56. on_error: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  57. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  58. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  59. on_mouse_down: Optional[
  60. Union[EventHandler, EventSpec, list, Callable, Var]
  61. ] = None,
  62. on_mouse_enter: Optional[
  63. Union[EventHandler, EventSpec, list, Callable, Var]
  64. ] = None,
  65. on_mouse_leave: Optional[
  66. Union[EventHandler, EventSpec, list, Callable, Var]
  67. ] = None,
  68. on_mouse_move: Optional[
  69. Union[EventHandler, EventSpec, list, Callable, Var]
  70. ] = None,
  71. on_mouse_out: Optional[
  72. Union[EventHandler, EventSpec, list, Callable, Var]
  73. ] = None,
  74. on_mouse_over: Optional[
  75. Union[EventHandler, EventSpec, list, Callable, Var]
  76. ] = None,
  77. on_mouse_up: Optional[
  78. Union[EventHandler, EventSpec, list, Callable, Var]
  79. ] = None,
  80. on_pause: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  81. on_play: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  82. on_playback_quality_change: Optional[
  83. Union[EventHandler, EventSpec, list, Callable, Var]
  84. ] = None,
  85. on_playback_rate_change: Optional[
  86. Union[EventHandler, EventSpec, list, Callable, Var]
  87. ] = None,
  88. on_progress: Optional[
  89. Union[EventHandler, EventSpec, list, Callable, Var]
  90. ] = None,
  91. on_ready: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  92. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  93. on_seek: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  94. on_start: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  95. on_unmount: Optional[
  96. Union[EventHandler, EventSpec, list, Callable, Var]
  97. ] = None,
  98. **props,
  99. ) -> "ReactPlayer":
  100. """Create the component.
  101. Args:
  102. *children: The children of the component.
  103. url: The url of a video or song to play
  104. playing: Set to true or false to pause or play the media
  105. loop: Set to true or false to loop the media
  106. controls: Set to true or false to display native player controls.
  107. light: Set to true to show just the video thumbnail, which loads the full player on click
  108. volume: Set the volume of the player, between 0 and 1
  109. muted: Mutes the player
  110. width: Set the width of the player: ex:640px
  111. height: Set the height of the player: ex:640px
  112. style: The style of the component.
  113. key: A unique key for the component.
  114. id: The id for the component.
  115. class_name: The class name for the component.
  116. autofocus: Whether the component should take the focus once the page is loaded
  117. custom_attrs: custom attribute
  118. **props: The props of the component.
  119. Returns:
  120. The component.
  121. """
  122. ...