npm package: @jambon-baguette/product-recs-interface
Description: @coveo/atomic component starter
Latest version: 0.0.3

# product-recs-interface



<!-- Auto Generated Below -->


## Properties

| Property                     | Attribute                       | Description                                                             | Type     | Default                                               |
| ---------------------------- | ------------------------------- | ----------------------------------------------------------------------- | -------- | ----------------------------------------------------- |
| `additionaFields`            | `additiona-fields`              | A list of non-default fields to include in the query results, an array. | `string` | `"ec_skus,ec_shortdesc,ec_brand"`                     |
| `defaultImage`               | `default-image`                 |                                                                         | `string` | `"https://logo.clearbit.com/www.wolseleyinc.ca?s=77"` |
| `imageSize`                  | `image-size`                    |                                                                         | `string` | `"small"`                                             |
| `isCarousel`                 | `is-carousel`                   |                                                                         | `string` | `"false"`                                             |
| `layout`                     | `layout`                        |                                                                         | `string` | `"summarized"`                                        |
| `maxNumberOfRecommendations` | `max-number-of-recommendations` | The maximum number of recommendation results to be returned             | `number` | `4`                                                   |
| `orientation`                | `orientation`                   |                                                                         | `string` | `"vertical"`                                          |
| `recTitle`                   | `rec-title`                     |                                                                         | `string` | `undefined`                                           |
| `recommendationType`         | `recommendation-type`           | Type of the recommendation list                                         | `string` | `""`                                                  |
| `searchHub`                  | `search-hub`                    | Searchhub value to initialize the engine                                | `string` | `undefined`                                           |
| `sku`                        | `sku`                           |                                                                         | `string` | `""`                                                  |


## Methods

### `initialize(options: InitializationOptions) => Promise<void>`



#### Returns

Type: `Promise<void>`




## Shadow Parts

| Part                | Description |
| ------------------- | ----------- |
| `"carousel-cell"`   |             |
| `"carousel-title"`  |             |
| `"child"`           |             |
| `"clickable-link"`  |             |
| `"container"`       |             |
| `"description"`     |             |
| `"image"`           |             |
| `"image-container"` |             |
| `"rec-title"`       |             |
| `"recommendations"` |             |
| `"title"`           |             |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*