@dutchfurniturefulfilment/skik-client/docs/api/static.md

Javascript package for integrating a SKIK configurator inside web projects.

## Creating a SKIKClient instance

```typescript
SKIKClient # create(options: SKIKClient.ConstructorOptions): SKIKClient.Client
```

Returns a new `SKIKClient.Client` instance from given options object.

### Constructor options:

| Property            | Type    | Required | Default | Description
|:------------------- |:------- |:-------- |:------- |:-----------
| `containerId`       | string  | yes      | N/A     | The ID attribute value of the DOM element in which to build the SKIK-Configurator i-frame.
| `apiKey`            | string  | yes      | N/A     | Your API key for the SKIK Configurator application
| `autoResizeFrame`   | boolean | no       | `true`  | Boolean indicating whether the i-frame should resize automatically. In most cases this is desired, to prevent double scrollbars in the browser window. Can be disabled if necessary.
| `configurationHash` | string  | no       | `null`  | Optionally provide a SKIK-Configuration hash that should be used to boot the configurator with. The configuration that's represented by the hash will be shown initially. If no hash is given, a default configuration will be shown.
| `locale`            | string  | no       | `"nl"`  | Optionally define a language for the configurator to run in.
| `showLocaleSwitch`  | boolean | no       | `true`  | Optional boolean indicating whether or not to display a locale / language switch within the configurator header.