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