Documentation & examples for custom components

[jared.w...@delta-automation.com.au]

Are there any more examples or documentation for the custom components? Some of the manifest options aren't explained very well and some are not even documented (e.g. gwdSpecific dropdown type which I only discovered on a third party blog).

Thanks,
Jared

[jaredwi...@gmail.com]

I'll share some things I've gleaned from the components from the Rich Media Gallery.

Top level - "Nestable" not sure what exactly this does
"nestable": false

Top level - sizing
"defaultWidth": 100,
"defaultHeight": 100,
"isFixedSize": false,

Attributes - create dropdown list
{
"type": "string",
"gwdSpecific": {
"type": "dropdown",
"items": ["light", "dark"]
}
}

Attributes - dropdown with labels
{
"type": "string",
"gwdSpecific": {
"type": "dropdown",
"dataField": "value",
"labelField": "label",
"items": [
{
"value": "before",
"label": "One or more days before"
}, ...

Attributes - array type, not sure how this works
"type": "array",

[Jaz]

Hi Jared,

I think our new component API article may help, can you take a look and let us know if you need anything more?

thx!
jaz
Program Manager, GWD

[jaredwi...@gmail.com]

Thanks Jaz, it doesn't really help. Although I did learn that there's a "color" property type.

I think the "Component JSON manifest" document could be fleshed out a lot more. Is this manifest format based on something else? It seems like it could be since it has "gwdSpecific" entries..

[jaredwi...@gmail.com]

Also none of the images from the images array seem to get loaded and I also can't get the icon to work. Some documentation on the icon file type and size would be useful!

[Jeremy Banks]

Hello Jared,

I'm afraid we don't have any documentation available aside from what's in our help center, including the new document Jaz linked above. The manifest format is not based on anything else.

Fields that aren't in the public documentation are liable to change in future releases. For example, the behaviour of the "nestable" may be changing, and it shouldn't be used.

 

Also none of the images from the images array seem to get loaded and I also can't get the icon to work. Some documentation on the icon file type and size would be useful!

It's possible that your issue with the images loading may be fixed by adding "asset": true to the attribute's entry in the manifest, so that GWD knows the files need to be included in publication.

Customizing the icon for your component is not currently supported. We'd like to fix this and continue to improve the documentation in the future.

Cheers,

Jeremy

GWD Engineer