Base Dynamic Component

Info: Available in brXM 14.3.0 and later.

Class Name

The Base Dynamic Component is implemented by the following class:

org.hippoecm.hst.component.support.bean.dynamic.BaseHstDynamicComponent

Overview

Use the Base Dynamic Component to contribute parameter data to the Delivery API for consumption by frontend applications. This component uses parameter metadata defined in the component catalog for a channel. Parameters configured with the JcrPath type trigger lookups of referenced documents. The component then includes these documents in the page model output.

Component Parameters

Name	Type	Default value	Description
*	Any (except JcrPath)	-	The parameter name and value are included in the Delivery API output.
*	JcrPath	-	The component processes all parameters of this type, looks up the referenced document by path, and includes its content in the Delivery API output. If the path references a node that is not a document, only the path is included.

The following example shows how BaseHstDynamicComponent renders its parameters in the JSON response from the Delivery API:

"uid2": {
  "id": "r22_r1_r1",
  "links": {
    "self": {
      "href": "http://localhost/site/resourceapi?_hn:type=component-rendering&_hn:ref=r22_r1_r1",
      "type": "external"
    }
  },
  "meta": {
    "paramsInfo": {
      "dateParam": 1584612567000,
      "document": "news/news1",
      "paramWithDefaultValue": "a default value",
      "decimalParam": 20.5,
      "booleanParam": true,
      "integerParam": 15,
      "param1": "value 1 in container item",
      "dropdownParam": "value1",
      "param2": "value 2 in container item"
    },
    "params": {}
  },
  "name": "testcatalogiteminstance",
  "label": "Test Catalog Item",
  "type": "container-item",
  "componentClass": "org.hippoecm.hst.component.support.bean.dynamic.BaseHstDynamicComponent",
  "models": {
    "document": {
      "$ref": "/page/u303d40ebf98c4d6184c7a1ba14b5ceb3"
    }
  }
}
copy