@empathyco/x-components
Version:
Empathy X Components
62 lines (55 loc) • 1.92 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseSuggestion](./x-components.basesuggestion.md)
## BaseSuggestion variable
Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvent](./x-components.xevent.md) that will be emitted on click with a given feature.
The default slot receives the suggestion and the matched query has props.
**Signature:**
```typescript
_default: import("vue").DefineComponent<{
query: {
type: StringConstructor;
default: string;
};
suggestion: {
type: PropType<Suggestion>;
required: true;
};
feature: {
type: PropType<QueryFeature>;
};
suggestionSelectedEvents: {
type: PropType<Partial<XEventsTypes>>;
required: true;
};
highlightCurated: {
type: BooleanConstructor;
};
}, {
el: import("vue").Ref<HTMLElement | null>;
filter: import("vue").ComputedRef<BooleanFilter | undefined>;
emitEvents: () => void;
dynamicCSSClasses: import("vue").ComputedRef<VueCSSClasses>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
query: {
type: StringConstructor;
default: string;
};
suggestion: {
type: PropType<Suggestion>;
required: true;
};
feature: {
type: PropType<QueryFeature>;
};
suggestionSelectedEvents: {
type: PropType<Partial<XEventsTypes>>;
required: true;
};
highlightCurated: {
type: BooleanConstructor;
};
}>>, {
query: string;
highlightCurated: boolean;
}, {}>
```