Forms Plugins/Hooks

This page describes the Plugins and hooks provided by the module.

For general information about plugins, see Plugins.

Plugins

BPC Forms Plugin

This plugin allows a BPC Forms component to be displayed within a hook.

The form to be displayed can reference either an existing BPC Forms component (moduleId), a form from the repository (formId), or an external Form Configuration (formUrl). It is also possible to directly specify a valid Form Configuration (formConfig) in the plugin.

The following settings can be configured via the plugin settings.

moduleId: References an existing BPC Forms component by its ID.
Cannot be combined with formUrl, formConfig, or formId.
formUrl: References an external source for a Form Configuration. The URL must be accessible to the end user. Please note any CORS requirements that may apply.
Cannot be combined with moduleId, formConfig, or formId.
formConfig: A valid Form Configuration in JSON format can be specified directly here.
Cannot be combined with moduleId, formUrl, or formId.
formId: References a form stored in the internal Forms Repository via its repository ID. Additionally, a specific version can be referenced via formVersion. If formVersion is not specified, the latest version is always used.
Cannot be combined with moduleId, formUrl, or formConfig.
formVersion: Used to reference a specific version of a form in the Forms Repository. Can only be used in conjunction with formId.
debug: If this Parameter is set to true, the debug view of Renderer is activated.
initialData: Form data can be defined here. The form’s data area is initialized with this data.

Possible parameters for a plugin configuration

{
    "moduleId": null,
    "formUrl"     : null,
    "formConfig"  : null,
    "formId"      : null,
    "formVersion" : null,
    "debug"       : false,
    "initialData" : null
}

Hooks

This module does not provide any hooks.

Keywords: