Skip to contents

Create a DatePicker component

Usage

calcite_date_picker(...)

Arguments

...

named attributes passed to htmltools::tag()

Value

an object of class calcite_component which is a subclass of shiny.tag

Details

Properties

The following properties are provided by this component:

NameAttributeDescriptionValuesReflects to Attribute
activeDateNASpecifies the component's active date.DateFALSE
activeRangeactive-rangeWhen range is true, specifies the active range. Where "start" specifies the starting range date and "end" the ending range date."end" | "start"TRUE
headingLevelheading-levelSpecifies the heading level of the component's heading for proper document structure, without affecting visual styling.1 | 2 | 3 | 4 | 5 | 6TRUE
layoutlayoutDefines the layout of the component."horizontal" | "vertical"TRUE
maxmaxWhen the component resides in a form, specifies the latest allowed date ("yyyy-mm-dd").stringTRUE
maxAsDateNASpecifies the latest allowed date as a full date object (new Date("yyyy-mm-dd")).DateFALSE
messageOverridesNAUse this property to override individual strings used by the component.Check API referenceFALSE
minminWhen the component resides in a form, specifies the earliest allowed date ("yyyy-mm-dd").stringTRUE
minAsDateNASpecifies the earliest allowed date as a full date object (new Date("yyyy-mm-dd")).DateFALSE
monthStylemonth-styleSpecifies the monthStyle used by the component."abbreviated" | "wide"FALSE
numberingSystemnumbering-systemSpecifies the Unicode numeral system used by the component for localization. This property cannot be dynamically changed."arab" | "arabext" | "latn"TRUE
proximitySelectionDisabledproximity-selection-disabledWhen true, disables the default behavior on the third click of narrowing or extending the range and instead starts a new range.booleanTRUE
rangerangeWhen true, activates the component's range mode to allow a start and end date.booleanTRUE
scalescaleSpecifies the size of the component."l" | "m" | "s"TRUE
valuevalueCheck API referenceCheck API referenceFALSE
valueAsDateNACheck API referenceCheck API referenceFALSE

Events

The following events are observed by shiny:

EventDescription
calciteDatePickerChangeFires when a user changes the component's date. For range events, use calciteDatePickerRangeChange.
calciteDatePickerRangeChangeFires when a user changes the component's date range. For components without range use calciteDatePickerChange.

Examples

calcite_date_picker()
#> <calcite-date-picker></calcite-date-picker>