Skip to content

Commit 9b4782e

Browse files
committed
Add link to documentation
1 parent 2323f47 commit 9b4782e

6 files changed

Lines changed: 6 additions & 49 deletions

File tree

aidbox-forms-builder-angular-controlled/README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,4 @@ management.
2828
```
2929

3030
## Available attributes
31-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
32-
* `style` - optional, style of the underlying iframe
33-
* `token` - optional, JWT token to authenticate the user
34-
* `value` - required, questionnaire as a JSON string
35-
* `hide-back` - optional, hide back button
36-
* `hide-publish` - optional, hide publish button
37-
* `hide-save` - optional, hide save button
38-
* `show-share` - optional, show share button
39-
40-
## Events
41-
* `change` - emitted when the questionnaire is modified, triggered on every change or when the save or publish button is clicked. `event.detail` contains the modified questionnaire as JSON object.
42-
* `ready` - emitted when Aidbox Forms Builder is loaded and ready to be used.
43-
* `select` - emmited when an item is selected in the item list. `event.detail` contains the selected item as JSON object.
31+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-builder) for more information about available attributes.

aidbox-forms-builder-angular/README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,4 @@ Example of integration Aidbox Forms Builder with Angular.js
1818
```
1919

2020
## Available attributes
21-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
22-
* `style` - optional, style of the underlying iframe
23-
* `token` - optional, JWT token to authenticate the user
24-
* `form-id` - optional, id of the form to load, if not provided, builder will be opened with a blank form
25-
* `hide-back` - optional, hide back button
26-
* `hide-publish` - optional, hide publish button
27-
* `hide-save` - optional, hide save button
28-
* `show-share` - optional, show share button
21+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-builder) for more information about available attributes.

aidbox-forms-renderer-angular-controlled/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,4 @@ management.
2424
```
2525

2626
## Available attributes
27-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
28-
* `style` - optional, style of the underlying iframe
29-
* `token` - optional, JWT token to authenticate the user
30-
* `questionnaire` - required, questionnaire as a JSON string
31-
* `questionnaire-response` - optional, questionnaire response as a JSON string
32-
33-
## Events
34-
* `change` - emitted when the questionnaire response is modified, triggered on auto-save or when submit button is clicked. `event.detail` contains the modified questionnaire response as JSON object.
35-
* `ready` - emitted when Aidbox Forms Renderer is loaded and ready to be used.
27+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-renderer) for more information about available attributes.

aidbox-forms-renderer-angular/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,4 @@ Example of integration Aidbox Forms Renderer with Angular.js
1515
```
1616

1717
## Available attributes
18-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
19-
* `style` - optional, style of the underlying iframe
20-
* `token` - optional, JWT token to authenticate the user
21-
* `questionnaire-id` - optional, id of the questionnaire to load, either `questionnaire` or `questionnaire-id` should be provided
22-
* `questionnaire-response-id` - optional, id of the questionnaire response to load, either `questionnaire-response` or `questionnaire-response-id` should be provided
18+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-renderer) for more information about available attributes.

aidbox-forms-renderer-react-controlled/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,4 @@ const AidboxFormRenderer = ({ questionnaire }) => {
5555
```
5656

5757
## Available attributes
58-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
59-
* `style` - optional, style of the underlying iframe
60-
* `token` - optional, JWT token to authenticate the user
61-
* `questionnaire` - required, questionnaire as a JSON string
62-
* `questionnaire-response` - optional, questionnaire response as a JSON string
63-
64-
## Events
65-
* `change` - emitted when the questionnaire response is modified, triggered on auto-save or when submit button is clicked. `event.detail` contains the modified questionnaire response as JSON object.
66-
* `ready` - emitted when Aidbox Forms Renderer is loaded and ready to be used.
58+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-renderer) for more information about available attributes.

aidbox-forms-renderer-react/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,4 @@ export default AidboxFormRenderer;
2222
```
2323

2424
## Available attributes
25-
* `base-url` - optional, base url of your Aidbox instance, default is the url of Aidbox instance the script is loaded from
26-
* `style` - optional, style of the underlying iframe
27-
* `token` - optional, JWT token to authenticate the user
28-
* `questionnaire-id` - optional, id of the questionnaire to load, either `questionnaire` or `questionnaire-id` should be provided
29-
* `questionnaire-response-id` - optional, id of the questionnaire response to load, either `questionnaire-response` or `questionnaire-response-id` should be provided
25+
Please refer to [Aidbox Forms documentation](https://docs.aidbox.app/modules/aidbox-forms/aidbox-ui-builder-alpha/embedding-renderer) for more information about available attributes.

0 commit comments

Comments
 (0)