@formity/react 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +29 -16
  3. package/package.json +8 -6
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2019-2024 webkid GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,32 +1,45 @@
1
- <!-- markdownlint-disable MD033 -->
2
- <!-- markdownlint-disable MD041 -->
1
+ <h1 align="center">
2
+ <img width="36" height="36" alt="Formity logo" src="https://raw.githubusercontent.com/martiserra99/formity/main/images/formity.png" /><br/>Formity
3
+ </h1>
3
4
 
4
5
  <div align="center">
5
- <a href="https://formity.app/" title="Formity - Build The Most Powerful Forms, Without The Hassle">
6
- <img src="https://raw.githubusercontent.com/martiserra99/formity/main/image.svg" alt="Formity Logo" />
7
- </a>
6
+
7
+ Formity is a React library that treats multi-step forms as programs — giving you the full power of code to build dynamic forms that adapt to every user, from onboarding flows to surveys.
8
+
9
+ [Website](https://formity.app/) · [Formity UI](https://ui.formity.app/) · [Discord](https://discord.gg/m8UrssFUBQ)
10
+
8
11
  </div>
9
12
 
10
- ## @formity/react
13
+ ---
14
+
15
+ ![preview](https://raw.githubusercontent.com/martiserra99/formity/main/images/preview.gif)
16
+
17
+ ## Featured by
18
+
19
+ > "I highly recommend Formity for creating multi-step forms. It saves you from building it yourself, which is an enormous pain. After building these a million times myself, it's awesome to finally see one that handles everything so well."
20
+ >
21
+ > — **midudev (500k+ subscribers)** | [Watch video](https://youtu.be/0apXgMZ52nM?si=N3WYhh1Cn6XydvVs)
11
22
 
12
- A highly customizable React library for creating advanced multi-step forms.
23
+ > "With Formity's pattern for steps, logic, and animations, you can give your coding agent a skill for building multi-step forms - so any time you need one, your forms are way more consistent and follow the same structure."
24
+ >
25
+ > — **Hamed Bahram (200k+ subscribers)** | [Watch video](https://youtu.be/0wGxiucgLvM?si=KNvWkRlo3-JSkqMq)
13
26
 
14
- ## Website
27
+ ## Key features of formity
15
28
 
16
- **Visit [https://formity.app](https://formity.app) to get started with Formity.**
29
+ ### Advanced logic
17
30
 
18
- ## About
31
+ You can add sophisticated logic to your multi-step forms using conditions, loops, and variables — creating truly dynamic forms where the flow adapts to every user.
19
32
 
20
- Formity is an advanced form-building package designed to help React developers create advanced multi-step forms.
33
+ ### Integration with any form library
21
34
 
22
- ## Features
35
+ Formity integrates seamlessly with your favorite form library — React Hook Form, Formik, TanStack Form or any other form-handling tool.
23
36
 
24
- - Create advanced multi-step forms where each step adapts based on the user's previous responses.
37
+ ### Advanced type inference
25
38
 
26
- - Integrate your custom components seamlessly, with no restrictions or limitations.
39
+ For TypeScript users, Formity offers advanced type inference for a smooth and error-free developer experience — with better autocomplete and improved type safety.
27
40
 
28
- - Fully compatible with any form library of your choice.
41
+ ![advanced type inference](https://raw.githubusercontent.com/martiserra99/formity/main/images/type-inference.png)
29
42
 
30
43
  ## License
31
44
 
32
- This package is licensed under the [MIT license](../../LICENSE).
45
+ This package is licensed under the [MIT license](./LICENSE).
package/package.json CHANGED
@@ -1,15 +1,17 @@
1
1
  {
2
2
  "name": "@formity/react",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "license": "MIT",
5
5
  "private": false,
6
- "description": "A highly customizable React library for creating advanced multi-step forms.",
6
+ "description": "React multi-step forms where logic has no limits - for any use case",
7
7
  "keywords": [
8
8
  "react",
9
- "formity",
9
+ "forms",
10
10
  "form",
11
- "multi-step form",
12
- "dynamic form"
11
+ "multi-step",
12
+ "multi-step-form",
13
+ "multi-step-forms",
14
+ "formity"
13
15
  ],
14
16
  "repository": {
15
17
  "type": "git",
@@ -30,7 +32,7 @@
30
32
  "dev": "rollup --config rollup.config.mjs --watch"
31
33
  },
32
34
  "dependencies": {
33
- "@formity/system": "^1.0.0"
35
+ "@formity/system": "^1.0.2"
34
36
  },
35
37
  "devDependencies": {
36
38
  "@types/react": "^18.3.12"