Skip to content

Commit bac5435

Browse files
authored
Update README.md
1 parent fd8a412 commit bac5435

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,27 @@ $ npm install --save angular-formio jsoneditor ngx-bootstrap @angular/elements @
3434
```
3535
Yes, you have to install 5 packages!!! :scream:
3636

37+
Having in mind the dependency graph can be useful for choosing the version of the various packages for your application. :wink:
3738
<details>
38-
<summary>Open this spoiler to see the peer dependencies graph. :wink:</summary>
39-
39+
<summary><b>Open this spoiler to see the peer dependency graph.</b></summary>
40+
4041
<p align="center">
41-
<img alt="Peer dependencies graph" src="https://user-images.githubusercontent.com/2366334/83361282-eb312380-a387-11ea-9c40-252cac64f846.png">
42+
<img alt="Peer dependencies graph" src="https://user-images.githubusercontent.com/2366334/83365783-0b260e80-a3ab-11ea-8197-e463625dfd15.png">
4243
</p>
4344
<!--
4445
```mermaid
4546
graph TD
47+
subgraph Legend
48+
START[ ]-.->|has peer dependency|STOP[ ]
49+
style START fill:#FFFFFF00, stroke:#FFFFFF00;
50+
style STOP fill:#FFFFFF00, stroke:#FFFFFF00;
51+
end
4652
davebaol-angular-formio-editor("@davebaol/angular-formio-editor")
47-
davebaol-angular-formio-editor-.->|has peer dependency|jsoneditor
48-
davebaol-angular-formio-editor-.->|has peer dependency|angular-formio
49-
davebaol-angular-formio-editor-.->|has peer dependency|ngx-bootstrap
50-
angular-formio-.->|has peer dependency|ngx-bootstrap
51-
angular-formio-.->|has peer dependency|angular-elements("@angular/elements")
53+
davebaol-angular-formio-editor-.->jsoneditor
54+
davebaol-angular-formio-editor-.->angular-formio
55+
davebaol-angular-formio-editor-.->ngx-bootstrap
56+
angular-formio-.->ngx-bootstrap
57+
angular-formio-.->angular-elements("@angular/elements")
5258
```
5359
-->
5460

@@ -141,12 +147,18 @@ So you don't have necessarily to add bootstrap and its peer dependency jQuery.
141147

142148
## Documentation
143149

144-
The component supports the input arguments `form`, `option` and `reset` described below.
150+
The component supports the input arguments `form`, `option` and `reset` described inside the spoilers below.
145151

146-
### form
152+
<details>
153+
<summary><b>form</b></summary>
154+
147155
This is a regular form defined by the form.io framework. The component modifies this argument in place.
148156

149-
### options
157+
</details>
158+
159+
<details>
160+
<summary><b>options</b></summary>
161+
150162
The options to configure the component are described below. Be aware that options are only intended as a component setup at creation-time.
151163
```javascript
152164
{
@@ -183,6 +195,13 @@ The options to configure the component are described below. Be aware that option
183195
}
184196
}
185197
```
198+
</details>
199+
<details>
200+
<summary><b>refresh</b></summary>
201+
202+
TBD
203+
204+
</details>
186205

187206
## License
188207

0 commit comments

Comments
 (0)