import { CustomOnChangeProps } from "../../common/types/components.js"; import { FormHelperTextProps, FormLabelProps, TextFieldProps } from "../../common/types/mui.js"; import "../../common/index.js"; import { ChangeEvent, JSX, ReactNode, Ref } from "react"; import { Control, FieldError, FieldValues, Path, RegisterOptions } from "react-hook-form"; import { CustomComponentIds } from "@nish1896/mui-components/types"; //#region src/mui/textfield/index.d.ts type OnValueChangeProps = { newValue: string; event: ChangeEvent; }; type RHFTextFieldProps = { /** * Name/path of the React Hook Form field this component controls. */ fieldName: Path; /** * React Hook Form control object returned by `useForm`. */ control: Control; /** * Validation rules passed to React Hook Form for this field. */ registerOptions?: RegisterOptions>; /** * Overrides the default text field change handling. * Receives the next input string and the original input change event. * Call `rhfOnChange` with the string that should be stored; else the form value will not be updated. * * @param rhfOnChange - React Hook Form field change handler for the input string. * @param newValue - Next input string. * @param event - Original input change event. */ customOnChange?: ({ rhfOnChange, newValue, event }: CustomOnChangeProps) => void; /** * Called after the default text field handler stores the next string in React Hook Form. * * ⚠️ Important: * This callback is not called when `customOnChange` is used. * * @param newValue - Next input string. * @param event - Original input change event. */ onValueChange?: ({ newValue, event }: OnValueChangeProps) => void; /** * When `true`, renders the label above the component instead of within the field layout. */ showLabelAboveFormField?: boolean; /** * Props forwarded to the internal `FormLabel`. The `id` is managed by the component. */ formLabelProps?: Omit; /** * When true, hides the rendered field label while preserving accessible labeling where possible. */ hideLabel?: boolean; /** * Custom renderer for the React Hook Form field error. * Receives the current field error and must return renderable content, such as `error.message` or a custom element. * * @param error - React Hook Form field error for this text field. */ renderError?: (error: FieldError) => ReactNode; /** * If true, hides the error message text while keeping the field in an error state. */ hideErrorMessage?: boolean; /** * Props forwarded to the internal `FormHelperText`. The `id` is managed by the component. */ formHelperTextProps?: Omit; /** * Custom ids for generated field, label, helper text, and error elements. */ customIds?: CustomComponentIds; } & TextFieldProps; /** * Controlled Material UI `TextField`, wired to a React Hook Form field via * `control`. * * Accepts almost every native `TextField` prop alongside its own RHF-specific props. * * Docs: [RHFTextField](https://rhf-mui-components.vercel.app/components/mui/RHFTextField) * * API: [RHFTextFieldProps](https://rhf-mui-components.vercel.app/components/mui/RHFTextField#api) */ declare const RHFTextField: (props: RHFTextFieldProps & { ref?: Ref; }) => JSX.Element; //#endregion export { RHFTextFieldProps, RHFTextField as default };