<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InstallXOptions](./x-components.installxoptions.md)

## InstallXOptions interface

Interface for the parameter of the constructor of [XInstaller](./x-components.xinstaller.md) function. It is an extended version of [XPluginOptions](./x-components.xpluginoptions.md)<!-- -->.

**Signature:**

```typescript
export interface InstallXOptions<API extends XAPI = XAPI> extends XPluginOptions 
```
**Extends:** [XPluginOptions](./x-components.xpluginoptions.md)

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [api?](./x-components.installxoptions.api.md) |  | API \| false | _(Optional)_ The API to expose globally. If is not passed the default [BaseXAPI](./x-components.basexapi.md) will be used. If a <code>false</code> value is passed then the API is not created. |
|  [bus?](./x-components.installxoptions.bus.md) |  | XBus&lt;[XEventsTypes](./x-components.xeventstypes.md)<!-- -->, [WireMetadata](./x-components.wiremetadata.md)<!-- -->&gt; | _(Optional)_ The  used in the [XPlugin](./x-components.xplugin.md)<!-- -->. If not passed an instance of The  will be used. |
|  [domElement?](./x-components.installxoptions.domelement.md) |  | Element \| ShadowRoot \| string \| ((snippetConfig: [NormalisedSnippetConfig](./x-components.normalisedsnippetconfig.md)<!-- -->) =&gt; Element \| ShadowRoot \| string) | _(Optional)_ An Element \| string \| function to indicate the HTML element that will contain the Vue application. If it isn't passed, the [XInstaller](./x-components.xinstaller.md) will create the target element. |
|  [onCreateApp?](./x-components.installxoptions.oncreateapp.md) |  | (app: App) =&gt; void | _(Optional)_ Callback to invoke after instantiating the app. |
|  [plugin?](./x-components.installxoptions.plugin.md) |  | Plugin&lt;[XPluginOptions](./x-components.xpluginoptions.md)<!-- -->&gt; | _(Optional)_ The XPlugin which will be installed. If not passed, an instance of [XPlugin](./x-components.xplugin.md) will be installed. |
|  [rootComponent?](./x-components.installxoptions.rootcomponent.md) |  | Component | _(Optional)_ The Vue component used as root of the application. If it is not passed, no Vue Application is initialized, only plugin installed. |

## Methods

|  Method | Description |
|  --- | --- |
|  [installExtraPlugins(options)?](./x-components.installxoptions.installextraplugins.md) | _(Optional)_ Adds the option to install more Vue plugins, giving access to the [SnippetConfig](./x-components.snippetconfig.md) and the . |