UNPKG

@dutchfurniturefulfilment/skik-client

Version:

Javascript package for integrating a SKIK configurator inside web projects.

32 lines (16 loc) • 1.6 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# SKIK Client / Data interfaces / Event channels These are the event channels that can be subscribed to with the [`Client # on()`](../api/client#listening-for-events) instance method. ## `"child-document-height-changed"` **Payload type:** `number` Event fired when the height of the SKIK Configurator document changed. The new height in pixels is the event's payload. This event is mostly relevant for custom i-frame size management. _The SKIK client instance will listen to this event internally if the option `autoResizeFrame` is set to `true`._ ## `"frame-height-set"` **Payload type:** `number` Event fired when the height of the i-frame was explicitly set by the SKIK Client instance. The new height of the frame is the event's payload. This event can be helpful if you require dynamic sizing / positioning of elements on your page that depend on the size of the iframe. ## `"price-changed"` **Payload type:** [`SKIKClient.PriceMutationReport`](prices#pricemutationreport) Event fired when the price of the active configuration changed. A price-mutation report object is the event's payload. This event can be used to display the price of the currently active closet configuration. **Note:** Events of type `"price-changed"` will only be dispatched once prices of all relevant products are provided. See the [Injecting product prices and displaying a total price](../examples/injecting-prices) guide for details. ## `"locale-changed"` **Payload type:** `string` Event fired when the display locale (language) changed in the configurator. Locale is always in **ISO 639-1** format.