DateInput¶
A date picker for selecting calendar dates.
Date:
Basic Usage¶
With Default Value¶
from datetime import date
DateInput(
label="Start Date",
event="filter:start_date",
value=date.today().isoformat(), # "2026-02-03"
)
Date Constraints¶
DateInput(
label="Delivery Date",
event="order:delivery",
min="2026-02-01", # Earliest selectable date
max="2026-12-31", # Latest selectable date
)
Date Range Toolbar¶
from pywry import DateInput, Button, Toolbar
toolbar = Toolbar(
position="top",
items=[
DateInput(
component_id="start-date",
label="From",
event="filter:start",
),
DateInput(
component_id="end-date",
label="To",
event="filter:end",
),
Button(label="Apply", event="filter:apply", variant="primary"),
],
)
Attributes¶
component_id : str | None
Unique identifier for state tracking (auto-generated if not provided)
label : str | None
Display label shown next to the date picker
description : str | None
Tooltip/hover text for accessibility and user guidance
event : str
Event name emitted on date change (format: namespace:event-name)
style : str | None
Optional inline CSS
disabled : bool
Whether the date picker is disabled (default: False)
value : str
Current date value in YYYY-MM-DD format (default: "")
min : str
Earliest selectable date in YYYY-MM-DD format (default: "")
max : str
Latest selectable date in YYYY-MM-DD format (default: "")
Events¶
Emits the event name with payload:
value— selected date as a YYYY-MM-DD string
API Reference¶
Bases: ToolbarItem
A date picker input.
Emits {value: ..., componentId: ...} on date change (YYYY-MM-DD format).
Attributes:
| Name | Type | Description |
|---|---|---|
value |
str
|
Initial date string in YYYY-MM-DD format (default: ""). |
min |
str
|
Earliest selectable date in YYYY-MM-DD format (default: ""). |
max |
str
|
Latest selectable date in YYYY-MM-DD format (default: ""). |
Examples:
>>> DateInput(
... label="Start Date:",
... event="date:start",
... value="2025-01-01",
... min="2020-01-01",
... )
Functions¶
auto_generate_component_id
¶
auto_generate_component_id() -> ToolbarItem
Auto-generate component_id based on type if not provided.
validate_event_name
classmethod
¶
Validate event follows namespace:event-name pattern.