SDateField <s-date-field>

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

Example

Value: (empty)

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

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

<template>
  <SDateField label="Delivery date" placeholder="YYYY-MM-DD" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

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

<SDateField v-model="value" />

is equivalent to:

<SDateField :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.
autocomplete	"bday-day" | "bday-month" | "bday-year" | "bday" | "cc-expiry-month" | "cc-expiry-year" | "cc-expiry"	A hint as to the intended content of the field. When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.
defaultValue	string	The default value for the field.
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.
details	any	Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users.
disabled	boolean	Disables the field, disallowing any interaction.
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.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
id	string	A unique identifier for the element.
label	any	Content to use as the field label.
labelAccessibilityVisibility	"visible" | "exclusive"	Changes the visibility of the component's label. - visible: the label is visible to all users. - exclusive: the label is visually hidden but remains in the accessibility tree.
name	string	An identifier for the field that is unique within the nearest containing form.
placeholder	string	A short hint that describes the expected value of the field.
readOnly	boolean	The field cannot be edited by the user. It is focusable will be announced by screen readers.
required	boolean	Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.
value	string	The current value for the field. If omitted, the field will be empty.
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
invalid	CustomEvent
viewchange	CustomEvent

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

Slots

Slot	Description
details
error