147 lines
7.7 KiB
Python
147 lines
7.7 KiB
Python
"""Stub file for reflex_components_moment/moment.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
import dataclasses
|
|
import datetime
|
|
from collections.abc import Mapping, Sequence
|
|
from typing import Any
|
|
|
|
from reflex_base.components.component import NoSSRComponent
|
|
from reflex_base.event import EventType, PointerEventInfo
|
|
from reflex_base.utils.imports import ImportDict
|
|
from reflex_base.vars.base import Var
|
|
from reflex_components_core.core.breakpoints import Breakpoints
|
|
|
|
@dataclasses.dataclass(frozen=True)
|
|
class MomentDelta:
|
|
years: int | None
|
|
quarters: int | None
|
|
months: int | None
|
|
weeks: int | None
|
|
days: int | None
|
|
hours: int | None
|
|
minutes: int | None
|
|
seconds: int | None
|
|
milliseconds: int | None
|
|
|
|
class Moment(NoSSRComponent):
|
|
def add_imports(self) -> ImportDict: ...
|
|
@classmethod
|
|
def create(
|
|
cls,
|
|
*children,
|
|
interval: Var[int] | int | None = None,
|
|
format: Var[str] | str | None = None,
|
|
trim: Var[bool] | bool | None = None,
|
|
parse: Var[str] | str | None = None,
|
|
add: MomentDelta | Var[MomentDelta] | None = None,
|
|
subtract: MomentDelta | Var[MomentDelta] | None = None,
|
|
from_now: Var[bool] | bool | None = None,
|
|
from_now_short: Var[bool] | bool | None = None,
|
|
from_now_during: Var[int] | int | None = None,
|
|
to_now: Var[bool] | bool | None = None,
|
|
with_title: Var[bool] | bool | None = None,
|
|
title_format: Var[str] | str | None = None,
|
|
diff: Var[str] | str | None = None,
|
|
decimal: Var[bool] | bool | None = None,
|
|
unit: Var[str] | str | None = None,
|
|
duration: Var[str] | str | None = None,
|
|
date: Var[
|
|
datetime.date | datetime.datetime | datetime.time | datetime.timedelta | str
|
|
]
|
|
| datetime.date
|
|
| datetime.datetime
|
|
| datetime.time
|
|
| datetime.timedelta
|
|
| str
|
|
| None = None,
|
|
duration_from_now: Var[bool] | bool | None = None,
|
|
unix: Var[bool] | bool | None = None,
|
|
local: Var[bool] | bool | None = None,
|
|
tz: Var[str] | str | None = None,
|
|
locale: Var[str] | str | None = None,
|
|
style: Sequence[Mapping[str, Any]]
|
|
| Mapping[str, Any]
|
|
| Var[Mapping[str, Any]]
|
|
| Breakpoints
|
|
| None = None,
|
|
key: Any | None = None,
|
|
id: Any | None = None,
|
|
ref: Var | None = None,
|
|
class_name: Any | None = None,
|
|
custom_attrs: dict[str, Any | Var] | None = None,
|
|
on_blur: EventType[()] | None = None,
|
|
on_change: EventType[()] | EventType[str] | None = None,
|
|
on_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_context_menu: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_double_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_focus: EventType[()] | None = None,
|
|
on_mount: EventType[()] | None = None,
|
|
on_mouse_down: EventType[()] | None = None,
|
|
on_mouse_enter: EventType[()] | None = None,
|
|
on_mouse_leave: EventType[()] | None = None,
|
|
on_mouse_move: EventType[()] | None = None,
|
|
on_mouse_out: EventType[()] | None = None,
|
|
on_mouse_over: EventType[()] | None = None,
|
|
on_mouse_up: EventType[()] | None = None,
|
|
on_scroll: EventType[()] | None = None,
|
|
on_scroll_end: EventType[()] | None = None,
|
|
on_unmount: EventType[()] | None = None,
|
|
**props,
|
|
) -> Moment:
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
interval: How often the date update (how often time update / 0 to disable).
|
|
format: Formats the date according to the given format string.
|
|
trim: When formatting duration time, the largest-magnitude tokens are automatically trimmed when they have no value.
|
|
parse: Use the parse attribute to tell moment how to parse the given date when non-standard.
|
|
add: Add a delta to the base date (keys are "years", "quarters", "months", "weeks", "days", "hours", "minutes", "seconds")
|
|
subtract: Subtract a delta to the base date (keys are "years", "quarters", "months", "weeks", "days", "hours", "minutes", "seconds")
|
|
from_now: Displays the date as the time from now, e.g. "5 minutes ago".
|
|
from_now_short: Displays the relative time in a short format using abbreviated units (e.g., "1h", "2d", "3mo", "1y" instead of "1 hour ago", "2 days ago", etc.).
|
|
from_now_during: Setting fromNowDuring will display the relative time as with fromNow but just during its value in milliseconds, after that format will be used instead.
|
|
to_now: Similar to fromNow, but gives the opposite interval.
|
|
with_title: Adds a title attribute to the element with the complete date.
|
|
title_format: How the title date is formatted when using the withTitle attribute.
|
|
diff: Show the different between this date and the rendered child.
|
|
decimal: Display the diff as decimal.
|
|
unit: Display the diff in given unit.
|
|
duration: Shows the duration (elapsed time) between two dates. duration property should be behind date property time-wise.
|
|
date: The date to display (also work if passed as children).
|
|
duration_from_now: Shows the duration (elapsed time) between now and the provided datetime.
|
|
unix: Tells Moment to parse the given date value as a unix timestamp.
|
|
local: Outputs the result in local time.
|
|
tz: Display the date in the given timezone.
|
|
locale: The locale to use when rendering.
|
|
style: The style of the component.
|
|
key: A unique key for the component.
|
|
id: The id for the component.
|
|
ref: The Var to pass as the ref to the component.
|
|
class_name: The class name for the component.
|
|
custom_attrs: Attributes passed directly to the component.
|
|
on_focus: Fired when the element (or some element inside of it) receives focus. For example, it is called when the user clicks on a text input.
|
|
on_blur: Fired when focus has left the element (or left some element inside of it). For example, it is called when the user clicks outside of a focused text input.
|
|
on_click: Fired when the user clicks on an element. For example, it's called when the user clicks on a button.
|
|
on_context_menu: Fired when the user right-clicks on an element.
|
|
on_double_click: Fired when the user double-clicks on an element.
|
|
on_mouse_down: Fired when the user presses a mouse button on an element.
|
|
on_mouse_enter: Fired when the mouse pointer enters the element.
|
|
on_mouse_leave: Fired when the mouse pointer leaves the element.
|
|
on_mouse_move: Fired when the mouse pointer moves over the element.
|
|
on_mouse_out: Fired when the mouse pointer moves out of the element.
|
|
on_mouse_over: Fired when the mouse pointer moves onto the element.
|
|
on_mouse_up: Fired when the user releases a mouse button on an element.
|
|
on_scroll: Fired when the user scrolls the element.
|
|
on_scroll_end: Fired when scrolling ends on the element.
|
|
on_mount: Fired when the component is mounted to the page.
|
|
on_unmount: Fired when the component is removed from the page. Only called during navigation, not on page refresh.
|
|
on_change: Fires when the date changes.
|
|
**props: The props of the component.
|
|
|
|
Returns:
|
|
The component.
|
|
"""
|