@material-ui/lab
Version:
Material-UI Lab - Incubator for Material-UI React components.
294 lines (239 loc) • 8.43 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _makePickerWithState = require("../internal/pickers/Picker/makePickerWithState");
var _TimePicker = require("../TimePicker/TimePicker");
var _Wrapper = require("../internal/pickers/wrappers/Wrapper");
/**
* @ignore - do not document.
*/
/* @GeneratePropTypes */
const DesktopTimePicker = (0, _makePickerWithState.makePickerWithStateAndWrapper)(_Wrapper.DesktopWrapper, (0, _extends2.default)({
name: 'MuiDesktopTimePicker'
}, _TimePicker.timePickerConfig));
DesktopTimePicker.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.default.instanceOf(RegExp),
/**
* Enables keyboard listener for moving between days in calendar.
* @default currentWrapper !== 'static'
*/
allowKeyboardControl: _propTypes.default.bool,
/**
* 12h/24h view for hour selection clock.
* @default true
*/
ampm: _propTypes.default.bool,
/**
* Display ampm controls under the clock (instead of in the toolbar).
* @default false
*/
ampmInClock: _propTypes.default.bool,
/**
* className applied to the root component.
*/
className: _propTypes.default.string,
/**
* 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.default.object,
/**
* 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.default.bool,
/**
* If `true`, the picker and text field are disabled.
*/
disabled: _propTypes.default.bool,
/**
* Do not ignore date part when validating min/max time.
* @default false
*/
disableIgnoringDatePartForTimeValidation: _propTypes.default.bool,
/**
* Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
* @default false
*/
disableMaskedInput: _propTypes.default.bool,
/**
* Do not render open picker button (renders only text field with validation).
* @default false
*/
disableOpenPicker: _propTypes.default.bool,
/**
* Accessible text that helps user to understand which time and view is selected.
* @default (view, time) => `Select ${view}. Selected time is ${format(time, 'fullTime')}`
*/
getClockLabelText: _propTypes.default.func,
/**
* 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.default.func,
/**
* @ignore
*/
ignoreInvalidInputs: _propTypes.default.bool,
/**
* Props to pass to keyboard input adornment.
*/
InputAdornmentProps: _propTypes.default.object,
/**
* Format string.
*/
inputFormat: _propTypes.default.string,
/**
* @ignore
*/
InputProps: _propTypes.default.object,
/**
* @ignore
*/
key: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
/**
* @ignore
*/
label: _propTypes.default.node,
/**
* Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M)
*/
mask: _propTypes.default.string,
/**
* @ignore
*/
maxTime: _propTypes.default.oneOfType([_propTypes.default.any, _propTypes.default.instanceOf(Date), _propTypes.default.number, _propTypes.default.string]),
/**
* @ignore
*/
minTime: _propTypes.default.oneOfType([_propTypes.default.any, _propTypes.default.instanceOf(Date), _propTypes.default.number, _propTypes.default.string]),
/**
* Step over minutes.
* @default 1
*/
minutesStep: _propTypes.default.number,
/**
* Callback fired when date is accepted @DateIOType.
*/
onAccept: _propTypes.default.func,
/**
* Callback fired when the value (the selected date) changes. @DateIOType.
*/
onChange: _propTypes.default.func.isRequired,
/**
* Callback fired when the popup requests to be closed.
* Use in controlled mode (see open).
*/
onClose: _propTypes.default.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.default.func,
/**
* Callback fired when the popup requests to be opened.
* Use in controlled mode (see open).
*/
onOpen: _propTypes.default.func,
/**
* Control the popup or dialog open state.
*/
open: _propTypes.default.bool,
/**
* Props to pass to keyboard adornment button.
*/
OpenPickerButtonProps: _propTypes.default.object,
/**
* Icon displaying for open picker button.
*/
openPickerIcon: _propTypes.default.node,
/**
* First view to show.
*/
openTo: _propTypes.default.oneOf(['date', 'hours', 'minutes', 'month', 'seconds', 'year']),
/**
* Force rendering in particular orientation.
*/
orientation: _propTypes.default.oneOf(['landscape', 'portrait']),
/**
* Popper props passed down to [Popper](https://material-ui.com/api/popper/) component.
*/
PopperProps: _propTypes.default.object,
/**
* Make picker read only.
*/
readOnly: _propTypes.default.bool,
/**
* The `renderInput` prop allows you to customize the rendered input.
* The `props` argument of this render prop contains props of [TextField](https://material-ui.com/api/text-field/#textfield-api) that you need to forward.
* Pay specific attention to the `ref` and `inputProps` keys.
* @example ```jsx
* renderInput={props => <TextField {...props} />}
* ````
*/
renderInput: _propTypes.default.func.isRequired,
/**
* Custom formatter to be passed into Rifm component.
*/
rifmFormatter: _propTypes.default.func,
/**
* Dynamically check if time is disabled or not.
* If returns `false` appropriate time point will ot be acceptable.
*/
shouldDisableTime: _propTypes.default.func,
/**
* If `true`, show the toolbar even in desktop mode.
*/
showToolbar: _propTypes.default.bool,
/**
* Component that will replace default toolbar renderer.
*/
ToolbarComponent: _propTypes.default.elementType,
/**
* Date format, that is displaying in toolbar.
*/
toolbarFormat: _propTypes.default.string,
/**
* Mobile picker date value placeholder, displaying if `value` === `null`.
* @default "–"
*/
toolbarPlaceholder: _propTypes.default.node,
/**
* Mobile picker title, displaying in the toolbar.
* @default "SELECT DATE"
*/
toolbarTitle: _propTypes.default.node,
/**
* Custom component for popper [Transition](https://material-ui.com/components/transitions/#transitioncomponent-prop).
*/
TransitionComponent: _propTypes.default.elementType,
/**
* The value of the picker.
*/
value: _propTypes.default.oneOfType([_propTypes.default.any, _propTypes.default.instanceOf(Date), _propTypes.default.number, _propTypes.default.string]),
/**
* Array of views to show.
*/
views: _propTypes.default.arrayOf(_propTypes.default.oneOf(['hours', 'minutes', 'seconds']).isRequired)
};
var _default = DesktopTimePicker;
exports.default = _default;