​
Step 1: Import Explo JS library

Add Explo’s script tag to the <head> of your index.html

index.html
<script src="https://embed.explo.co/bundle.js"></script>

​
Step 2. Embed the web component

​
What is the web component?

The Explo web component is a custom HTML element. This means that it functions as a native HTML element and can be used in any web development context. You can read more about custom HTML elements here.

​
Where can I use the component?

Since the web component is a custom HTML element, you can use it in any context:

  • Directly in an HTML file

  • Define it in vanilla JS

  • Any JS web framework: React, Vue, Angular, etc

​
Embedding the component

The embed component takes in a few different properties. The component is backward-compatible with the previous V1 syntax and V0 syntax, but we recommend using the V2 (embed secret) syntax. Read more about embed secrets here.

Please also note these instructions when embedding a report builder.

​
Component Attributes

Attribute NameTypeDescription
jwt (recommended)stringThis is the embed secret (JWT) for the report builder. We recommend you use this attribute instead of the report-builder-token. Read more about embed secrets here.
report-builder-tokenstringThis is a string with two values concatenated together: (1) the report_builder_id and (2) the customer_token. You should concatenate them with a colon between them like so: "<report_builder_id>:<customer_token>". We recommend you use the jwt instead of this attribute, but it is still supported.
environmentstringThis lets you specify the environment version that the web component is being embedded in: “production”, “staging”, “development”, etc. If environment is not specified, it will render the most recent saved version of the report builder.
variablesstringThis argument allows you to pass in values for variables on your report builder. This will result in default values for any variables and UI dropdowns on the report builder. Note that you must pass in a stringified JSON object using JSON.stringify(variablesObject)
locale-codestringAn optional argument that overrides any text localization settings for your team. This will localize your report builder’s numbers and dates to the desired locale, if supported.
currency-codestringAn optional argument that overrides any currency localization settings for your team. This will localize your report builder’s currency symbols and format to the desired locale, if supported.
timezonestringAn optional argument that allows you to specify a timezone to display dates in. Valid values can be found here.
themestringAn optional argument that lets you manage multiple style/theme profiles within Explo. If not provided, uses the “default” theme.

​
Typescript Type Definition

If you are using TypeScript, define the embedded component within the global namespace. This needs to be defined at the top of each TypeScript file that uses the explo-report-builder component. You may need to exclude this block from your lint rules (e.g. @typescript-eslint/no-namespace)

declare global {
    namespace JSX {
        interface IntrinsicElements {
            'explo-report-builder': unknown;
        }
    }
}
Option 3: Customer PortalOption 2: iFrame