4206afeb7b
* style: shorthand replacements need camelCase Avoid warning on terminal and in browser console from using kebab-case CSS props with emotion. * _rename_props only replace prop name once In case the value also contains the prop name, we don't want to replace it multiple times. * pyi_generator: ignore _rename_props in create signature * Avoid shadowing CSS prop `display` and `gap` Replace usages of `gap` with `spacing` to retain Radix sizing number system, while allowing users to specify a responsive `gap` using CSS units. Remove `display` props from radix components, allowing `display` to accept responsive lists. * checkbox: apply `gap` to `flex` if provided * Remove _rename_props from .create signatures * Fix spacing prop in blank template * Fixup tests after changing style shorthand to return camelCase
123 lines
5.7 KiB
Python
123 lines
5.7 KiB
Python
"""Stub file for reflex/components/next/image.py"""
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `scripts/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
|
|
from typing import Any, Dict, Literal, Optional, Union, overload
|
|
from reflex.vars import Var, BaseVar, ComputedVar
|
|
from reflex.event import EventChain, EventHandler, EventSpec
|
|
from reflex.style import Style
|
|
from typing import Any, Dict, Literal, Optional, Union
|
|
from reflex.utils import types
|
|
from reflex.vars import Var
|
|
from .base import NextComponent
|
|
|
|
class Image(NextComponent):
|
|
def get_event_triggers(self) -> Dict[str, Any]: ...
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
width: Optional[Union[str, int]] = None,
|
|
height: Optional[Union[str, int]] = None,
|
|
src: Optional[Union[Var[Any], Any]] = None,
|
|
alt: Optional[Union[Var[str], str]] = None,
|
|
loader: Optional[Union[Var[Any], Any]] = None,
|
|
fill: Optional[Union[Var[bool], bool]] = None,
|
|
sizes: Optional[Union[Var[str], str]] = None,
|
|
quality: Optional[Union[Var[int], int]] = None,
|
|
priority: Optional[Union[Var[bool], bool]] = None,
|
|
placeholder: Optional[Union[Var[str], str]] = None,
|
|
loading: Optional[
|
|
Union[Var[Literal["lazy", "eager"]], Literal["lazy", "eager"]]
|
|
] = None,
|
|
blurDataURL: Optional[Union[Var[str], str]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_error: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_load: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "Image":
|
|
"""Create an Image component from next/image.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
width: The width of the image.
|
|
height: The height of the image.
|
|
src: This can be either an absolute external URL, or an internal path
|
|
alt: Used to describe the image for screen readers and search engines.
|
|
loader: A custom function used to resolve image URLs.
|
|
fill: A boolean that causes the image to fill the parent element, which is useful when the width and height are unknown. Default to True
|
|
sizes: A string, similar to a media query, that provides information about how wide the image will be at different breakpoints.
|
|
quality: The quality of the optimized image, an integer between 1 and 100, where 100 is the best quality and therefore largest file size. Defaults to 75.
|
|
priority: When true, the image will be considered high priority and preload. Lazy loading is automatically disabled for images using priority.
|
|
placeholder: A placeholder to use while the image is loading. Possible values are blur, empty, or data:image/.... Defaults to empty.
|
|
loading: Allows passing CSS styles to the underlying image element. style: Var[Any] The loading behavior of the image. Defaults to lazy. Can hurt performance, recommended to use `priority` instead.
|
|
blurDataURL: A Data URL to be used as a placeholder image before the src image successfully loads. Only takes effect when combined with placeholder="blur".
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
class_name: The class name for the component.
|
|
autofocus: Whether the component should take the focus once the page is loaded
|
|
custom_attrs: custom attribute
|
|
**props:The props of the component.
|
|
|
|
Returns:
|
|
_type_: _description_
|
|
"""
|
|
...
|