<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XEventsTypes](./x-components.xeventstypes.md) &gt; [UserClickedOpenModal](./x-components.xeventstypes.userclickedopenmodal.md)

## XEventsTypes.UserClickedOpenModal property

The user clicked the button to open a modal. Payload: the id of the modal to open.

**Signature:**

```typescript
UserClickedOpenModal: string;
```