Page History
...
identifier info (component name)
Info Name convention: the provided string is of the form packagenamepackage name, followed by a dash sign ('-'), followed by the componentnamecomponent name. The packagename package name is the name of the package the component is part of, and component name is simply the name of the component. Both packagename package name and componentname component name should be written in lowercaselower-case.
- dependencies
- definition of component logic, to support:
- model properties
- event handler
- callable API
- additional/child type info
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"name": "String packagename-componentname", // String
"displayName": "String more descriptive name that is shown in the designer", // String
"version": the component version (integer)
"icon": "A reference to the icon shown in designer" ,
"preview": "A reference to the preview gif to be displayed" ,
"definition": "A reference to the js file of this component",
"libraries": Array of js/css definitions (map with 'name'-the lib name, 'version'-the lib version, 'url'-the lib url, 'mimetype'-the lib mimetype, one of 'text/javascript' or 'text/css') that needs to be included for this component,
"model": {
"propertyName": type description, optional default value
},
"handlers": {
"functionName": "function type"
},
"api": {
"functionName": signature description json
},
"types": {
"typename": {
"propertyName": "type description"
}
}
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "String packagename-componentname",
"displayName": "String more descriptive name that is shown in the designer",
"categoryName": "Advanced",
...
}
|
...
Overview
Content Tools
Activity