@empathyco/x-components
Version:
Empathy X Components
135 lines (59 loc) • 2.06 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
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[\_\_PRIVATE\_\_xModules?](./x-components.xpluginoptions.__private__xmodules.md)
</td><td>
</td><td>
[PrivateXModulesOptions](./x-components.privatexmodulesoptions.md)
</td><td>
_(Optional)_ Override the [XModules](./x-components.xmodule.md) store module and store emitters. It must be used only in exceptional cases.
</td></tr>
<tr><td>
[adapter](./x-components.xpluginoptions.adapter.md)
</td><td>
</td><td>
XComponentsAdapter
</td><td>
The adapter transforms the request for the the search and tagging APIs and its responses.
</td></tr>
<tr><td>
[initialXModules?](./x-components.xpluginoptions.initialxmodules.md)
</td><td>
</td><td>
[AnyXModule](./x-components.anyxmodule.md)<!-- -->\[\]
</td><td>
_(Optional)_ A [XModules](./x-components.xmodule.md) to be registered during the [XPlugin](./x-components.xplugin.md) installation.
</td></tr>
<tr><td>
[store?](./x-components.xpluginoptions.store.md)
</td><td>
</td><td>
Store<any>
</td><td>
_(Optional)_ A Vuex store to install the X module. If not passed a new one will be created and injected into every component.
</td></tr>
<tr><td>
[xModules?](./x-components.xpluginoptions.xmodules.md)
</td><td>
</td><td>
[XModulesOptions](./x-components.xmodulesoptions.md)
</td><td>
_(Optional)_ Override the [XModules](./x-components.xmodule.md) config state and its wiring.
</td></tr>
</tbody></table>