-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
378 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@makerx/forms-ionic': patch | ||
| '@makerx/forms-mui': patch | ||
| --- | ||
|
|
||
| Readme updates |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,152 +1,8 @@ | ||
| # @makerx/forms | ||
|
|
||
| Add typed & validated forms to your React app quickly. Currently supports ionic [(demo)](https://makerxstudio.github.io/forms/ionic-example) & mui [(demo)](https://makerxstudio.github.io/forms/mui-example) | ||
| Add typed & validated forms to your React app quickly. | ||
|
|
||
| ## Installation | ||
| Currently supports: | ||
|
|
||
| ### mui | ||
|
|
||
| ```bash | ||
| npm i @makerx/forms-mui react-hook-form | ||
| ``` | ||
|
|
||
| #### Example | ||
|
|
||
|  | ||
|
|
||
| ```tsx | ||
| import { ValidatedForm, z, zfd } from '@makerx/forms-mui'; | ||
| import { formatISO, parseISO } from 'date-fns'; | ||
|
|
||
| /** | ||
| * Define schema | ||
| */ | ||
| export const formSchema = zfd.formData({ | ||
| myString: zfd.text(z.string().trim().min(1, 'Required')), | ||
| myArray: zfd.repeatable( | ||
| z | ||
| .array(zfd.text(z.string().trim().min(1, 'Required'))) | ||
| .min(2, 'Must have at least 2 values') | ||
| ), | ||
| myDateTime: zfd.text(), | ||
| }); | ||
|
|
||
| /** | ||
| * Initialise with defaults | ||
| */ | ||
| const defaultValues: z.infer<typeof formSchema> = { | ||
| myString: '', | ||
| myArray: ['one value'], | ||
| myDateTime: '', | ||
| }; | ||
|
|
||
| /** | ||
| * Render form | ||
| */ | ||
| function App() { | ||
| const onSubmit = (data: z.infer<typeof formSchema>) => | ||
| console.log('Received data:', data); | ||
|
|
||
| return ( | ||
| <ValidatedForm | ||
| validator={formSchema} | ||
| onSubmit={onSubmit} | ||
| defaultValues={defaultValues} | ||
| > | ||
| {(helper) => ( | ||
| <> | ||
| {helper.textField({ | ||
| label: 'This is required', | ||
| field: 'myString', | ||
| })} | ||
|
|
||
| {helper.textFields({ | ||
| label: 'Should be two or more', | ||
| field: 'myArray', | ||
| minimumItemCount: 2, | ||
| })} | ||
|
|
||
| {helper.dateTimeField({ | ||
| label: 'Date', | ||
| field: 'myDateTime', | ||
| fromISO: parseISO, | ||
| toISO: formatISO, | ||
| })} | ||
|
|
||
| {helper.submitButton({ label: 'Submit' })} | ||
| </> | ||
| )} | ||
| </ValidatedForm> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| [Styled example](https://github.com/MakerXStudio/forms/blob/main/packages/mui-example/src/App.tsx) | [Live demo](https://makerxstudio.github.io/forms/mui-example) | ||
|
|
||
| ### ionic | ||
|
|
||
| ```bash | ||
| npm i @makerx/forms-ionic react-hook-form | ||
| ``` | ||
|
|
||
| #### Example | ||
|
|
||
|  | ||
|
|
||
| ```tsx | ||
| import { IonCol, IonContent, IonGrid, IonPage, IonRow } from '@ionic/react'; | ||
| import { ValidatedForm, z, zfd } from '@makerx/forms-ionic'; | ||
|
|
||
| /** | ||
| * Define schema | ||
| */ | ||
| export const formSchema = zfd.formData({ | ||
| myString: zfd.text(z.string().trim().min(1, 'Required')), | ||
| myOptionalParagraph: zfd.text(z.string().optional()), | ||
| }); | ||
|
|
||
| /** | ||
| * Initialise with defaults | ||
| */ | ||
| const defaultValues: z.infer<typeof formSchema> = { | ||
| myString: '', | ||
| myOptionalParagraph: 'something already here', | ||
| }; | ||
|
|
||
| /** | ||
| * Render form | ||
| */ | ||
|
|
||
| function App() { | ||
| const onSubmit = (data: z.infer<typeof formSchema>) => | ||
| console.log('Received data:', data); | ||
| return ( | ||
| <ValidatedForm | ||
| validator={formSchema} | ||
| onSubmit={onSubmit} | ||
| defaultValues={defaultValues} | ||
| > | ||
| {(helper) => ( | ||
| <div> | ||
| <h2>ionic-example</h2> | ||
|
|
||
| {helper.textField({ | ||
| label: 'This is required', | ||
| field: 'myString', | ||
| })} | ||
| {helper.textareaField({ | ||
| label: 'This is not required', | ||
| field: 'myOptionalParagraph', | ||
| })} | ||
|
|
||
| {helper.submitButton({ label: 'Submit' })} | ||
| </div> | ||
| )} | ||
| </ValidatedForm> | ||
| ); | ||
| } | ||
|
|
||
| export default App; | ||
| ``` | ||
|
|
||
| [Styled example](https://github.com/MakerXStudio/forms/blob/main/packages/ionic-example/src/App.tsx) | [Live demo](https://makerxstudio.github.io/forms/ionic-example) | ||
| - Ionic Framework [docs](https://github.com/MakerXStudio/forms/tree/main/packages/ionic) | [npm](https://www.npmjs.com/package/@makerx/forms-ionic) | [demo](https://makerxstudio.github.io/forms/ionic-example) | ||
| - MUI [docs](https://github.com/MakerXStudio/forms/tree/main/packages/mui) | [npm](https://www.npmjs.com/package/@makerx/forms-ionic) | [demo](https://makerxstudio.github.io/forms/mui-example) |
Oops, something went wrong.