SDatePicker <s-date-picker>

import { SDatePicker } from 'polaris-vue-elements'

Example

Selected: (none)

<script setup>
import { ref } from 'vue'
import { SDatePicker } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <SDatePicker type="single" v-model="value" />
  <p>Selected: {{ value }}</p>
</template>

v-model

v-model on <SDatePicker> binds to the value property and listens for the input DOM event.

<SDatePicker v-model="value" />

is equivalent to:

<SDatePicker :value="value" @input="value = $event.target.value" />

Props

Prop	Type	Description
allow	string	Dates that can be selected. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default '' allows all dates. - Dates in YYYY-MM-DD format allow a single date. - Dates in YYYY-MM format allow a whole month. - Dates in YYYY format allow a whole year. - Ranges are expressed as start--end. - Ranges are inclusive. - If either start or end is omitted, the range is unbounded in that direction. - If parts of the date are omitted for start, they are assumed to be the minimum possible value. So 2024-- is equivalent to 2024-01-01--. - If parts of the date are omitted for end, they are assumed to be the maximum possible value. So --2024 is equivalent to --2024-12-31. - Whitespace is allowed either side of --.
allowDays	string	Days of the week that can be selected. These intersect with the result of allow and disallow. A comma-separated list of days. Whitespace is allowed after commas. The default '' has no effect on the result of allow and disallow. Days are sunday, monday, tuesday, wednesday, thursday, friday, saturday.
defaultValue	string	Default selected value. The default means no date is selected. If the provided value is invalid, no date is selected. - If type="single", this is a date in YYYY-MM-DD format. - If type="multiple", this is a comma-separated list of dates in YYYY-MM-DD format. - If type="range", this is a range in YYYY-MM-DD--YYYY-MM-DD format. The range is inclusive.
defaultView	string	Default month to display in YYYY-MM format. This value is used until view is set, either directly or as a result of user interaction. Defaults to the current month in the user's locale.
disallow	string	Dates that cannot be selected. These subtract from allow. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default '' has no effect on allow. - Dates in YYYY-MM-DD format disallow a single date. - Dates in YYYY-MM format disallow a whole month. - Dates in YYYY format disallow a whole year. - Ranges are expressed as start--end. - Ranges are inclusive. - If either start or end is omitted, the range is unbounded in that direction. - If parts of the date are omitted for start, they are assumed to be the minimum possible value. So 2024-- is equivalent to 2024-01-01--. - If parts of the date are omitted for end, they are assumed to be the maximum possible value. So --2024 is equivalent to --2024-12-31. - Whitespace is allowed either side of --.
disallowDays	string	Days of the week that cannot be selected. This subtracts from allowDays, and intersects with the result of allow and disallow. A comma-separated list of days. Whitespace is allowed after commas. The default '' has no effect on allowDays. Days are sunday, monday, tuesday, wednesday, thursday, friday, saturday.
name	string	An identifier for the field that is unique within the nearest containing form.
type	"single" | "range"
value	string	Current selected value. The default means no date is selected. If the provided value is invalid, no date is selected. Otherwise: - If type="single", this is a date in YYYY-MM-DD format. - If type="multiple", this is a comma-separated list of dates in YYYY-MM-DD format. - If type="range", this is a range in YYYY-MM-DD--YYYY-MM-DD format. The range is inclusive.
view	string	Displayed month in YYYY-MM format. onViewChange is called when this value changes. Defaults to defaultView.

Events

Event	Type
blur	CustomEvent
change	CustomEvent
focus	CustomEvent
input	CustomEvent
viewchange	CustomEvent

Listen for these with @blur-style listeners on <SDatePicker>.