@availity/mui-controlled-form 0.2.6 → 0.3.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.3.0](https://github.com/Availity/element/compare/@availity/mui-controlled-form@0.2.6...@availity/mui-controlled-form@0.3.0) (2025-02-17)
+
+
+### Features
+
+* **mui-block-ui:** collapsing individual rule props, deprecate individual rules and controlledform ([c559d83](https://github.com/Availity/element/commit/c559d83629f0cda74d52f3fb8bbeb0d22bfb933c))
+
 ## [0.2.6](https://github.com/Availity/element/compare/@availity/mui-controlled-form@0.2.5...@availity/mui-controlled-form@0.2.6) (2025-02-07)
 
 

package/README.md

@@ -51,13 +51,13 @@ yarn add @availity/mui-controlled-form
 #### Import through @availity/element
 
 ```tsx
-import { ControlledForm } from '@availity/element';
+import { ControlledTextField } from '@availity/element';
 ```
 
 #### Direct import
 
 ```tsx
-import { ControlledForm } from '@availity/mui-controlled-form';
+import { ControlledTextField } from '@availity/mui-controlled-form';
 ```
 
 ### Form Validation

package/dist/index.d.mts

@@ -1,26 +1,87 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { FormHTMLAttributes } from 'react';
-import { AsyncAutocompleteProps, AutocompleteProps, CodesAutocompleteProps, OrgAutocompleteProps, ProviderAutocompleteProps } from '@availity/mui-autocomplete';
-import { RegisterOptions, FieldValues, ControllerProps, SubmitHandler, Resolver } from 'react-hook-form';
+import { AutocompleteProps, AsyncAutocompleteProps, CodesAutocompleteProps, OrgAutocompleteProps, ProviderAutocompleteProps } from '@availity/mui-autocomplete';
+import { RegisterOptions, FieldValues, ControllerProps as ControllerProps$1, SubmitHandler, Resolver, UseFormProps } from 'react-hook-form';
+export { FormProvider, SubmitHandler, UseFormProps, UseFormReturn, useForm, useFormContext } from 'react-hook-form';
 import { ChipTypeMap } from '@mui/material/Chip';
 import { CheckboxProps } from '@availity/mui-checkbox';
 import { DatepickerProps } from '@availity/mui-datepicker';
 import { InputProps, RadioGroupProps, SelectProps } from '@availity/mui-form-utils';
 import { TextFieldProps } from '@availity/mui-textfield';
 
-type ControlledAsyncAutocompleteProps<Option, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledAsyncAutocomplete: <Option, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledAsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
+type ControlledAutocompleteProps<T, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledAutocomplete: <T, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, FieldProps, defaultValue, rules, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, ...rest }: ControlledAutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
 
-type ControlledAutocompleteProps<T, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onChange' | 'onBlur' | 'value' | 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledAutocomplete: <T, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, FieldProps, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, ...rest }: ControlledAutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
+type DeprecatedRulesProps = {
+    /** @deprecated moved to `rules` prop.  */
+    deps?: RegisterOptions<FieldValues, string>["deps"];
+    /** The maximum value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+    `*/
+    max?: RegisterOptions<FieldValues, string>["max"];
+    /** The maximum length of the value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    maxLength?: RegisterOptions<FieldValues, string>["maxLength"];
+    /** The minimum value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    min?: RegisterOptions<FieldValues, string>["min"];
+    /** The minimum length of the value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    minLength?: RegisterOptions<FieldValues, string>["minLength"];
+    /** The regex pattern for the input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    pattern?: RegisterOptions<FieldValues, string>["pattern"];
+    /** A Boolean which, if true, indicates that the input must have a value before
+     * the form can be submitted. You can assign a string to return an error message
+     * in the errors object.
+     * Note: This config aligns with web constrained API for required input validation,
+     * for object or array type of input use validate function instead.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    required?: RegisterOptions<FieldValues, string>["required"];
+    /** @deprecated moved to `rules` prop.  */
+    validate?: RegisterOptions<FieldValues, string>["validate"];
+};
+type ControllerProps = {
+    /** Unique name of your input */
+    name: ControllerProps$1["name"];
+    /** **Important**: Can not apply undefined to defaultValue or defaultValues at useForm.
+     * - You need to either set defaultValue at the field-level or useForm's defaultValues. undefined is not a valid value.
+     * - If your form will invoke reset with default values, you will need to provide useForm with defaultValues.
+     * - Calling onChange with undefined is not valid. You should use null or the empty string as your default/cleared value instead. */
+    defaultValue?: ControllerProps$1["defaultValue"];
+    /** If the input is disabled */
+    disabled?: ControllerProps$1["disabled"];
+    /** react-hook-form internal validation rules in the same format as [register options](https://react-hook-form.com/docs/useform/register#options), which includes:
+     * required, min, max, minLength, maxLength, pattern, validate
+     *
+     * Not used if 3rd party schema/resolver used. */
+    rules?: ControllerProps$1["rules"];
+    /** Input will be unregistered after unmount and defaultValues will be removed as well. */
+    shouldUnregister?: ControllerProps$1["shouldUnregister"];
+};
 
-type ControlledCheckboxProps = CheckboxProps & Omit<RegisterOptions<FieldValues, string>, 'required' | 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledCheckbox: ({ name, disabled, onChange, onBlur, value, defaultValue, shouldUnregister, deps, ...rest }: ControlledCheckboxProps) => react_jsx_runtime.JSX.Element;
+type ControlledAsyncAutocompleteProps<Option, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledAsyncAutocomplete: <Option, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledAsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
 
-type ControlledCodesAutocompleteProps = Omit<CodesAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledCodesAutocomplete: ({ name, defaultValue, deps, max, maxLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledCodesAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledCheckboxProps = Omit<CheckboxProps, 'disabled' | 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'disabled' | 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern'>;
+declare const ControlledCheckbox: ({ name, disabled, onChange, onBlur, value, defaultValue, rules, shouldUnregister, deps, validate, ...rest }: ControlledCheckboxProps) => react_jsx_runtime.JSX.Element;
 
+type ControlledCodesAutocompleteProps = Omit<CodesAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledCodesAutocomplete: ({ name, defaultValue, deps, max, maxLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledCodesAutocompleteProps) => react_jsx_runtime.JSX.Element;
+
+/** @deprecated Use `UseFormProps` directly with `useForm` and `FormProvider` */
 type ControlledFormProps = {
     /** This function will receive the form data if form validation is successful. */
     onSubmit: SubmitHandler<any>;
@@ -33,32 +94,67 @@ type ControlledFormProps = {
      * found here: https://github.com/react-hook-form/resolvers#quickstart
      */
     validationResolver?: (schema: unknown) => Resolver;
+    /** Additional react-hook-form `useForm` options, like `defaultValues` and validation `mode`. For more information see the [react-hook-form useForm docs](https://react-hook-form.com/docs/useform) */
+    additionalUseFormOptions?: Omit<UseFormProps, 'values' | 'resolver'>;
 } & FormHTMLAttributes<HTMLFormElement>;
-declare const ControlledForm: ({ onSubmit, values, schema, validationResolver, ...rest }: ControlledFormProps) => react_jsx_runtime.JSX.Element;
+/** @deprecated Use `FormProvider` and `useForm` directly. */
+declare const ControlledForm: ({ onSubmit, values, schema, validationResolver, additionalUseFormOptions, ...rest }: ControlledFormProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledDatepickerProps = DatepickerProps & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledDatepicker: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledDatepickerProps) => react_jsx_runtime.JSX.Element;
+type ControlledDatepickerProps = Omit<DatepickerProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledDatepicker: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledDatepickerProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledInputProps = Omit<InputProps, 'error' | 'name' | 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledInput: ({ name, required, maxLength, minLength, max, min, pattern, validate, defaultValue, disabled, onChange, onBlur, value, shouldUnregister, deps, ...rest }: ControlledInputProps) => react_jsx_runtime.JSX.Element;
+type ControlledInputProps = Omit<InputProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledInput: ({ name, defaultValue, deps, disabled, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledInputProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledOrgAutocompleteProps = Omit<OrgAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledOrganizationAutocomplete: ({ name, defaultValue, deps, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledOrgAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledOrgAutocompleteProps = Omit<OrgAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'max' | 'maxLength' | 'min' | 'minLength'>;
+declare const ControlledOrganizationAutocomplete: ({ name, defaultValue, deps, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledOrgAutocompleteProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledProviderAutocompleteProps = Omit<ProviderAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledProviderAutocomplete: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledProviderAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledProviderAutocompleteProps = Omit<ProviderAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledProviderAutocomplete: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledProviderAutocompleteProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledRadioGroupProps = RadioGroupProps & {
+type ControlledRadioGroupProps = {
     name: string;
     label: string;
     helperText?: string;
-} & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern' | 'validate'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledRadioGroup: ({ name, helperText, label, defaultValue, deps, onBlur, onChange, required, shouldUnregister, value, ...rest }: ControlledRadioGroupProps) => react_jsx_runtime.JSX.Element;
+} & Omit<RadioGroupProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern' | 'required' | 'validate'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledRadioGroup: ({ name, helperText, label, defaultValue, deps, onBlur, onChange, required, rules, shouldUnregister, value, ...rest }: ControlledRadioGroupProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledSelectProps = Omit<SelectProps, 'error' | 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledSelect: ({ name, required, maxLength, minLength, max, min, pattern, validate, disabled, onChange, onBlur, value, defaultValue, shouldUnregister, deps, ...rest }: ControlledSelectProps) => react_jsx_runtime.JSX.Element;
+type ControlledSelectProps = Omit<SelectProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledSelect: ({ name, defaultValue, deps, disabled, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledSelectProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledTextFieldProps = Omit<TextFieldProps, 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledTextField: ({ name, helperText, required, maxLength, minLength, max, min, pattern, validate, disabled, defaultValue, onChange, onBlur, value, shouldUnregister, deps, ...rest }: ControlledTextFieldProps) => react_jsx_runtime.JSX.Element;
+type ControlledTextFieldProps = Omit<TextFieldProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add required asterisk to `label` and `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledTextField: ({ name, defaultValue, deps, disabled, helperText, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledTextFieldProps) => react_jsx_runtime.JSX.Element;
 
 export { ControlledAsyncAutocomplete, type ControlledAsyncAutocompleteProps, ControlledAutocomplete, type ControlledAutocompleteProps, ControlledCheckbox, type ControlledCheckboxProps, ControlledCodesAutocomplete, type ControlledCodesAutocompleteProps, ControlledDatepicker, type ControlledDatepickerProps, ControlledForm, type ControlledFormProps, ControlledInput, type ControlledInputProps, type ControlledOrgAutocompleteProps, ControlledOrganizationAutocomplete, ControlledProviderAutocomplete, type ControlledProviderAutocompleteProps, ControlledRadioGroup, type ControlledRadioGroupProps, ControlledSelect, type ControlledSelectProps, ControlledTextField, type ControlledTextFieldProps };

package/dist/index.d.ts

@@ -1,26 +1,87 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { FormHTMLAttributes } from 'react';
-import { AsyncAutocompleteProps, AutocompleteProps, CodesAutocompleteProps, OrgAutocompleteProps, ProviderAutocompleteProps } from '@availity/mui-autocomplete';
-import { RegisterOptions, FieldValues, ControllerProps, SubmitHandler, Resolver } from 'react-hook-form';
+import { AutocompleteProps, AsyncAutocompleteProps, CodesAutocompleteProps, OrgAutocompleteProps, ProviderAutocompleteProps } from '@availity/mui-autocomplete';
+import { RegisterOptions, FieldValues, ControllerProps as ControllerProps$1, SubmitHandler, Resolver, UseFormProps } from 'react-hook-form';
+export { FormProvider, SubmitHandler, UseFormProps, UseFormReturn, useForm, useFormContext } from 'react-hook-form';
 import { ChipTypeMap } from '@mui/material/Chip';
 import { CheckboxProps } from '@availity/mui-checkbox';
 import { DatepickerProps } from '@availity/mui-datepicker';
 import { InputProps, RadioGroupProps, SelectProps } from '@availity/mui-form-utils';
 import { TextFieldProps } from '@availity/mui-textfield';
 
-type ControlledAsyncAutocompleteProps<Option, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledAsyncAutocomplete: <Option, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledAsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
+type ControlledAutocompleteProps<T, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledAutocomplete: <T, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, FieldProps, defaultValue, rules, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, ...rest }: ControlledAutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
 
-type ControlledAutocompleteProps<T, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onChange' | 'onBlur' | 'value' | 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledAutocomplete: <T, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, FieldProps, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, ...rest }: ControlledAutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
+type DeprecatedRulesProps = {
+    /** @deprecated moved to `rules` prop.  */
+    deps?: RegisterOptions<FieldValues, string>["deps"];
+    /** The maximum value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+    `*/
+    max?: RegisterOptions<FieldValues, string>["max"];
+    /** The maximum length of the value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    maxLength?: RegisterOptions<FieldValues, string>["maxLength"];
+    /** The minimum value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    min?: RegisterOptions<FieldValues, string>["min"];
+    /** The minimum length of the value to accept for this input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    minLength?: RegisterOptions<FieldValues, string>["minLength"];
+    /** The regex pattern for the input.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    pattern?: RegisterOptions<FieldValues, string>["pattern"];
+    /** A Boolean which, if true, indicates that the input must have a value before
+     * the form can be submitted. You can assign a string to return an error message
+     * in the errors object.
+     * Note: This config aligns with web constrained API for required input validation,
+     * for object or array type of input use validate function instead.
+     *
+     * @deprecated moved to `rules` prop.
+     */
+    required?: RegisterOptions<FieldValues, string>["required"];
+    /** @deprecated moved to `rules` prop.  */
+    validate?: RegisterOptions<FieldValues, string>["validate"];
+};
+type ControllerProps = {
+    /** Unique name of your input */
+    name: ControllerProps$1["name"];
+    /** **Important**: Can not apply undefined to defaultValue or defaultValues at useForm.
+     * - You need to either set defaultValue at the field-level or useForm's defaultValues. undefined is not a valid value.
+     * - If your form will invoke reset with default values, you will need to provide useForm with defaultValues.
+     * - Calling onChange with undefined is not valid. You should use null or the empty string as your default/cleared value instead. */
+    defaultValue?: ControllerProps$1["defaultValue"];
+    /** If the input is disabled */
+    disabled?: ControllerProps$1["disabled"];
+    /** react-hook-form internal validation rules in the same format as [register options](https://react-hook-form.com/docs/useform/register#options), which includes:
+     * required, min, max, minLength, maxLength, pattern, validate
+     *
+     * Not used if 3rd party schema/resolver used. */
+    rules?: ControllerProps$1["rules"];
+    /** Input will be unregistered after unmount and defaultValues will be removed as well. */
+    shouldUnregister?: ControllerProps$1["shouldUnregister"];
+};
 
-type ControlledCheckboxProps = CheckboxProps & Omit<RegisterOptions<FieldValues, string>, 'required' | 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledCheckbox: ({ name, disabled, onChange, onBlur, value, defaultValue, shouldUnregister, deps, ...rest }: ControlledCheckboxProps) => react_jsx_runtime.JSX.Element;
+type ControlledAsyncAutocompleteProps<Option, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> = Omit<AsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledAsyncAutocomplete: <Option, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any, keyof react.JSX.IntrinsicElements> = "div">({ name, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledAsyncAutocompleteProps<Option, Multiple, DisableClearable, FreeSolo, ChipComponent>) => react_jsx_runtime.JSX.Element;
 
-type ControlledCodesAutocompleteProps = Omit<CodesAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledCodesAutocomplete: ({ name, defaultValue, deps, max, maxLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledCodesAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledCheckboxProps = Omit<CheckboxProps, 'disabled' | 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'disabled' | 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern'>;
+declare const ControlledCheckbox: ({ name, disabled, onChange, onBlur, value, defaultValue, rules, shouldUnregister, deps, validate, ...rest }: ControlledCheckboxProps) => react_jsx_runtime.JSX.Element;
 
+type ControlledCodesAutocompleteProps = Omit<CodesAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledCodesAutocomplete: ({ name, defaultValue, deps, max, maxLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledCodesAutocompleteProps) => react_jsx_runtime.JSX.Element;
+
+/** @deprecated Use `UseFormProps` directly with `useForm` and `FormProvider` */
 type ControlledFormProps = {
     /** This function will receive the form data if form validation is successful. */
     onSubmit: SubmitHandler<any>;
@@ -33,32 +94,67 @@ type ControlledFormProps = {
      * found here: https://github.com/react-hook-form/resolvers#quickstart
      */
     validationResolver?: (schema: unknown) => Resolver;
+    /** Additional react-hook-form `useForm` options, like `defaultValues` and validation `mode`. For more information see the [react-hook-form useForm docs](https://react-hook-form.com/docs/useform) */
+    additionalUseFormOptions?: Omit<UseFormProps, 'values' | 'resolver'>;
 } & FormHTMLAttributes<HTMLFormElement>;
-declare const ControlledForm: ({ onSubmit, values, schema, validationResolver, ...rest }: ControlledFormProps) => react_jsx_runtime.JSX.Element;
+/** @deprecated Use `FormProvider` and `useForm` directly. */
+declare const ControlledForm: ({ onSubmit, values, schema, validationResolver, additionalUseFormOptions, ...rest }: ControlledFormProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledDatepickerProps = DatepickerProps & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledDatepicker: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledDatepickerProps) => react_jsx_runtime.JSX.Element;
+type ControlledDatepickerProps = Omit<DatepickerProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledDatepicker: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledDatepickerProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledInputProps = Omit<InputProps, 'error' | 'name' | 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledInput: ({ name, required, maxLength, minLength, max, min, pattern, validate, defaultValue, disabled, onChange, onBlur, value, shouldUnregister, deps, ...rest }: ControlledInputProps) => react_jsx_runtime.JSX.Element;
+type ControlledInputProps = Omit<InputProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledInput: ({ name, defaultValue, deps, disabled, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledInputProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledOrgAutocompleteProps = Omit<OrgAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledOrganizationAutocomplete: ({ name, defaultValue, deps, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledOrgAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledOrgAutocompleteProps = Omit<OrgAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'max' | 'maxLength' | 'min' | 'minLength'>;
+declare const ControlledOrganizationAutocomplete: ({ name, defaultValue, deps, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledOrgAutocompleteProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledProviderAutocompleteProps = Omit<ProviderAutocompleteProps, 'name'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledProviderAutocomplete: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledProviderAutocompleteProps) => react_jsx_runtime.JSX.Element;
+type ControlledProviderAutocompleteProps = Omit<ProviderAutocompleteProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & DeprecatedRulesProps;
+declare const ControlledProviderAutocomplete: ({ name, defaultValue, deps, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, FieldProps, ...rest }: ControlledProviderAutocompleteProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledRadioGroupProps = RadioGroupProps & {
+type ControlledRadioGroupProps = {
     name: string;
     label: string;
     helperText?: string;
-} & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern' | 'validate'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledRadioGroup: ({ name, helperText, label, defaultValue, deps, onBlur, onChange, required, shouldUnregister, value, ...rest }: ControlledRadioGroupProps) => react_jsx_runtime.JSX.Element;
+} & Omit<RadioGroupProps, 'onBlur' | 'onChange' | 'value' | 'name'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'max' | 'maxLength' | 'min' | 'minLength' | 'pattern' | 'required' | 'validate'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledRadioGroup: ({ name, helperText, label, defaultValue, deps, onBlur, onChange, required, rules, shouldUnregister, value, ...rest }: ControlledRadioGroupProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledSelectProps = Omit<SelectProps, 'error' | 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledSelect: ({ name, required, maxLength, minLength, max, min, pattern, validate, disabled, onChange, onBlur, value, defaultValue, shouldUnregister, deps, ...rest }: ControlledSelectProps) => react_jsx_runtime.JSX.Element;
+type ControlledSelectProps = Omit<SelectProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledSelect: ({ name, defaultValue, deps, disabled, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledSelectProps) => react_jsx_runtime.JSX.Element;
 
-type ControlledTextFieldProps = Omit<TextFieldProps, 'required'> & Omit<RegisterOptions<FieldValues, string>, 'disabled' | 'valueAsNumber' | 'valueAsDate' | 'setValueAs'> & Pick<ControllerProps, 'defaultValue' | 'shouldUnregister' | 'name'>;
-declare const ControlledTextField: ({ name, helperText, required, maxLength, minLength, max, min, pattern, validate, disabled, defaultValue, onChange, onBlur, value, shouldUnregister, deps, ...rest }: ControlledTextFieldProps) => react_jsx_runtime.JSX.Element;
+type ControlledTextFieldProps = Omit<TextFieldProps, 'onBlur' | 'onChange' | 'value' | 'name' | 'required'> & Pick<RegisterOptions<FieldValues, string>, 'onBlur' | 'onChange' | 'value'> & ControllerProps & Omit<DeprecatedRulesProps, 'required'> & {
+    /** If `true`, will add required asterisk to `label` and `aria-required` to `input`.
+     *
+     * @deprecated There has been a collision of properties. The boolean value
+     * to mark the input as required will remain in future versions, but the
+     * required object for `react-hook-form` has been moved to the `rules` prop.
+     */
+    required?: boolean | RegisterOptions['required'];
+};
+declare const ControlledTextField: ({ name, defaultValue, deps, disabled, helperText, max, maxLength, min, minLength, onBlur, onChange, pattern, required, rules, shouldUnregister, validate, value, ...rest }: ControlledTextFieldProps) => react_jsx_runtime.JSX.Element;
 
 export { ControlledAsyncAutocomplete, type ControlledAsyncAutocompleteProps, ControlledAutocomplete, type ControlledAutocompleteProps, ControlledCheckbox, type ControlledCheckboxProps, ControlledCodesAutocomplete, type ControlledCodesAutocompleteProps, ControlledDatepicker, type ControlledDatepickerProps, ControlledForm, type ControlledFormProps, ControlledInput, type ControlledInputProps, type ControlledOrgAutocompleteProps, ControlledOrganizationAutocomplete, ControlledProviderAutocomplete, type ControlledProviderAutocompleteProps, ControlledRadioGroup, type ControlledRadioGroupProps, ControlledSelect, type ControlledSelectProps, ControlledTextField, type ControlledTextFieldProps };