@empathyco/x-components
Version:
Empathy X Components
25 lines (16 loc) • 1.64 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XPluginOptions](./x-components.xpluginoptions.md)
## XPluginOptions interface
[XPlugin](./x-components.xplugin.md) Installation options.
**Signature:**
```typescript
export interface XPluginOptions
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_\_PRIVATE\_\_xModules?](./x-components.xpluginoptions.__private__xmodules.md) | | [PrivateXModulesOptions](./x-components.privatexmodulesoptions.md) | _(Optional)_ Override the [XModules](./x-components.xmodule.md) store module and store emitters. It must be used only in exceptional cases. |
| [adapter](./x-components.xpluginoptions.adapter.md) | | XComponentsAdapter | The adapter transforms the request for the the search and tagging APIs and its responses. |
| [initialXModules?](./x-components.xpluginoptions.initialxmodules.md) | | [AnyXModule](./x-components.anyxmodule.md)<!-- -->\[\] | _(Optional)_ A [XModules](./x-components.xmodule.md) to be registered during the [XPlugin](./x-components.xplugin.md) installation. |
| [store?](./x-components.xpluginoptions.store.md) | | Store<any> | _(Optional)_ A Vuex store to install the X module. If not passed a new one will be created and injected into every component. |
| [xModules?](./x-components.xpluginoptions.xmodules.md) | | [XModulesOptions](./x-components.xmodulesoptions.md) | _(Optional)_ Override the [XModules](./x-components.xmodule.md) config state and its wiring. |