link.pyi 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. """Stub file for reflex/components/chakra/navigation/link.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 reflex.components.chakra import ChakraComponent
  10. from reflex.components.component import Component
  11. from reflex.components.next.link import NextLink
  12. from reflex.utils import imports
  13. from reflex.vars import BaseVar, Var
  14. next_link = NextLink.create()
  15. class Link(ChakraComponent):
  16. @overload
  17. @classmethod
  18. def create( # type: ignore
  19. cls,
  20. *children,
  21. rel: Optional[Union[Var[str], str]] = None,
  22. href: Optional[Union[Var[str], str]] = None,
  23. text: Optional[Union[Var[str], str]] = None,
  24. as_: Optional[Union[Var[str], str]] = None,
  25. is_external: Optional[Union[Var[bool], bool]] = 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_scroll: Optional[
  72. Union[EventHandler, EventSpec, list, function, BaseVar]
  73. ] = None,
  74. on_unmount: Optional[
  75. Union[EventHandler, EventSpec, list, function, BaseVar]
  76. ] = None,
  77. **props
  78. ) -> "Link":
  79. """Create a Link component.
  80. Args:
  81. *children: The children of the component.
  82. rel: The rel.
  83. href: The page to link to.
  84. text: The text to display.
  85. as_: What the link renders to.
  86. is_external: If true, the link will open in new tab.
  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 props of the component.
  94. Raises:
  95. ValueError: in case of missing children
  96. Returns:
  97. Component: The link component
  98. """
  99. ...