Option 1: Web Component
Step 1: Import Explo JS library
Add Explo’s script tag to the <head> of your 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 V0 syntax, but it would be a good idea to start to implement the V1 syntax.
<explo-dashboard
dash-customer-token="<dashboard_id>:<customer_token>"
updateUrlParams={true}
isProduction={true}
environment="prod"
refresh-minutes={10}
variables={JSON.stringify({ element1: 'value', element2: 'value2' })}
locale-code="fr-fr">
</explo-dashboard>
Component Attributes (V1)
| Attribute Name | Type | Description |
|---|---|---|
| dash-customer-token | string | This is a string with two values concatenated together: (1) the dashboard_id and (2) the customer_token. You should concatenate them with a colon between them like so: "<dashboard_id>:<customer_token>" |
| updateUrlParams | boolean | This is true if not specified. When true, the page’s URL params will update when the dashboard’s interaction inputs (dropdown, multi-select, etc) change so direct links will have the inputs configured. |
| isProduction | boolean | This indicates if the web component is being embedded in a staging or production environment. This helps us track the usage of the component so we can share more accurate usage statistics with you. |
| environment | string | This 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 dashboard. |
| refresh-minutes | number | An optional argument that allows you to tell the dashboard to automatically refresh on a cadence. |
| variables | string | This argument allows you to pass in values for variables on your dashboard. This will result in default values for any variables and UI dropdowns on the dashboard. Note that you must pass in a stringified JSON object using JSON.stringify(variablesObject) |
| locale-code | string | An optional argument that overrides any text localization settings for your team. This will localize your dashboard’s numbers and dates to the desired locale, if supported. |
| currency-code | string | An optional argument that overrides any currency localization settings for your team. This will localize your dashboard’s currency symbols and format to the desired locale, if supported. |
| analytics-properties | string | This argument allows you to pass in properties that will be passed along with analytics events. Note that you must pass in a stringified JSON object using JSON.stringify(propertiesObject) |
| timezone | string | An optional argument that allows you to specify a timezone to display dates in. Valid values can be found here. |
| disable-editable-section-editing | boolean | An optional argument that disables your user from editing the editable section at the bottom of the dashboard if enabled. |
| hide-editable-section | boolean | An optional argument that hides the editable section if enabled. |
| theme | string | This is the name of the theme you created in the custom styles tab |
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-dashboard 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-dashboard': unknown;
}
}
}
Hide Elements
You can hide elements on your dashboard by passing a hide parameter into the variables of your embed like so:
variables={JSON.stringify({ "element_name.hide": "true"})}>