@empathyco/x-components
Version:
Empathy X Components
33 lines (24 loc) • 2.46 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [SnippetConfig](./x-components.snippetconfig.md)
## SnippetConfig interface
Interface with the possible parameters to receive through the snippet integration.
**Signature:**
```typescript
export interface SnippetConfig
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [callbacks?](./x-components.snippetconfig.callbacks.md) | | [XEventListeners](./x-components.xeventlisteners.md) | _(Optional)_ Callbacks to be triggered when an XEvent is emitted. |
| [consent?](./x-components.snippetconfig.consent.md) | | boolean | _(Optional)_ User GDPR consent. |
| [currency?](./x-components.snippetconfig.currency.md) | | string | _(Optional)_ The currency name. There should be a currency format associated to this name in the app. |
| [documentDirection?](./x-components.snippetconfig.documentdirection.md) | | [DocumentDirection](./x-components.documentdirection.md) | _(Optional)_ Document direction. |
| [env?](./x-components.snippetconfig.env.md) | | 'staging' | _(Optional)_ Backend services environment. |
| [filters?](./x-components.snippetconfig.filters.md) | | string\[\] | _(Optional)_ The filters to be applied on the first request. |
| [instance](./x-components.snippetconfig.instance.md) | | string | Customer instance. |
| [isSpa?](./x-components.snippetconfig.isspa.md) | | boolean | _(Optional)_ Flag determining if the page is a single page application or not. |
| [lang](./x-components.snippetconfig.lang.md) | | string | Language for the API request, and default value for [SnippetConfig.uiLang](./x-components.snippetconfig.uilang.md)<!-- -->. |
| [productId?](./x-components.snippetconfig.productid.md) | | string | _(Optional)_ The id for the current product when product page is loaded. |
| [queriesPreview?](./x-components.snippetconfig.queriespreview.md) | | [QueryPreviewInfo](./x-components.querypreviewinfo.md)<!-- -->\[\] | _(Optional)_ List of queries to preview. |
| [scope](./x-components.snippetconfig.scope.md) | | string | Execution scope (desktop, mobile, app, ...). |
| [uiLang?](./x-components.snippetconfig.uilang.md) | | string | _(Optional)_ Language to use for the messages. Defaults to [SnippetConfig.lang](./x-components.snippetconfig.lang.md)<!-- -->. |