@material-ui/lab
Version:
Material-UI Lab - Incubator for Material-UI React components.
414 lines (344 loc) • 10.1 kB
JavaScript
import PropTypes from 'prop-types';
import { makeDateRangePicker } from '../DateRangePicker/makeDateRangePicker';
import MobileWrapper from '../internal/pickers/wrappers/MobileWrapper';
/**
* @ignore - do not document.
*/
/* @GeneratePropTypes */
const MobileDateRangePicker = makeDateRangePicker('MuiPickersDateRangePicker', MobileWrapper);
MobileDateRangePicker.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit TypeScript types and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* Regular expression to detect "accepted" symbols.
* @default /\dap/gi
*/
acceptRegex: PropTypes.instanceOf(RegExp),
/**
* Enables keyboard listener for moving between days in calendar.
* @default currentWrapper !== 'static'
*/
allowKeyboardControl: PropTypes.bool,
/**
* If `true`, `onChange` is fired on click even if the same date is selected.
* @default false
*/
allowSameDateSelection: PropTypes.bool,
/**
* The number of calendars that render on **desktop**.
* @default 2
*/
calendars: PropTypes.oneOf([1, 2, 3]),
/**
* "CANCEL" Text message
* @default "CANCEL"
*/
cancelText: PropTypes.node,
/**
* className applied to the root component.
*/
className: PropTypes.string,
/**
* If `true`, it shows the clear action in the picker dialog.
* @default false
*/
clearable: PropTypes.bool,
/**
* "CLEAR" Text message
* @default "CLEAR"
*/
clearText: PropTypes.node,
/**
* Allows to pass configured date-io adapter directly. More info [here](https://next.material-ui-pickers.dev/guides/date-adapter-passing)
* ```jsx
* dateAdapter={new DateFnsAdapter({ locale: ruLocale })}
* ```
*/
dateAdapter: PropTypes.object,
/**
* Default calendar month displayed when `value={null}`.
* @default `new Date()`
*/
defaultCalendarMonth: PropTypes.any,
/**
* Props to be passed directly to material-ui [Dialog](https://material-ui.com/components/dialogs)
*/
DialogProps: PropTypes.object,
/**
* if `true` after selecting `start` date calendar will not automatically switch to the month of `end` date
* @default false
*/
disableAutoMonthSwitching: PropTypes.bool,
/**
* If `true` the popup or dialog will immediately close after submitting full date.
* @default `true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
*/
disableCloseOnSelect: PropTypes.bool,
/**
* If `true`, the picker and text field are disabled.
*/
disabled: PropTypes.bool,
/**
* Disable future dates.
* @default false
*/
disableFuture: PropTypes.bool,
/**
* If `true`, todays date is rendering without highlighting with circle.
* @default false
*/
disableHighlightToday: PropTypes.bool,
/**
* Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
* @default false
*/
disableMaskedInput: PropTypes.bool,
/**
* Do not render open picker button (renders only text field with validation).
* @default false
*/
disableOpenPicker: PropTypes.bool,
/**
* Disable past dates.
* @default false
*/
disablePast: PropTypes.bool,
/**
* Text for end input label and toolbar placeholder.
* @default "end"
*/
endText: PropTypes.node,
/**
* Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType
* @default (value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`
*/
getOpenDialogAriaText: PropTypes.func,
/**
* Get aria-label text for switching between views button.
*/
getViewSwitchingButtonText: PropTypes.func,
/**
* @ignore
*/
ignoreInvalidInputs: PropTypes.bool,
/**
* Props to pass to keyboard input adornment.
*/
InputAdornmentProps: PropTypes.object,
/**
* Format string.
*/
inputFormat: PropTypes.string,
/**
* @ignore
*/
InputProps: PropTypes.object,
/**
* @ignore
*/
key: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
/**
* @ignore
*/
label: PropTypes.node,
/**
* Props to pass to left arrow button.
*/
leftArrowButtonProps: PropTypes.object,
/**
* Left arrow icon aria-label text.
*/
leftArrowButtonText: PropTypes.string,
/**
* Left arrow icon.
*/
leftArrowIcon: PropTypes.node,
/**
* If `true` renders `LoadingComponent` in calendar instead of calendar view.
* Can be used to preload information and show it in calendar.
* @default false
*/
loading: PropTypes.bool,
/**
* Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M)
*/
mask: PropTypes.string,
/**
* Max selectable date. @DateIOType
* @default Date(2099-31-12)
*/
maxDate: PropTypes.any,
/**
* Min selectable date. @DateIOType
* @default Date(1900-01-01)
*/
minDate: PropTypes.any,
/**
* "OK" button text.
* @default "OK"
*/
okText: PropTypes.node,
/**
* Callback fired when date is accepted @DateIOType.
*/
onAccept: PropTypes.func,
/**
* Callback fired when the value (the selected date) changes. @DateIOType.
*/
onChange: PropTypes.func.isRequired,
/**
* Callback fired when the popup requests to be closed.
* Use in controlled mode (see open).
*/
onClose: PropTypes.func,
/**
* Callback that fired when input value or new `value` prop validation returns **new** validation error (or value is valid after error).
* In case of validation error detected `reason` prop return non-null value and `TextField` must be displayed in `error` state.
* This can be used to render appropriate form error.
*
* [Read the guide](https://next.material-ui-pickers.dev/guides/forms) about form integration and error displaying.
* @DateIOType
*/
onError: PropTypes.func,
/**
* Callback firing on month change. @DateIOType
*/
onMonthChange: PropTypes.func,
/**
* Callback fired when the popup requests to be opened.
* Use in controlled mode (see open).
*/
onOpen: PropTypes.func,
/**
* Callback fired on view change.
*/
onViewChange: PropTypes.func,
/**
* Control the popup or dialog open state.
*/
open: PropTypes.bool,
/**
* Props to pass to keyboard adornment button.
*/
OpenPickerButtonProps: PropTypes.object,
/**
* Icon displaying for open picker button.
*/
openPickerIcon: PropTypes.node,
/**
* Force rendering in particular orientation.
*/
orientation: PropTypes.oneOf(['landscape', 'portrait']),
/**
* Make picker read only.
*/
readOnly: PropTypes.bool,
/**
* Disable heavy animations.
* @default /(android)/i.test(window.navigator.userAgent).
*/
reduceAnimations: PropTypes.bool,
/**
* Custom renderer for `<DateRangePicker />` days. @DateIOType
* @example (date, DateRangeDayProps) => <DateRangePickerDay {...DateRangeDayProps} />
*/
renderDay: PropTypes.func,
/**
* The `renderInput` prop allows you to customize the rendered input.
* The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://material-ui.com/api/text-field/#textfield-api),
* that you need to forward to the range start/end inputs respectively.
* Pay specific attention to the `ref` and `inputProps` keys.
* @example
* ```jsx
* <DateRangePicker
* renderInput={(startProps, endProps) => (
* <React.Fragment>
* <TextField {...startProps} />
* <DateRangeDelimiter> to <DateRangeDelimiter>
* <TextField {...endProps} />
* </React.Fragment>;
* )}
* />
* ````
*/
renderInput: PropTypes.func.isRequired,
/**
* Component displaying when passed `loading` true.
* @default () => "..."
*/
renderLoading: PropTypes.func,
/**
* Custom formatter to be passed into Rifm component.
*/
rifmFormatter: PropTypes.func,
/**
* Props to pass to right arrow button.
*/
rightArrowButtonProps: PropTypes.object,
/**
* Right arrow icon aria-label text.
*/
rightArrowButtonText: PropTypes.string,
/**
* Right arrow icon.
*/
rightArrowIcon: PropTypes.node,
/**
* Disable specific date. @DateIOType
*/
shouldDisableDate: PropTypes.func,
/**
* Disable specific years dynamically.
* Works like `shouldDisableDate` but for year selection view. @DateIOType.
*/
shouldDisableYear: PropTypes.func,
/**
* If `true`, days that have `outsideCurrentMonth={true}` are displayed.
* @default false
*/
showDaysOutsideCurrentMonth: PropTypes.bool,
/**
* If `true`, the today button will be displayed. **Note** that `showClearButton` has a higher priority.
* @default false
*/
showTodayButton: PropTypes.bool,
/**
* If `true`, show the toolbar even in desktop mode.
*/
showToolbar: PropTypes.bool,
/**
* Text for start input label and toolbar placeholder.
* @default "Start"
*/
startText: PropTypes.node,
/**
* "TODAY" Text message
* @default "TODAY"
*/
todayText: PropTypes.node,
/**
* Component that will replace default toolbar renderer.
*/
ToolbarComponent: PropTypes.elementType,
/**
* Date format, that is displaying in toolbar.
*/
toolbarFormat: PropTypes.string,
/**
* Mobile picker date value placeholder, displaying if `value` === `null`.
* @default "–"
*/
toolbarPlaceholder: PropTypes.node,
/**
* Mobile picker title, displaying in the toolbar.
* @default "SELECT DATE"
*/
toolbarTitle: PropTypes.node,
/**
* The value of the picker.
*/
value: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.any, PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string])).isRequired
};
export default MobileDateRangePicker;