Skip to content

Commit

Permalink
docs(mui-controlled-form): update README to reflect react-hook-form u…
Browse files Browse the repository at this point in the history
…sage
  • Loading branch information
gregmartDOTin committed Jan 23, 2025
1 parent fa7daf3 commit 1d65fa3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions packages/controlled-form/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# @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)
[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-controlled-form?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/mui-controlled-form/package.json)

## 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)

Expand Down Expand Up @@ -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

0 comments on commit 1d65fa3

Please sign in to comment.