Attributes
The web component allows certain controls over the behaviour using HTML attributes. Here is a list of the available attributes for your convenience.
Name: experience-id
Type: string
Default: ""
The experience that you desire to load in this instance of the solution. This will mostly be an ID provided by epigraph that corresponds to a specific experience.
Name: disable-default-ui
Type: boolean
Default: false
Allows the developers to completely disable our internal UI that the solution ships with and built an entirely custom UI around it.
Name: shared-config-id
Type: string
Default: ""
Allows the developers to load a shared scene state as default. This could be convenient when you wish to load the scene in a desired state, other that what it loads as by default.
Name: ga-code
Type: string
Default: ""
The ga-code or ga-measurement-if (for ga4 and above) that would be used internally to send Analytics event to on Google analytics.
Name: consent-plugin
Type: string | null
Default: null
In cases where you use consent plugins like "onetrust", this is the attribute you would be letting the solution know to utilize the consent from that plugin as well. Supported plugins:
- onetrust
Name: consent-identifier
Type: string | null
Default: null
Identifier for the consent plugin specified above. This is what helps us target specific consents.
Name: custom-version-id
Type: string
Default: ""
INTERNAL USE ONLY This attribute is mostly for internal use only unless specified otherwise in cases where we need to test a version with changes but not necessarily want to push them live just yet. This could be very useful to test out the changes in a non destructive manner.
Name: disable-camera-auto-focus
Type: boolean
Default: false
By default the solution focuses on the product-class or product or variant that you switch to. But in some cases, it might be desired to not have that behavior by default and set your own camera angles while doing a Custom implementation. This flag will disable all camera auto resolutions within and give you the creative freedom for camera controls using the process described here: https://docs.myepigraph.com/update/docs/camera-manipulations#/
Name: viewport-size-modals
Type: boolean
Default: false
By default all modals within the solution take up the width and height from the parent element but if you would like to override this behavior and take up the entire screen, adding this attribute would allow you to do that.
Updated 5 months ago