Search

Find components, guides, and documentation

Input Datepicker: API Table

class: LionInputDatepicker, lion-input-datepicker

Fields

NamePrivacyTypeDefaultDescriptionInherited From
calendarHeadingpublicstringThe heading to be added on top of the calendar overlay. Naming chosen from an Application Developer perspective. For a Subclasser ‘calendarOverlayHeading’ would be more appropriate.
formatterpublicformatDateLionInputDate
modelValuepublicLionInputDate
parserpublicLionInputDate
placeholderpublicstring''LionInput
readOnlypublicbooleanfalseA Boolean attribute which, if present, indicates that the user should not be able to edit the value of the input. The difference between disabled and readonly is that read-only controls can still function, whereas disabled controls generally do not function as controls until they are enabled. (From: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly)LionInput
slotspublicLionInput
typepublicstring'text'LionInput
_calendarInvokerSlotprotectedstring'suffix'The slot to put the invoker button in. Can be ‘prefix’, ‘suffix’, ‘before’ and ‘after’. Default will be ‘suffix’.
_calendarNodeprotectedLionCalendar
_feedbackConditionMetaprotectedLionField
_focusableNodeprotectedLionField
_focusCentralDateOnCalendarOpenprotectedbooleantrue
_hideOnUserSelectprotectedbooleantrue
_inputNodeprotectedHTMLInputElementLionInput
_invokerNodeprotected
_isEditingTextFieldprotected
_isHandlingCalendarUserInputprotectedbooleanfalse
_overlayContentNodeprotected
_overlayInvokerNodeprotected
_syncOnUserSelectprotectedbooleantrue

Methods

NamePrivacyDescriptionParametersReturnInherited From
clearpublicClears modelValue. Interaction states are not cleared (use resetInteractionState for this)LionField
deserializerpublicserializedValue: stringLionInputDate
resetpublicResets modelValue to initial value. Interaction states are clearedLionField
resetInteractionStatepublicLionField
serializerpublicmodelValue: DateLionInputDate
_calendarTemplateprotectedSubclassers can replace this with their custom extension of LionCalendar, like `<my-calendar id=“calendar”></my-calendar>`
_defineOverlayConfigprotectedObject
_invokerIconTemplateprotectedSubclassers can replace this with their custom extension invoker icon
_invokerTemplateprotectedSubclassers can replace this with their custom extension invoker, like `<my-button><calendar-icon></calendar-icon></my-button>`
_onCalendarOverlayOpenedprotectedLifecycle callback for subclassers
_onCalendarUserSelectedChangedprotectedTriggered when a user selects a date from the calendar overlay{ target: { selectedDate } }, opts: { target: { selectedDate: Date }}
_onChangeprotectedDispatches custom bubble eventev: Event=LionField
_onValidatorUpdatedprotectedResponsible for listening param change event and sync the calendar dates with the updated validator paramse: Event|CustomEvent, metaData: {validator: Validator}
_overlayFrameTemplateprotected
_overlayTemplateprotectedDefining this overlay as a templates from OverlayMixin this is our source to give as .contentNode to OverlayController. Important: do not change the name of this method.
_reflectBackOnprotected
_setupOverlayCtrlprotected

Events

NameTypeDescriptionInherited From
user-input-changedEventLionField

Attributes

NameFieldInherited From
calendar-headingcalendarHeading
modelValuemodelValueLionInputDate
readonlyreadOnlyLionInput
typetypeLionInput
placeholderplaceholderLionInput