@piplup/rhf-adaptersmui-x-date-pickersHooks
useMuiXDateTimePickerAdapter
Returns adapter props for building custom MUI X DateTimePicker integrations with React Hook Form.
Import
import { useMuiXDateTimePickerAdapter } from "@piplup/rhf-adapters/mui-x-date-pickers";Usage
import * as React from 'react';import { type DateTimePickerProps, DateTimePicker, type PickerValidDate,} from '@mui/x-date-pickers';import { type Transform } from '@piplup/rhf-core';import { type FieldPath, type FieldValues } from 'react-hook-form';import { type UseMuiXDateTimePickerAdapterProps, useMuiXDateTimePickerAdapter,} from './adapter';export interface MuiXDateTimePickerElementProps< TTransformedValue extends PickerValidDate, TEnableAccessibleFieldDOMStructure extends boolean = true, TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,> extends Omit< DateTimePickerProps<TEnableAccessibleFieldDOMStructure>, 'defaultValue' | 'name' | 'value' >, Omit< UseMuiXDateTimePickerAdapterProps<TTransformedValue, TFieldValues, TName>, | 'classes' | 'composeClassName' | 'composeHelperText' | 'internalClasses' | 'maxDate' | 'minDate' | 'onChange' | 'slotProps' | 'transform' > { /** * Transformation functions for the field's input and output values. */ transform?: Transform< DateTimePickerProps<TEnableAccessibleFieldDOMStructure>['onChange'], TTransformedValue, TFieldValues, TName >;}function MuiXDateTimePickerComponent< TTransformedValue extends PickerValidDate, TEnableAccessibleFieldDOMStructure extends boolean = true, TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,>( props: MuiXDateTimePickerElementProps< TTransformedValue, TEnableAccessibleFieldDOMStructure, TFieldValues, TName >, ref?: React.Ref<HTMLDivElement>,): React.ReactElement { const { className, control, defaultValue, disabled, disableFuture, disableIgnoringDatePartForTimeValidation, disableOnError, disableOnIsSubmitting, disablePast, error: errorProp, errorParser, inputRef, maxDate, maxTime, messages, minDate, minTime, minutesStep, name, onChange, onClose, required, rules, shouldDisableDate, shouldDisableMonth, shouldDisableTime, shouldDisableYear, shouldUnregister, slotProps, style, timezone, transform, ...rest } = props; const adapter = useMuiXDateTimePickerAdapter( { classes: undefined, className, composeClassName: false, composeHelperText: true, control, defaultValue, disabled, disableFuture, disableIgnoringDatePartForTimeValidation, disableOnError, disableOnIsSubmitting, disablePast, error: errorProp, errorParser, inputRef, maxDate, maxTime, messages, minDate, minTime, minutesStep, name, onChange, onClose, required, rules, shouldDisableDate, shouldDisableMonth, shouldDisableTime, shouldDisableYear, shouldUnregister, slotProps, style, timezone, transform, }, ref, ); return <DateTimePicker {...rest} {...adapter} />;}export const MuiXDateTimePickerElement = React.forwardRef( MuiXDateTimePickerComponent,) as typeof MuiXDateTimePickerComponent & { displayName?: string };if (process.env.NODE_ENV !== 'production') { MuiXDateTimePickerElement.displayName = 'MuiXDateTimePickerElement';}Props
Prop
Type
Return value
Prop
Type