Skip to content

RepairDirect Widget v3 (preview) ​

The RepairDirect Widget v3 lets you display forms directly on your own website without building the forms yourself. The widget is loaded via an external JavaScript file and rendered within an HTML element on the page.

Preview: Widget v3 is not feature-complete and is available only on the acceptance environment for test pages. It is not available on go or production and must not be used on live customer sites. Use the RepairDirect Widget v2 for existing integrations.

What to expect: the preview loads your form configuration and theme and is still being built out. Not every question type is shown yet, and the form cannot be submitted yet, so do not use it to report real damage.

How does it work? ​

  1. You place a <script> tag on the page to load the JavaScript file from our CDN.
  2. You add a <div> where you want the widget to appear.
  3. The script automatically initialises the widget within the specified element.

Environment ​

  • Acceptance environment: for testing and development only.
  • CDN URL: https://cdn.rumbledirect.dev/repair/widget-v3/latest/index.js

We will provide the required configuration details: clientIdentifier, formId and, optionally, themeId. Use credentials and configuration for the acceptance environment.

Integrating into your page ​

1. Add the script ​

Place the following <script> tag just before the closing </body> tag of your HTML:

html
<script
  src="https://cdn.rumbledirect.dev/repair/widget-v3/latest/index.js"
  defer
></script>

2. Add the widget container ​

Where you want the widget to appear, add the following <div> element:

html
<div
  id="rumbledirect-widget"
  data-client-identifier="YOUR_CLIENT_IDENTIFIER"
  data-form-id="YOUR_FORM_ID"
  data-theme-id="YOUR_THEME_ID"
></div>

Replace the example values with the details we send you. The id must always be rumbledirect-widget. data-theme-id is optional; without it the widget uses the theme linked to the form.

Supported attributes ​

AttributeUsage
data-client-identifierCredentials provided by us. Use this attribute or the two separate attributes below.
data-client-idClient ID, only together with data-client-secret as an alternative to data-client-identifier.
data-client-secretClient secret, only together with data-client-id.
data-form-idRequired: the form to display.
data-theme-idOptional: the theme to apply.

data-view-configuration-id, prefilling via data-prefill-data and the other v2 attributes, including data-service-partner-id, data-service-partner-collection-id and data-source, are not supported yet. Do not add data-view-configuration-id: it prevents the widget from loading, even when data-form-id is set.

Appearance and themes ​

Widget v3 always renders inside a Shadow DOM. Your website's CSS does not leak into the widget; there is no need to set data-display-mode. This attribute is not supported.

The widget inherits your website's font unless the selected theme specifies one. It follows the visitor's dark-mode preference only when the theme includes a dark palette. Otherwise, it keeps using the light palette.

Use data-theme-id with either a v3 theme ("version": 3) or an existing SurveyJS theme. Existing SurveyJS themes supply the primary colour and corner radius.

Ready to test? ​

Check your integration on a test page using the acceptance environment. Keep in mind that this preview does not support all v2 features yet.

Got questions or ran into issues? Email us at [email protected].