inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs and prop tables (#2913)

Browse Source
This commit is contained in:
Andy Stark
2018-02-05 19:05:48 +00:00
committed by Eugenio Romano
parent b232d05c4f
commit 03cca19599
22 changed files with 302 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/webscript.component.md
View File

@@ -42,24 +42,20 @@ export class AppComponent {
### Properties
| Attribute | Type | Default | Description |
| --------- | ---- | ------- | ----------- |
| scriptPath | string | | (**mandatory**) path to Web Script (as defined by Web Script) |
| scriptArgs | Object | | arguments to pass to Web Script |
| contextRoot | string | | path where application is deployed |
| scriptPath | string | alfresco | path to Web Script (as defined by Web Script) |
| contentType | string | service | path where Web Script service is mapped default value |
| contentType | string | TEXT | how to handle the data received from the web script JSON , HTML , DATATABLE or TEXT |
| showData | boolean | true | render the webscript data |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
| scriptArgs | `any` | | Arguments to pass to the webscript. |
| showData | `boolean` | `true` | Toggles whether to show or hide the data. |
| contextRoot | `string` | `'alfresco'` | Path where the application is deployed |
| servicePath | `string` | `'service'` | Path that the webscript service is mapped to. |
| contentType | `string` | `'TEXT'` | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
### Events
| Name | Description |
| ---- | ----------- |
| success | You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application |
**contentType** {string}
**_data_** {string} data containing the plain value you get from the webscipt as an output parameter
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `EventEmitter<{}>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
## Details