> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/xcover-elements/client-integration/element-signals/listen-signal.md).

# Listen signal

## Using `listen` signal

To determine when the user has selected an option for coverage you need to use the `listen` signal passing an `onChange` property that takes a function to handle the change event.

{% hint style="info" %}
This is similar to `addEventListener()` difference being we are using XCE Signals instead.
{% endhint %}

Call `signalLayer.push()` with `listen` as the value for the `signal` property and add `onChange` as in the following example:

```javascript
/* protection-offer example */
window.signalLayer.push({
  signal: "listen",
  element: "xce-protection-offer",
  onChange: (args) => {
    if(args.selectedOption !== "reject"){
      //Customer has selected a policy
      //List of selected policies available in args.selectedPolicies
    } else {
      //Customer has said no to a policy
    }
  },
});
```

### selectedOption

The `selectedOption` property is a `string` value returned in the callback arguments object will match the radio input value attribute that the customer selected.

The input value attribute varies depending on your integration.

* For option 'YES' the radio input value and the `selectedOption` property equals the option displayed to the user as in: `option-1`.
* For option 'NO' the radio input value and the `selectedOption` property equals `reject`.

When more than one product is displayed, the value will increase its last digit accordignly: `option-1` , `option-2` , etc.

{% hint style="info" %}
The 'NO' option of the panel will always match `reject`
{% endhint %}

### selectedProductIDs

The `selectedProductIDs` property is an array of strings returned in the callback arguments object that can have the selected products metadata.

* For option 'YES' the selected product ids will be appended to the `selectedProductIDs` array with the ones they wish to book.
* For option 'NO' the `selectedProductIDs` array will return empty.

Use the `selectedProductIDs` values to filter the products before confirming the offer.

Example:

Access the `args` object in the `onChange` callback function to access the `selectedProductIDs` array as in the following example:

```javascript
/* multiple policy offer example */
window.signalLayer.push({
  signal: "listen",
  element: "xce-protection-offer",
  onChange: (args) => {
    if (args.selectedProductIDs?.length) {
      // your data filtering logic here..
    }
    // your enable checkout logic here..
  },
});
```

### Modal element

When working with our modal element the `onSubmit` property will be expected as part of the object pushed to the signal layer array.

This handler function will be triggered every time the modal element is closed by the user and will return the same arguments object including `selectedOption`.

```javascript
/* protection-offer-modal example */
window.signalLayer.push({
  signal: "listen",
  element: "xce-protection-offer-modal",
  onChange: (args) => { // onChange runs on every input option change event
    if(args.selectedOption !== "reject"){
      //Customer has selected a product
      //List of selected products available in args.selectedProductIDs
    }
    // your enable checkout logic here..
  },
  onSubmit: (args) => { // onSubmit runs on modal close event
    if(args.selectedOption !== "reject"){
      //Customer has selected a product
      //List of selected products available in args.selectedProductIDs
    }
    // your enable checkout logic here..
  },
});
```

From here, you can perform whatever add-to-cart functionality is required and unblock the checkout journey that was preventing them from continuing until they selected an option.

{% hint style="warning" %}
The `onChange` and `onSubmit` handler function arguments will not include the native HTML Event object
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://partner-docs.covergenius.com/xcover-elements/client-integration/element-signals/listen-signal.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.