alpha

useDateFieldState

Provides state management for a date field component. A date field allows users to enter and edit date and time values using a keyboard. Each part of a date value is displayed in an individually editable segment.

installyarn add @react-stately/datepicker
version3.0.0-alpha.4
usageimport {useDateFieldState} from '@react-stately/datepicker'

API#


useDateFieldState( (props: DatePickerFieldProps )): DateFieldState

Interface#


Properties

NameTypeDescription
valueDateValueThe current field value.
dateValueDateThe current value, converted to a native JavaScript Date object.
segmentsDateSegment[]A list of segments for the current value.
dateFormatterDateFormatterA date formatter configured for the current locale and format.
validationStateValidationStateThe current validation state of the date field, based on the validationState, minValue, and maxValue props.
granularityGranularityThe granularity for the field, based on the granularity prop and current value.
isDisabledbooleanWhether the field is disabled.
isReadOnlybooleanWhether the field is read only.
isRequiredbooleanWhether the field is required.

Methods

MethodDescription
setValue( (value: DateValue )): voidSets the field's value.
increment( (type: SegmentType )): voidIncrements the given segment. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
decrement( (type: SegmentType )): voidDecrements the given segment. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
incrementPage( (type: SegmentType )): void

Increments the given segment by a larger amount, rounding it to the nearest increment. The amount to increment by depends on the field, for example 15 minutes, 7 days, and 5 years. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.

decrementPage( (type: SegmentType )): void

Decrements the given segment by a larger amount, rounding it to the nearest increment. The amount to decrement by depends on the field, for example 15 minutes, 7 days, and 5 years. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.

setSegment( (type: SegmentType, , value: number )): voidSets the value of the given segment.
confirmPlaceholder( (type?: SegmentType )): void

Replaces the value of the date field with the placeholder value. If a segment type is provided, only that segment is confirmed. Otherwise, all segments that have not been entered yet are confirmed.

clearSegment( (type: SegmentType )): voidClears the value of the given segment, reverting it to the placeholder.
formatValue( (fieldOptions: FieldOptions )): stringFormats the current date value using the given options.

Example#


See the docs for useDateField in react-aria for an example of useDateFieldState.