To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A KEditor component registered by an app: a draggable, configurable block (e.g. a product list, a chart, a form) that a website editor can drop into a page in the content editor. Implements KEditorComponent and is produced by an app's Application implementation via the static add/addToList factory methods, then consumed by the KEditor content editor and page rendering pipeline to preview, configure and render the component. Serialised through XStream under the component element.
Group: App Definitions
Implements: KEditorComponent, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| categories | String | The categories or tags associated with this component. |
| componentId | String | The globally unique ID of this component. Note that the same component may be used in different categories. |
| defaultAtts | Map<String,String> | The default HTML data-* attributes applied to this component when an attribute is not explicitly set on it. |
| description | String | The user friendly description of this component, as passed to the add/addToList factory method that created it. |
| editorHtml | String | The HTML structure inserted into the content editor when this component is dropped in. This is later replaced with the output of rendering the render template. |
| jsFile | String | Path to the JS file used to initialise this component's client-side editor behaviour. |
| previewImage | String | Path to the image displayed for this component in the content editor's component palette. |
| previewImageHref | String | The href of the preview image displayed for this component in the content editor's component palette. |
| renderTemplate | String | Path to the template used to render this component with live data. |
| settingsTemplate | String | Path to the template used to render this component's settings form. |
| snippetHtml | String | The HTML snippet inserted into the content editor when this component is dropped in. Currently the same value as getEditorHtml(). |
| types | List<String> | The resource type names this component supports, matched via CommonResource.is(type). |
Methods
getComponentId() · getDescription() · getCategories() · getJsFile() · getEditorHtml() · getPreviewImage() · getRenderTemplate() · getSettingsTemplate() · getTypes() · getSnippetHtml() · getPreviewImageHref() · getDefaultAtts()
getComponentId()
Returns: String
The globally unique ID of this component. Note that the same component may be used in different categories.
getDescription()
Returns: String
The user friendly description of this component, as passed to the add/addToList factory method that created it.
getCategories()
Returns: String
The categories or tags associated with this component.
getJsFile()
Returns: String
Path to the JS file used to initialise this component's client-side editor behaviour.
getEditorHtml()
Returns: String
The HTML structure inserted into the content editor when this component is dropped in. This is later replaced with the output of rendering the render template.
getPreviewImage()
Returns: String
Path to the image displayed for this component in the content editor's component palette.
getRenderTemplate()
Returns: String
Path to the template used to render this component with live data.
getSettingsTemplate()
Returns: String
Path to the template used to render this component's settings form.
getTypes()
Returns: List<String>
The resource type names this component supports, matched via CommonResource.is(type).
getSnippetHtml()
Returns: String
The HTML snippet inserted into the content editor when this component is dropped in. Currently the same value as getEditorHtml().
getPreviewImageHref()
Returns: String
The href of the preview image displayed for this component in the content editor's component palette.
getDefaultAtts()
Returns: Map<String,String>
The default HTML data-* attributes applied to this component when an attribute is not explicitly set on it.
© 2025 Kademi Ltd