@empathyco/x-components
Version:
Empathy X Components
33 lines (27 loc) • 1.51 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseEventButton](./x-components.baseeventbutton.md)
## BaseEventButton variable
Component to be reused that renders a `<button>` with the logic of emitting events to the bus on click. The events are passed as an object to prop [XEvent](./x-components.xevent.md)<!-- -->. The keys are the event name and the values are the payload of each event. All events are emitted with its respective payload. If any event doesn't need payload a `undefined` must be passed as value.
**Signature:**
```typescript
_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
events: {
type: PropType<Partial<XEventsTypes>>;
required: true;
};
metadata: {
type: PropType<Omit<WireMetadata, "moduleName">>;
};
}>, {
emitEvents: () => void;
rootRef: import("vue").Ref<HTMLButtonElement | undefined, HTMLButtonElement | undefined>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
events: {
type: PropType<Partial<XEventsTypes>>;
required: true;
};
metadata: {
type: PropType<Omit<WireMetadata, "moduleName">>;
};
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
```