`.
*
* Note: if this prop is provided, all of the `HTMLAttributes` props will be
* ignored as well as the `clone` and `wrapOnly` props.
*
* @remarks \@since 2.3.0
*/
cloneStyles?: boolean;
/**
* Boolean if the `children` should be updated to be wrapped in the `GridCell`
* component and clone the `className` into each child automatically. This is
* really just a convenience prop so you don't always need to import both the
* `Grid` and `GridCell` components to create a grid.
*/
clone?: boolean;
/**
* Boolean if the `children` should be updated to be wrapped in the `GridCell`
* component. This is really just a convenience prop so you don't always need
* to import both the `Grid` and `GridCell` components to create a grid/
*/
wrapOnly?: boolean;
/**
* This prop allows you to generate your grid with a dynamic amount of columns
* instead of a static size. This will update the grid to ignore all the
* `columns` props and update the grid to show as many columns as possible by
* updating the `grid-template-columns` style to be:
*
* ```scss
* grid-template-columns: repeat(auto-fill, minmax($min-cell-width, 1fr));
* ```
*
* This **needs to be a number with a unit**. Check out the documentation on
* the `minmax` css function for some more info.
*
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/minmax
*/
minCellWidth?: "min-content" | "max-content" | "auto" | string;
/**
* An optional number of columns to apply for all media types. Providing one
* of the media-specific column props will override this value for those
* breakpoints still.
*/
columns?: number;
/**
* An optional number of columns to display for phones.
*/
phoneColumns?: number;
/**
* An optional number of columns to display for tablets.
*/
tabletColumns?: number;
/**
* An optional number of columns to display for desktop screens.
*/
desktopColumns?: number;
/**
* An optional number of columns to display for large desktop screens.
*/
largeDesktopColumns?: number;
/**
* This is really just a pass-through of the `style` prop that allows you to
* quickly update the base padding for the grid.
*/
padding?: number | string;
/**
* This will override the default grid cell's gutter value (the space between
* each cell). This **needs to be a number with a unit** since it is set to a
* css variable. Examples:
*
* - `1rem`
* - `16px`
* - `1em`
* - `5%`
*/
gutter?: string;
}
type CSSProperties = React.CSSProperties & {
[GRID_GUTTER_VAR]?: string;
[GRID_COLUMNS_VAR]?: number;
};
const block = bem("rmd-grid");
/**
* The grid component is generally used for a base layout in your app to provide
* nice padding and spacing between each item.
*
* Note: This component relies on the `AppSizeListener` as a parent component to
* work and will throw an error if it does not exist as a parent.
*/
export const Grid = forwardRef
(function Grid(
{
style,
className,
children,
clone = false,
cloneStyles = false,
wrapOnly = false,
columns,
phoneColumns,
tabletColumns,
desktopColumns,
largeDesktopColumns,
padding,
gutter,
minCellWidth,
...props
},
ref
) {
const { isPhone, isTablet, isDesktop, isLargeDesktop } = useAppSize();
const mergedStyle: CSSProperties = {
padding: (padding !== 0 && padding) || undefined,
gridTemplateColumns: minCellWidth
? `repeat(auto-fill, minmax(${minCellWidth}, 1fr))`
: undefined,
...style,
[GRID_COLUMNS_VAR]:
(isPhone && phoneColumns) ||
(isTablet && tabletColumns) ||
(isLargeDesktop && largeDesktopColumns) ||
(isDesktop && desktopColumns) ||
columns,
[GRID_GUTTER_VAR]: gutter,
};
const mergedClassName = cn(block({ "no-padding": padding === 0 }), className);
if (cloneStyles && isValidElement(children)) {
const child = Children.only(children);
return cloneElement(child, {
style: { ...mergedStyle, ...child.props.style },
className: cn(mergedClassName, child.props.className),
});
}
let content = children;
if (clone || wrapOnly) {
content = Children.map(
children,
(child) => child && {child}
);
}
return (
{content}
);
});