@simoncomputing/mui-bueno-v3 0.1.12 → 0.1.14

package/README.md

@@ -1,6 +1,6 @@
 # MUI Bueno v3
 
-A React component library based on [Material UI](https://mui.com/material-ui) components with built-in support for [Formik](https://formik.org/). Rebuilt & redesigned based on the original [mui-bueno](https://www.npmjs.com/package/mui-bueno) library, and expanded to provide additional components beyond form components.
+A React component library based on [Material UI](https://mui.com/material-ui) components with built-in support for [React Hook Form](https://react-hook-form.com/). Rebuilt & redesigned based on the original [mui-bueno](https://www.npmjs.com/package/@simoncomputing/mui-bueno-v3) library, and expanded to provide additional components beyond form components.
 
 ![SimonComputing Logo](https://simoncomputing.com/staging/img/sc-logo/SC_logo_scratched_bluer_mobile.png)
 

package/dist/components/Form/Inputs/Autocomplete/Autocomplete.d.ts

@@ -1,7 +1,7 @@
 import { AutocompleteProps as MuiAutocompleteProps, TypographyProps } from '@mui/material';
 export type BaseAutocompleteProps<T> = {
     /**
-     * Name of the component. Must match a key from initialValues in Formik.
+     * Name of the component. Must match a key from initialValues in react-hook-form.
      * @required
      */
     name: string;
@@ -38,7 +38,7 @@ export type BaseAutocompleteProps<T> = {
     /**
      * If true, an asterisk will be displayed next to the label
      * Most browsers will automatically validate this, but it's recommended to also
-     * have Formik also validate as well so that `Error` displays for consistency.
+     * have react-hook-form also validate as well so that `Error` displays for consistency.
      * @default false
      */
     required?: boolean;
@@ -48,13 +48,13 @@ export type BaseAutocompleteProps<T> = {
      */
     clearOnSelect?: boolean;
     /**
-     * When using Autocomplete with objects, this prop can be used to store only a property of that object in formik.
+     * When using Autocomplete with objects, this prop can be used to store only a property of that object in react-hook-form.
      *
      * For example, if you have `type User = { id: number; firstName: string; lastName: string; ... }`, you can
-     * set useFieldAsValue="id" if you want formik to only store the user's id rather than the whole user object.
+     * set useFieldAsValue="id" if you want react-hook-form to only store the user's id rather than the whole user object.
      *
-     * NOTE: This will require extra processing on the client-side compared to just using the object for the formik value
-     * because the Autocomplete will have to search `options` for the object with the property matching formik's initial value.
+     * NOTE: This will require extra processing on the client-side compared to just using the object for the react-hook-form value
+     * because the Autocomplete will have to search `options` for the object with the property matching react-hook-form's initial value.
      *
      */
     useFieldAsValue?: string;

package/dist/components/Form/Inputs/Checkbox/Checkbox.d.ts

@@ -2,7 +2,7 @@ import { CheckboxProps as MuiCheckboxProps, TypographyProps } from '@mui/materia
 import * as React from "react";
 type BaseCheckboxProps = {
     /**
-     * Must match a key from initialValues in Formik.
+     * Must match a key from initialValues in react-hook-form.
      * @required
      */
     name: string;
@@ -36,7 +36,7 @@ type BaseCheckboxProps = {
     /**
      * If true, an asterisk will be displayed next to the label
      * Most browsers will automatically validate this, but it's recommended to also
-     * have Formik also validate as well so that `Error` displays for consistency.
+     * have react-hook-form also validate as well so that `Error` displays for consistency.
      * @default false
      */
     required?: boolean;

package/dist/components/Form/Inputs/CheckboxGroup/CheckboxGroup.d.ts

@@ -59,7 +59,7 @@ export type CheckboxGroupProps = {
     /**
      * If true, an asterisk will be displayed next to the label
      * Most browsers will automatically validate this, but it's recommended to also
-     * have Formik also validate as well so that `Error` displays for consistency.
+     * have react-hook-form also validate as well so that `Error` displays for consistency.
      * @default false
      */
     required?: boolean;

package/dist/components/Form/Inputs/FileUpload/FileUpload.d.ts

@@ -2,7 +2,7 @@ import { TypographyProps } from '@mui/material';
 import * as React from 'react';
 export type FileUploadProps = {
     /**
-     * Must match a key from initialValues in Formik.
+     * Must match a key from initialValues in react-hook-form.
      * @required
      */
     name: string;

package/dist/components/Form/Inputs/RadioGroup/RadioGroup.d.ts

@@ -86,7 +86,7 @@ type BaseRadioGroupProps<T> = {
     /**
      * If true, an asterisk will be displayed next to the label
      * Most browsers will automatically validate this, but it's recommended to also
-     * have ( NOT Formik) also validate as well so that `Error` displays for consistency.
+     * have ( NOT react-hook-form) also validate as well so that `Error` displays for consistency.
      * @default false
      */
     required?: boolean;

package/dist/components/Form/Inputs/RangeSlider/RangeSlider.d.ts

@@ -2,7 +2,7 @@ import { SliderProps, TypographyProps } from '@mui/material';
 import * as React from 'react';
 type BaseRangeSliderProps = {
     /**
-     * Must match a key from initialValues in Formik.
+     * Must match a key from initialValues in react-hook-form.
      * @required
      */
     name: string;

package/dist/components/Form/Inputs/Select/Select.d.ts

@@ -35,7 +35,7 @@ export interface SelectOption<T> {
     /**
      * If true, an asterisk will be displayed next to the label
      * Most browsers will automatically validate this, but it's recommended to also
-     * have Formik also validate as well so that `Error` displays for consistency.
+     * have react-hook-form also validate as well so that `Error` displays for consistency.
      * @default false
      */
     required?: boolean;

package/dist/components/Form/Inputs/TextField/TextField.d.ts

@@ -2,7 +2,7 @@ import { TypographyProps, TextFieldProps as MuiTextFieldProps } from '@mui/mater
 import * as React from "react";
 type BaseTextFieldProps = {
     /**
-     * Name and ID of the component. Must match a key from initialValues in Formik.
+     * Name and ID of the component. Must match a key from initialValues in react-hook-form.
      * @required
      */
     name: string;

package/dist/components/Form/RepeatableFormGroup/RepeatableFormGroup.d.ts

@@ -4,12 +4,12 @@ type RepeatableGroupWrapperType = 'card' | 'elevatedCard' | 'none';
 type RepeatableRemovePosition = 'bottom' | 'right';
 export type RepeatableFormGroupProps<T> = {
     /**
-     * Name of field. Must match the name of the array in Formik.
+     * Name of field. Must match the name of the array in react-hook-form.
      */
     name: string;
     /**
      * An "empty" object of type T.
-     * This is what you would normally pass to initialState for Formik for a single object of type T
+     * This is what you would normally pass to initialState for react-hook-form for a single object of type T
      */
     initialState: T;
     /**
@@ -83,7 +83,7 @@ export type RepeatableFormGroupProps<T> = {
 };
 /**
  * Repeatable Form Group is used for handling arrays in forms. It automatically handles adding & removing
- * field groups (components containing one or multiple fields) using Formik.
+ * field groups (components containing one or multiple fields) using react-hook-form.
  */
 export declare const RepeatableFormGroup: <T>(props: RepeatableFormGroupProps<T>) => import("react/jsx-runtime").JSX.Element;
 export default RepeatableFormGroup;