@edsc/echoforms 1.1.17 → 1.1.18
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 +23 -5
- package/dist/index.js +2 -12
- package/dist/index.js.map +1 -1
- package/dist/styles.css +6 -0
- package/dist/styles.css.map +1 -0
- package/package.json +20 -28
- package/cypress.config.js +0 -17
- package/cypress.webpack.config.js +0 -48
package/README.md
CHANGED
|
@@ -18,11 +18,23 @@ For the jQuery version of this plugin see [this branch](https://github.com/nasa/
|
|
|
18
18
|
|
|
19
19
|
## Installation
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
```console
|
|
22
|
+
npm install @edsc/echoforms
|
|
23
|
+
```
|
|
22
24
|
|
|
23
25
|
## Usage
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
### Import the required css
|
|
28
|
+
|
|
29
|
+
The `styles.css` file must be loaded separately from the `node_modules/@edsc-echoforms/dist` directory.
|
|
30
|
+
|
|
31
|
+
```javascript
|
|
32
|
+
import '@edsc/echoforms/dist/styles.css'
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Use the EDSCEchoform component
|
|
36
|
+
|
|
37
|
+
The `EDSCEchoforms` React component is imported from the `@edsc/echoforms` module. When using the component, the `form`, `onFormModelUpdated`, and `onFormIsValidUpdated` props are required. See the Props section below for more information.
|
|
26
38
|
|
|
27
39
|
```javascript
|
|
28
40
|
import EDSCEchoform from '@edsc/echoforms'
|
|
@@ -53,15 +65,21 @@ onFormIsValidUpdated | Function | true | | Callback function that returns a Bool
|
|
|
53
65
|
|
|
54
66
|
To compile:
|
|
55
67
|
|
|
56
|
-
|
|
68
|
+
```console
|
|
69
|
+
npm install
|
|
70
|
+
```
|
|
57
71
|
|
|
58
72
|
To start the example project for local testing:
|
|
59
73
|
|
|
60
|
-
|
|
74
|
+
```console
|
|
75
|
+
npm start
|
|
76
|
+
```
|
|
61
77
|
|
|
62
78
|
To run the tests:
|
|
63
79
|
|
|
64
|
-
|
|
80
|
+
```console
|
|
81
|
+
npm test
|
|
82
|
+
```
|
|
65
83
|
|
|
66
84
|
## Contributing
|
|
67
85
|
|