From 1d65fa3ec02424c48abed9b1b3d316e2aa36f532 Mon Sep 17 00:00:00 2001 From: Greg Martin Date: Thu, 23 Jan 2025 11:28:33 -0500 Subject: [PATCH] docs(mui-controlled-form): update README to reflect react-hook-form usage --- packages/controlled-form/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/controlled-form/README.md b/packages/controlled-form/README.md index fc47eae9e..aeecf4f3d 100644 --- a/packages/controlled-form/README.md +++ b/packages/controlled-form/README.md @@ -1,6 +1,6 @@ # @availity/mui-controlled-form -> Availity MUI ControlledForm component to be used with @availity/element design system. +> Availity MUI Form components integrated with react-hook-form to be used with @availity/element design system. [![Version](https://img.shields.io/npm/v/@availity/mui-controlled-form.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-controlled-form) [![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-controlled-form.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-controlled-form) @@ -8,9 +8,9 @@ ## Documentation -This package extends the MUI ControlledForm component: [MUI ControlledForm Docs](https://mui.com/components/controlled-form/) +This package extends the Element's Form components with [react-hook-form](https://react-hook-form.com/). The goal of this package is to decrease the amount of setup involved with building a form using Element components and react-hook-form. If you would like to use another form library, the raw Element form components are also available. -Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/components-controlled-form-introduction--docs) +Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/form-components-controlled-form-introduction--docs) Availity standards for design and usage can be found in the [Availity Design Guide](https://zeroheight.com/2e36e50c7) @@ -59,3 +59,7 @@ import { ControlledForm } from '@availity/element'; ```tsx import { ControlledForm } from '@availity/mui-controlled-form'; ``` + +### Form Validation + +Form validation can be on a component-by-component basis, or by passing a valid schema and schema resolver. For more information on react-hook-form's schema resolvers see: https://github.com/react-hook-form/resolvers#quickstart