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