SingleInputDateRangeField API
API reference docs for the React SingleInputDateRangeField component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import { SingleInputDateRangeField } from '@mui/x-date-pickers-pro/SingleInputDateRangeField';
// or
import { SingleInputDateRangeField } from '@mui/x-date-pickers-pro';Props of the native component are also available.
If true, a clear button will be shown in the field allowing value clearing.
Type:bool
Default:false
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
Type:'error'
| 'info'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
Default:'primary'
If true, disable values after the current date for date components, time for time components and both for date time components.
Type:bool
Default:false
If true, disable values before the current date for date components, time for time components and both for date time components.
Type:bool
Default:false
Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.
Type:'dense'
| 'spacious'
Default:"dense"
The id of the input element. Use this prop to make label and helperText accessible for screen readers.
Type:string
Props applied to the InputLabel element. Pointer events like onClick are enabled if and only if shrink is true.
Type:object
Props applied to the Input element. It will be a FilledInput, OutlinedInput or Input component depending on the variant prop value.
Type:object
If dense or normal, will adjust vertical spacing of this and contained components.
Type:'dense'
| 'none'
| 'normal'
Default:'none'
Callback fired when the value changes.
Type:func
function(value: TValue, context: FieldChangeHandlerContext) => void valueThe new value.contextThe context containing the validation result of the current value.
Callback fired when the error associated to the current value changes.
Type:func
function(error: TError, value: TValue) => voiderrorThe new error.valueThe value associated to the error.
Callback fired when the selected sections change.
Type:func
function(newValue: FieldSelectedSections) => voidnewValueThe new selected sections.
It prevents the user from changing the value of the field (not from interacting with the field).
Type:bool
Default:false
The date used to generate a part of the new value that is not present in the format when both value and defaultValue are empty. For example, on time fields it will be used to determine the date to set.
Type:any
Default:The closest valid date using the validation props, except callbacks such as `shouldDisableDate`. Value is rounded to the most granular section used.
If true, the label is displayed as required and the input element is required.
Type:bool
Default:false
The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a startIndex and endIndex properties are provided, the sections between those two indexes will be selected. 3. If a string of type FieldSectionType is provided, the first section with that name will be selected. 4. If null is provided, no section will be selected If not provided, the selected sections will be handled internally.
Type:'all'
| 'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'weekDay'
| 'year'
| number
| { endIndex: number, startIndex: number }
Disable specific date.
Warning: This function can be called multiple times (e.g. when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.
Type:func
function(day: TDate, position: string) => booleandayThe date to test.positionThe date to test, 'start' or 'end'.
Returns: Returns true if the date should be disabled.
If true, the format will respect the leading zeroes (e.g: on dayjs, the format M/D/YYYY will render 8/16/2018) If false, the format will always add leading zeroes (e.g: on dayjs, the format M/D/YYYY will render 08/16/2018)
Warning n°1: Luxon is not able to respect the leading zeroes when using macro tokens (e.g: "DD"), so shouldRespectLeadingZeros={true} might lead to inconsistencies when using AdapterLuxon.
Warning n°2: When shouldRespectLeadingZeros={true}, the field will add an invisible character on the sections containing a single digit to make sure onChange is fired. If you need to get the clean value from the input, you can remove this character using input.value.replace(/\u200e/g, '').
Warning n°3: When used in strict mode, dayjs and moment require to respect the leading zeros. This mean that when using shouldRespectLeadingZeros={false}, if you retrieve the value directly from the input (not listening to onChange) and your format contains tokens without leading zeros, the value will not be parsed by your library.
Type:bool
Default:`false`
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
Choose which timezone to use for the value. Example: "default", "system", "UTC", "America/New_York". If you pass values from other timezones to some props, they will be converted to this timezone before being used.
See the timezones documention for more details.
Type:string
Default:The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
ref is forwarded to the root element.These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.