@empathyco/x-components
Version:
Empathy X Components
60 lines (54 loc) • 2 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseSuggestions](./x-components.basesuggestions.md)
## BaseSuggestions variable
Paints a list of suggestions passed in by prop. Requires a component for a single suggestion in the default slot for working.
**Signature:**
```typescript
_default: import("vue").DefineComponent<{
suggestions: {
type: PropType<Suggestion[]>;
required: true;
};
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
maxItemsToRender: NumberConstructor;
showFacets: {
type: BooleanConstructor;
default: boolean;
};
showPlainSuggestion: {
type: BooleanConstructor;
default: boolean;
};
suggestionItemClass: StringConstructor;
}, {
suggestionsToRender: import("vue").ComputedRef<Suggestion[]>;
suggestionsKeys: import("vue").ComputedRef<string[]>;
getSuggestionFilter: (suggestion: Suggestion) => import("@empathyco/x-types").Filter | undefined;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
suggestions: {
type: PropType<Suggestion[]>;
required: true;
};
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
maxItemsToRender: NumberConstructor;
showFacets: {
type: BooleanConstructor;
default: boolean;
};
showPlainSuggestion: {
type: BooleanConstructor;
default: boolean;
};
suggestionItemClass: StringConstructor;
}>>, {
animation: string | Function | Record<string, any>;
showFacets: boolean;
showPlainSuggestion: boolean;
}, {}>
```