Piplup
@piplup/rhf-adaptersmui-x-date-pickersComponents

MuiXTimeFieldElement

A pre-integrated MuiXTimeFieldElement component for connecting MUI X TimeField to React Hook Form.

Import

import { MuiXTimeFieldElement } from "@piplup/rhf-adapters/mui-x-date-pickers";

Usage

"use client";import dayjs from "dayjs";import Stack from "@mui/material/Stack";import { LocalizationProvider } from "@mui/x-date-pickers";import { AdapterDayjs } from "@mui/x-date-pickers/AdapterDayjs";import { MuiXTimeFieldElement } from "@piplup/rhf-adapters/mui-x-date-pickers";import { MuiButtonElement } from "@piplup/rhf-adapters/mui-material";import { useForm } from "react-hook-form";export default function Page() {  const { control, handleSubmit } = useForm({    defaultValues: { reminderTime: dayjs() },  });  return (    <LocalizationProvider dateAdapter={AdapterDayjs}>      <form        onSubmit={handleSubmit((values) =>          alert(JSON.stringify(values, null, 2)),        )}      >        <Stack direction="column" spacing={2}>          <MuiXTimeFieldElement            control={control}            name="reminderTime"            label="Reminder time"          />          <div>            <MuiButtonElement              control={control}              variant="contained"              type="submit"            >              Submit            </MuiButtonElement>          </div>        </Stack>      </form>    </LocalizationProvider>  );}
"use client";import dayjs from "dayjs";import Stack from "@mui/material/Stack";import { LocalizationProvider } from "@mui/x-date-pickers";import { AdapterDayjs } from "@mui/x-date-pickers/AdapterDayjs";import { MuiXTimeFieldElement } from "@piplup/rhf-adapters/mui-x-date-pickers";import { MuiButtonElement } from "@piplup/rhf-adapters/mui-material";import { FormContainer } from "@piplup/rhf-core";export default function Page() {  return (    <LocalizationProvider dateAdapter={AdapterDayjs}>      <FormContainer        defaultValues={{ reminderTime: dayjs() }}        onSubmit={(values) => alert(JSON.stringify(values, null, 2))}      >        <Stack direction="column" spacing={2}>          <MuiXTimeFieldElement name="reminderTime" label="Reminder time" />          <div>            <MuiButtonElement variant="contained" type="submit">              Submit            </MuiButtonElement>          </div>        </Stack>      </FormContainer>    </LocalizationProvider>  );}

Props

Prop

Type

MuiXTimeFieldElement supports all standard props of the MUI X TimeField component, along with additional adapter-specific props. For a complete list of available TimeField properties, refer to the MUI X Date Pickers API documentation.

The ref is forwarded to the underlying <TimeField /> component.

Notes

  • For custom time fields, build on useMuiXTimeFieldAdapter.

See also

On this page