Input Datepicker: API Table
class: LionInputDatepicker, lion-input-datepicker
Fields
| Name | Privacy | Type | Default | Description | Inherited From |
|---|---|---|---|---|---|
calendarHeading | public | string | The 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. | ||
formatter | public | formatDate | LionInputDate | ||
modelValue | public | LionInputDate | |||
parser | public | LionInputDate | |||
placeholder | public | string | '' | LionInput | |
readOnly | public | boolean | false | A 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 |
slots | public | LionInput | |||
type | public | string | 'text' | LionInput | |
_calendarInvokerSlot | protected | string | 'suffix' | The slot to put the invoker button in. Can be ‘prefix’, ‘suffix’, ‘before’ and ‘after’. Default will be ‘suffix’. | |
_calendarNode | protected | LionCalendar | |||
_feedbackConditionMeta | protected | LionField | |||
_focusableNode | protected | LionField | |||
_focusCentralDateOnCalendarOpen | protected | boolean | true | ||
_hideOnUserSelect | protected | boolean | true | ||
_inputNode | protected | HTMLInputElement | LionInput | ||
_invokerNode | protected | ||||
_isEditingTextField | protected | ||||
_isHandlingCalendarUserInput | protected | boolean | false | ||
_overlayContentNode | protected | ||||
_overlayInvokerNode | protected | ||||
_syncOnUserSelect | protected | boolean | true |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
|---|---|---|---|---|---|
clear | public | Clears modelValue. Interaction states are not cleared (use resetInteractionState for this) | LionField | ||
deserializer | public | serializedValue: string | LionInputDate | ||
reset | public | Resets modelValue to initial value. Interaction states are cleared | LionField | ||
resetInteractionState | public | LionField | |||
serializer | public | modelValue: Date | LionInputDate | ||
_calendarTemplate | protected | Subclassers can replace this with their custom extension of LionCalendar, like `<my-calendar id=“calendar”></my-calendar>` | |||
_defineOverlayConfig | protected | Object | |||
_invokerIconTemplate | protected | Subclassers can replace this with their custom extension invoker icon | |||
_invokerTemplate | protected | Subclassers can replace this with their custom extension invoker, like `<my-button><calendar-icon></calendar-icon></my-button>` | |||
_onCalendarOverlayOpened | protected | Lifecycle callback for subclassers | |||
_onCalendarUserSelectedChanged | protected | Triggered when a user selects a date from the calendar overlay | { target: { selectedDate } }, opts: { target: { selectedDate: Date }} | ||
_onChange | protected | Dispatches custom bubble event | ev: Event= | LionField | |
_onValidatorUpdated | protected | Responsible for listening param change event and sync the calendar dates with the updated validator params | e: Event|CustomEvent, metaData: {validator: Validator} | ||
_overlayFrameTemplate | protected | ||||
_overlayTemplate | protected | Defining 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. | |||
_reflectBackOn | protected | ||||
_setupOverlayCtrl | protected |
Events
| Name | Type | Description | Inherited From |
|---|---|---|---|
user-input-changed | Event | LionField |
Attributes
| Name | Field | Inherited From |
|---|---|---|
calendar-heading | calendarHeading | |
modelValue | modelValue | LionInputDate |
readonly | readOnly | LionInput |
type | type | LionInput |
placeholder | placeholder | LionInput |