Piplup
@piplup/rhf-adaptersmui-materialComponents

MuiIconButtonElement

A pre-integrated MuiIconButtonElement component for React Hook Form-aware icon button actions.

Import

import { MuiIconButtonElement } from "@piplup/rhf-adapters/mui-material";

Usage

"use client";import AddIcon from "@mui/icons-material/Add";import Stack from "@mui/material/Stack";import {  MuiIconButtonElement,  MuiTextFieldElement,} from "@piplup/rhf-adapters/mui-material";import { useForm } from "react-hook-form";export default function Page() {  const { control, handleSubmit } = useForm({ defaultValues: { name: "" } });  return (    <form      onSubmit={handleSubmit((values) =>        alert(JSON.stringify(values, null, 2)),      )}    >      <Stack spacing={2}>        <MuiTextFieldElement control={control} name="name" label="Name" />        <div>          <MuiIconButtonElement control={control} type="submit" color="primary">            <AddIcon />          </MuiIconButtonElement>        </div>      </Stack>    </form>  );}
"use client";import AddIcon from "@mui/icons-material/Add";import Stack from "@mui/material/Stack";import {  MuiIconButtonElement,  MuiTextFieldElement,} from "@piplup/rhf-adapters/mui-material";import { FormContainer } from "@piplup/rhf-core";export default function Page() {  return (    <FormContainer      defaultValues={{ name: "" }}      onSubmit={(values) => alert(JSON.stringify(values, null, 2))}    >      <Stack spacing={2}>        <MuiTextFieldElement name="name" label="Name" />        <div>          <MuiIconButtonElement type="submit" color="primary">            <AddIcon />          </MuiIconButtonElement>        </div>      </Stack>    </FormContainer>  );}

Props

Prop

Type

MuiIconButtonElement supports props of the MUI IconButton component, along with additional adapter-specific props. For a complete list of available IconButton properties, refer to the MUI API documentation.

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

Notes

  • For custom icon button UIs, build on useMuiIconButtonAdapter.

See also

On this page