@bigbinary/neeto-form-frontend 1.0.8 → 1.0.9
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 +22 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ the proper functioning of the package. Install all the peer dependencies using
|
|
|
14
14
|
the below command:
|
|
15
15
|
|
|
16
16
|
```zsh
|
|
17
|
-
yarn add @bigbinary/neetoui @bigbinary/neeto-icons ramda@^0.28.0 classnames@^2.3.1 formik@2.2.9
|
|
17
|
+
yarn add @bigbinary/neetoui @bigbinary/neeto-icons ramda@^0.28.0 classnames@^2.3.1 formik@2.2.9 @bigbinary/neeto-commons-frontend
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
Import stylesheet from the following location:
|
|
@@ -49,7 +49,6 @@ import { BuildForm } from "@bigbinary/neeto-form-frontend";
|
|
|
49
49
|
|
|
50
50
|
| prop | type | description |
|
|
51
51
|
| ------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
52
|
-
| `isEmbedded` | `boolean` | To apply styles for embedding |
|
|
53
52
|
| `id` | `string` | Form id |
|
|
54
53
|
| `onUpdate` | `function` | Callback for form update |
|
|
55
54
|
| `buildRequestArgs` | `object` | Arguments for build request |
|
|
@@ -108,10 +107,7 @@ import { Submission } from "@bigbinary/neeto-form-frontend";
|
|
|
108
107
|
`useBuildFormState` hook is used to get the form state.
|
|
109
108
|
|
|
110
109
|
```js
|
|
111
|
-
import {
|
|
112
|
-
useBuildFormState,
|
|
113
|
-
BuildForm,
|
|
114
|
-
} from "@bigbinary/neeto-form-frontend";
|
|
110
|
+
import { useBuildFormState, BuildForm } from "@bigbinary/neeto-form-frontend";
|
|
115
111
|
|
|
116
112
|
const FormBuilder = () => {
|
|
117
113
|
const {
|
|
@@ -151,6 +147,26 @@ Install all the dependencies by executing the following command
|
|
|
151
147
|
yarn install
|
|
152
148
|
```
|
|
153
149
|
|
|
150
|
+
To test run and test the package locally, first configure
|
|
151
|
+
[neeto-form-engine](https://github.com/bigbinary/neeto-form-engine) in the host
|
|
152
|
+
application.
|
|
153
|
+
|
|
154
|
+
Build the application locally:
|
|
155
|
+
|
|
156
|
+
```sh
|
|
157
|
+
yarn build
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
Use `yalc` to link the package locally.
|
|
161
|
+
|
|
162
|
+
Run `yalc push` on the package root directory.
|
|
163
|
+
|
|
164
|
+
Then run the below command on the host application root directory
|
|
165
|
+
|
|
166
|
+
```zsh
|
|
167
|
+
yalc add @bigbinary/neeto-form-frontend
|
|
168
|
+
```
|
|
169
|
+
|
|
154
170
|
## Building
|
|
155
171
|
|
|
156
172
|
The neetoFormEngine-frontend package gets auto-published to npm for every new
|