html.pyi 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. """Stub file for reflex/components/core/html.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Dict, Optional, Union, overload
  6. from reflex.components.el.elements.typography import Div
  7. from reflex.event import BASE_STATE, EventType
  8. from reflex.style import Style
  9. from reflex.vars.base import Var
  10. class Html(Div):
  11. @overload
  12. @classmethod
  13. def create( # type: ignore
  14. cls,
  15. *children,
  16. dangerouslySetInnerHTML: Optional[
  17. Union[Dict[str, str], Var[Dict[str, str]]]
  18. ] = None,
  19. access_key: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  20. auto_capitalize: Optional[
  21. Union[Var[Union[bool, int, str]], bool, int, str]
  22. ] = None,
  23. content_editable: Optional[
  24. Union[Var[Union[bool, int, str]], bool, int, str]
  25. ] = None,
  26. context_menu: Optional[
  27. Union[Var[Union[bool, int, str]], bool, int, str]
  28. ] = None,
  29. dir: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  30. draggable: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  31. enter_key_hint: Optional[
  32. Union[Var[Union[bool, int, str]], bool, int, str]
  33. ] = None,
  34. hidden: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  35. input_mode: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  36. item_prop: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  37. lang: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  38. role: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  39. slot: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  40. spell_check: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  41. tab_index: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  42. title: Optional[Union[Var[Union[bool, int, str]], bool, int, str]] = None,
  43. style: Optional[Style] = None,
  44. key: Optional[Any] = None,
  45. id: Optional[Any] = None,
  46. class_name: Optional[Any] = None,
  47. autofocus: Optional[bool] = None,
  48. custom_attrs: Optional[Dict[str, Union[Var, Any]]] = None,
  49. on_blur: Optional[EventType[[], BASE_STATE]] = None,
  50. on_click: Optional[EventType[[], BASE_STATE]] = None,
  51. on_context_menu: Optional[EventType[[], BASE_STATE]] = None,
  52. on_double_click: Optional[EventType[[], BASE_STATE]] = None,
  53. on_focus: Optional[EventType[[], BASE_STATE]] = None,
  54. on_mount: Optional[EventType[[], BASE_STATE]] = None,
  55. on_mouse_down: Optional[EventType[[], BASE_STATE]] = None,
  56. on_mouse_enter: Optional[EventType[[], BASE_STATE]] = None,
  57. on_mouse_leave: Optional[EventType[[], BASE_STATE]] = None,
  58. on_mouse_move: Optional[EventType[[], BASE_STATE]] = None,
  59. on_mouse_out: Optional[EventType[[], BASE_STATE]] = None,
  60. on_mouse_over: Optional[EventType[[], BASE_STATE]] = None,
  61. on_mouse_up: Optional[EventType[[], BASE_STATE]] = None,
  62. on_scroll: Optional[EventType[[], BASE_STATE]] = None,
  63. on_unmount: Optional[EventType[[], BASE_STATE]] = None,
  64. **props,
  65. ) -> "Html":
  66. """Create a html component.
  67. Args:
  68. *children: The children of the component.
  69. dangerouslySetInnerHTML: The HTML to render.
  70. access_key: Provides a hint for generating a keyboard shortcut for the current element.
  71. auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
  72. content_editable: Indicates whether the element's content is editable.
  73. context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
  74. dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
  75. draggable: Defines whether the element can be dragged.
  76. enter_key_hint: Hints what media types the media element is able to play.
  77. hidden: Defines whether the element is hidden.
  78. input_mode: Defines the type of the element.
  79. item_prop: Defines the name of the element for metadata purposes.
  80. lang: Defines the language used in the element.
  81. role: Defines the role of the element.
  82. slot: Assigns a slot in a shadow DOM shadow tree to an element.
  83. spell_check: Defines whether the element may be checked for spelling errors.
  84. tab_index: Defines the position of the current element in the tabbing order.
  85. title: Defines a tooltip for the element.
  86. style: The style of the component.
  87. key: A unique key for the component.
  88. id: The id for the component.
  89. class_name: The class name for the component.
  90. autofocus: Whether the component should take the focus once the page is loaded
  91. custom_attrs: custom attribute
  92. **props: The props to pass to the component.
  93. Returns:
  94. The html component.
  95. Raises:
  96. ValueError: If children are not provided or more than one child is provided.
  97. """
  98. ...
  99. html = Html.create