flex-area-grid
Version:
25 lines (24 loc) • 1.04 kB
TypeScript
import { FunctionComponentElement } from "react";
import { TFlexGridItem } from "./FlexGridItem";
export declare type TMatrix = {
rows: number;
columns: number;
itemIndex: number;
} | null | undefined;
/**
* Generates a grid matrix.
* @param {number} initialColumns - The number of grid columns.
* @param {FunctionComponentElement<TFlexGridItem>[]} children - A grid items.
* @return {TMatrix[][]} - Returns a grid matrix using for draw an a grid.
*/
declare function generateMatrix(initialColumns: number, children: FunctionComponentElement<TFlexGridItem>[]): TMatrix[][];
/**
* Check is grid item has an area properties.
* @param startRow - A start row position.
* @param startColumn - A start column position.
* @param endRow - An end row position.
* @param endColumn - An end column position.
* @return {boolean} - Returns boolean flag.
*/
declare function hasArea(startRow?: number, startColumn?: number, endRow?: number, endColumn?: number): boolean;
export { generateMatrix, hasArea };