@empathyco/x-components
Version:
Empathy X Components
75 lines • 2.8 kB
TypeScript
import type { PropType, Ref } from 'vue';
import type { ListItem } from '../utils/types';
import type { GridItem } from './base-grid.types';
/**
* 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.
*
* @public
*/
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/** Animation component that will be used to animate the base grid. */
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
/**
* Number of columns the grid is divided into. By default, its value is 0, setting the grid
* columns mode to auto-fill.
*/
columns: {
type: NumberConstructor;
default: number;
};
/**
* The list of items to be rendered.
*
* @remarks The items must have an ID property.
*/
items: {
type: PropType<ListItem[]>;
};
}>, {
gridItems: import("vue").ComputedRef<GridItem[]>;
cssClasses: import("vue").ComputedRef<string>;
style: import("vue").ComputedRef<Partial<CSSStyleDeclaration>>;
gridEl: Ref<HTMLElement | {
$el: HTMLElement;
} | undefined, HTMLElement | {
$el: HTMLElement;
} | undefined>;
slots: Readonly<{
[name: string]: import("vue").Slot<any> | undefined;
}>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/** Animation component that will be used to animate the base grid. */
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: string;
};
/**
* Number of columns the grid is divided into. By default, its value is 0, setting the grid
* columns mode to auto-fill.
*/
columns: {
type: NumberConstructor;
default: number;
};
/**
* The list of items to be rendered.
*
* @remarks The items must have an ID property.
*/
items: {
type: PropType<ListItem[]>;
};
}>> & Readonly<{}>, {
animation: string | Function | Record<string, any>;
columns: number;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;
//# sourceMappingURL=base-grid.vue?vue&type=script&lang.d.ts.map