Piplup
@piplup/rhf-adaptersmui-materialHooks

useMuiIconButtonAdapter

Returns adapter props for building custom MUI icon button integrations with React Hook Form form state.

Import

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

Usage

import * as React from 'react';import { IconButton, type IconButtonProps } from '@mui/material';import { type FieldValues } from 'react-hook-form';import {  type UseMuiIconButtonAdapterProps,  useMuiIconButtonAdapter,} from './adapter';export interface MuiIconButtonElementProps<  TFieldValues extends FieldValues = FieldValues,> extends Omit<IconButtonProps, 'name' | 'style'>,    Omit<      UseMuiIconButtonAdapterProps<TFieldValues>,      | 'classes'      | 'composeClassName'      | 'composeHelperText'      | 'errorParser'      | 'helperText'      | 'onClick'    > {}function MuiIconButtonComponent<TFieldValues extends FieldValues = FieldValues>(  props: MuiIconButtonElementProps<TFieldValues>,  ref?: IconButtonProps['ref'],) {  const {    classes,    className,    control,    disabled,    disableOnError,    disableOnIsSubmitting,    error,    exact,    name,    onClick,    style,    type,    ...rest  } = props;  const {    error: _error,    helperText: _helperText,    ...adapter  } = useMuiIconButtonAdapter(    {      classes,      className,      composeClassName: false,      composeHelperText: false,      control,      disabled,      disableOnError,      disableOnIsSubmitting,      error,      exact,      name,      onClick,      style,      type,    },    ref,  );  return <IconButton {...rest} {...adapter} />;}export const MuiIconButtonElement = React.forwardRef(  MuiIconButtonComponent,) as typeof MuiIconButtonComponent & { displayName?: string };if (process.env.NODE_ENV !== 'production') {  MuiIconButtonElement.displayName = 'MuiIconButtonElement';}

Props

Prop

Type

Return value

Prop

Type

On this page