@empathyco/x-components
Version:
Empathy X Components
51 lines (45 loc) • 1.98 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseGrid](./x-components.basegrid.md)
Grid component that is able to render different items based on their modelName value. In order to achieve this, it exposes a scopedSlot for each different modelName. In case the items used do not have modelName property, the default slot is used instead. It has a required property: the `items` to render; and an optional one: the number `columns` the grid is divided in. If the number of columns is not specified, the grid automatically fills the rows with as many columns as it can fit.
**Signature:**
```typescript
_default: import("vue").DefineComponent<{
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
columns: {
type: NumberConstructor;
default: number;
};
items: {
type: PropType<ListItem[]>;
};
}, {
gridItems: import("vue").ComputedRef<GridItem[]>;
cssClasses: import("vue").ComputedRef<string>;
style: import("vue").ComputedRef<Partial<CSSStyleDeclaration>>;
gridEl: Ref<{
$el: HTMLElement;
} | HTMLElement | undefined>;
slots: Readonly<{
[]: import("vue").Slot<any> | undefined;
}>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
columns: {
type: NumberConstructor;
default: number;
};
items: {
type: PropType<ListItem[]>;
};
}>>, {
animation: string | Function | Record<string, any>;
columns: number;
}, {}>
```