dazzler.components.calendar package¶
- class dazzler.components.calendar.Calendar(month_timestamp=undefined, selected=undefined, month_format='MMMM YYYY', week_labels=undefined, use_selected=True, class_name=undefined, style=undefined, identity=None)[source]¶
Bases:
dazzler.system._component.Component
Display a calendar based on the month of a timestamp.
- CSS
dazzler-calendar-calendar
calendar-header
month-label
week-labels
week-label
calendar-day
selected-day
week-rows
calendar-week
empty
- __init__(month_timestamp=undefined, selected=undefined, month_format='MMMM YYYY', week_labels=undefined, use_selected=True, class_name=undefined, style=undefined, identity=None)[source]¶
- Parameters
month_timestamp (
Union
[float
,int
,None
]) – Timestamp of the month to show. If not supplied is today.selected (
Optional
[Dict
[str
,Union
[float
,int
]]]) – The currently selected day as an objectmonth_format (
Optional
[str
]) – Formatting of the month label (default=’MMMM YYYY’)week_labels (
Optional
[List
[str
]]) – Labels for the week, starting from sunday. (default=[‘Su’, ‘Mo’, ‘Tu’, ‘We’, ‘Th’, ‘Fr’, ‘Sa’])use_selected (
Optional
[bool
]) – Whether to set selected aspect on click/start up. This will disable highlight of day in the calendar. (default=True)class_name (
Optional
[str
]) – Class name automatically added by dazzler api with a prefix for the component library. ie: core component Container becomedazzler-core-container
. When added on the component, the class names will be concatenated.style (
Optional
[Dict
]) – Style object for the top level wrapper of the component.
- class_name¶
Class name automatically added by dazzler api with a prefix for the component library.ie: core component Container become
dazzler-core-container
.When added on the component, the class names will be concatenated.
- month_format¶
Formatting of the month label (default=’MMMM YYYY’)
- month_timestamp¶
Timestamp of the month to show. If not supplied is today.
- selected¶
The currently selected day as an object
- style¶
Style object for the top level wrapper of the component.
- use_selected¶
Whether to set selected aspect on click/start up.This will disable highlight of day in the calendar. (default=True)
- week_labels¶
Labels for the week, starting from sunday. (default=[‘Su’, ‘Mo’, ‘Tu’, ‘We’, ‘Th’, ‘Fr’, ‘Sa’])
- class dazzler.components.calendar.DatePicker(value=undefined, opened=undefined, date_format='DD MMM YYYY', class_name=undefined, style=undefined, identity=None)[source]¶
Bases:
dazzler.system._component.Component
Pick a date from a calendar.
- CSS
dazzler-calendar-date-picker
picker
- __init__(value=undefined, opened=undefined, date_format='DD MMM YYYY', class_name=undefined, style=undefined, identity=None)[source]¶
- Parameters
value (
Union
[float
,int
,None
]) –opened (
Optional
[bool
]) –date_format (
Optional
[str
]) – (default=’DD MMM YYYY’)class_name (
Optional
[str
]) – Class name automatically added by dazzler api with a prefix for the component library. ie: core component Container becomedazzler-core-container
. When added on the component, the class names will be concatenated.style (
Optional
[Dict
]) – Style object for the top level wrapper of the component.
- class_name¶
Class name automatically added by dazzler api with a prefix for the component library.ie: core component Container become
dazzler-core-container
.When added on the component, the class names will be concatenated.
- date_format¶
(default=’DD MMM YYYY’)
- opened¶
- style¶
Style object for the top level wrapper of the component.
- value¶
- class dazzler.components.calendar.TimePicker(value='00:00', fallback_mode=undefined, mode="'24h'", class_name=undefined, style=undefined, identity=None)[source]¶
Bases:
dazzler.system._component.Component
Time input with fallback for ie and safari.
- CSS
dazzler-calendar-time-picker
time-input
fallback-timepicker
time-range
time-value
- __init__(value='00:00', fallback_mode=undefined, mode="'24h'", class_name=undefined, style=undefined, identity=None)[source]¶
- Parameters
value (
Optional
[str
]) – Time value formatted as HH:MM (default=’00:00’)fallback_mode (
Optional
[bool
]) – Use a custom picker instead of browser dependant. Automatically set when no time input support detected.mode (
Optional
[Any
]) – What to display when in fallback mode. (Possible values: ‘24h’, ‘AM/PM’) (default=“‘24h’”)class_name (
Optional
[str
]) – Class name automatically added by dazzler api with a prefix for the component library. ie: core component Container becomedazzler-core-container
. When added on the component, the class names will be concatenated.style (
Optional
[Dict
]) – Style object for the top level wrapper of the component.
- class_name¶
Class name automatically added by dazzler api with a prefix for the component library.ie: core component Container become
dazzler-core-container
.When added on the component, the class names will be concatenated.
- fallback_mode¶
Use a custom picker instead of browser dependant.Automatically set when no time input support detected.
- mode¶
What to display when in fallback mode. (Possible values: ‘24h’, ‘AM/PM’) (default=24h)
- style¶
Style object for the top level wrapper of the component.
- value¶
Time value formatted as HH:MM (default=’00:00’)
- class dazzler.components.calendar.Timestamp(value, format=undefined, locale=undefined, class_name=undefined, style=undefined, identity=None)[source]¶
Bases:
dazzler.system._component.Component
Format a value according to the
format
prop.Syntax documentation https://date-fns.org/v2.15.0/docs/format
- __init__(value, format=undefined, locale=undefined, class_name=undefined, style=undefined, identity=None)[source]¶
- Parameters
value (
Union
[str
,float
,int
]) –format (
Optional
[str
]) –locale (
Optional
[Dict
]) –class_name (
Optional
[str
]) – Class name automatically added by dazzler api with a prefix for the component library. ie: core component Container becomedazzler-core-container
. When added on the component, the class names will be concatenated.style (
Optional
[Dict
]) – Style object for the top level wrapper of the component.
- class_name¶
Class name automatically added by dazzler api with a prefix for the component library.ie: core component Container become
dazzler-core-container
.When added on the component, the class names will be concatenated.
- format¶
- locale¶
- style¶
Style object for the top level wrapper of the component.
- value¶