forked from gutentag2012/form-signals
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add doc section about examples
- Loading branch information
1 parent
69cd3ad
commit bf26ff3
Showing
4 changed files
with
29 additions
and
2 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
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,24 @@ | ||
# Examples | ||
|
||
There are a few examples in the `examples` directory of the repository, that show how to use the library in different | ||
scenarios. | ||
|
||
## React | ||
|
||
| <div style="width:290px">Example</div> | Description | | ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | ||
| [async-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/async-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/async-form-signals?startScript=example&title=Form%20Signals%20|%20Async%20Example) | A simple form that loads data asynchronously and handles async form submission and validation | | ||
| [complex-product-details-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-form-signals?startScript=example&title=Form%20Signals%20|%20Complex%20Example) | A complex form utilizing array fields, nested objects, dynamic fields, custom validation and deeply nested components | | ||
| [complex-product-details-react-hook-form](https://github.com/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-react-hook-form) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-react-hook-form?startScript=example&title=Form%20Signals%20|%20Complex%20Example%20|%20React%20Hook%20Form) | The complex example just implemented using react hook form form comparison | | ||
| [complex-product-details-tanstack-form](https://github.com/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-tanstack-form) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/complex-product-details-tanstack-form?startScript=example&title=Form%20Signals%20|%20Complex%20Example%20|%20Tanstack%20Form) | The complex example just implemented using tanstack form form comparison | | ||
| [e-commerce-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/e-commerce-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/e-commerce-form-signals?startScript=example&title=Form%20Signals%20|%20E-Commerce%20Example) | Creates a form outside of a component and uses it in different locations through a global import | | ||
| [files-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/files-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/files-form-signals?startScript=example&title=Form%20Signals%20|%20Files%20Example) | Utilizes file upload with the library | | ||
| [performance-test-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/performance-test-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/performance-test-form-signals?startScript=example&title=Form%20Signals%20|%Performance%20Test%20Example) | Creates an array with many a lot of individual items to stress test the performance for large forms | | ||
| [simple-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/simple-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/simple-form-signals?startScript=example&title=Form%20Signals%20|%20Simple%20Example) | A very simple example with few fields and simple validation | | ||
| [step-wizard-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react/step-wizard-form-signals) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/gutentag2012/form-signals/tree/main/examples/react/step-wizard-form-signals?startScript=example&title=Form%20Signals%20|%20Step%20Wizard%20Example) | A multi step form, that validates each step before going to the next step and finally submitting the complete form | | ||
|
||
## React Native | ||
|
||
| Example | Description | | ||
|-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| | ||
| [native-form-signals](https://github.com/gutentag2012/form-signals/tree/main/examples/react-native/native-form-signals) | A simple react native implementation using the library | |
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
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