yg-sdui-forms 1.0.0 → 1.0.1
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.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# yg-sdui 🚀
|
|
1
|
+
# yg-sdui-forms 🚀
|
|
2
2
|
|
|
3
3
|
A lightweight, configuration-driven React form library built on top of [React Hook Form](https://react-hook-form.com/). It makes forms completely configurable so that their structure, validations, and visibility rules can be managed via JSON configuration without modifying React code.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
## 🔗 Quick Links
|
|
8
|
-
- **NPM Package**: [yg-sdui on npm](https://www.npmjs.com/package/yg-sdui)
|
|
8
|
+
- **NPM Package**: [yg-sdui-forms on npm](https://www.npmjs.com/package/yg-sdui-forms)
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
@@ -57,7 +57,7 @@ Define conditional visibility rules directly within the JSON configuration:
|
|
|
57
57
|
### 1. Installation
|
|
58
58
|
Install the package alongside `react-hook-form`:
|
|
59
59
|
```bash
|
|
60
|
-
npm install yg-sdui react-hook-form
|
|
60
|
+
npm install yg-sdui-forms react-hook-form
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
### 2. Basic Setup
|
|
@@ -66,7 +66,7 @@ Wrap the form in `react-hook-form`'s `FormProvider` and render fields using `<Fo
|
|
|
66
66
|
```jsx
|
|
67
67
|
import React from 'react';
|
|
68
68
|
import { useForm, FormProvider } from 'react-hook-form';
|
|
69
|
-
import { FormRenderer } from 'yg-sdui';
|
|
69
|
+
import { FormRenderer } from 'yg-sdui-forms';
|
|
70
70
|
|
|
71
71
|
const formFields = [
|
|
72
72
|
{
|
|
@@ -122,7 +122,7 @@ const submitBtnStyle = {
|
|
|
122
122
|
---
|
|
123
123
|
|
|
124
124
|
## 📦 Component Catalog
|
|
125
|
-
**yg-sdui** includes **18** pre-styled components categorized for form data capture. Every component is designed with standard focus states, custom toggle behaviors, and validation error styling.
|
|
125
|
+
**yg-sdui-forms** includes **18** pre-styled components categorized for form data capture. Every component is designed with standard focus states, custom toggle behaviors, and validation error styling.
|
|
126
126
|
|
|
127
127
|
### 1. Text & Numeric Inputs
|
|
128
128
|
| Component Name (`c_name`) | Purpose / Description | Key Props / Behaviors |
|
|
@@ -237,7 +237,7 @@ const userRegistrationConfig = [
|
|
|
237
237
|
Extend the library by registering custom components to `componentMap`:
|
|
238
238
|
|
|
239
239
|
```javascript
|
|
240
|
-
import { componentMap, FormRenderer } from 'yg-sdui';
|
|
240
|
+
import { componentMap, FormRenderer } from 'yg-sdui-forms';
|
|
241
241
|
|
|
242
242
|
// 1. Define custom React input
|
|
243
243
|
const CustomRatingInput = ({ path, label }) => {
|