@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
56 lines • 2.99 kB
TypeScript
/// <reference types="react" />
export type gridSpans = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
export interface GridItemProps extends React.HTMLProps<HTMLDivElement> {
/** content rendered inside the Grid Layout Item */
children?: React.ReactNode;
/** additional classes added to the Grid Layout Item */
className?: string;
/** the number of columns the grid item spans. Value should be a number 1-12 */
span?: gridSpans;
/** the number of rows the grid item spans. Value should be a number 1-12 */
rowSpan?: gridSpans;
/** the number of columns a grid item is offset */
offset?: gridSpans;
/** the number of columns the grid item spans on small device. Value should be a number 1-12 */
sm?: gridSpans;
/** the number of rows the grid item spans on medium device. Value should be a number 1-12 */
smRowSpan?: gridSpans;
/** the number of columns the grid item is offset on small device. Value should be a number 1-12 */
smOffset?: gridSpans;
/** the number of columns the grid item spans on medium device. Value should be a number 1-12 */
md?: gridSpans;
/** the number of rows the grid item spans on medium device. Value should be a number 1-12 */
mdRowSpan?: gridSpans;
/** the number of columns the grid item is offset on medium device. Value should be a number 1-12 */
mdOffset?: gridSpans;
/** the number of columns the grid item spans on large device. Value should be a number 1-12 */
lg?: gridSpans;
/** the number of rows the grid item spans on large device. Value should be a number 1-12 */
lgRowSpan?: gridSpans;
/** the number of columns the grid item is offset on large device. Value should be a number 1-12 */
lgOffset?: gridSpans;
/** the number of columns the grid item spans on xLarge device. Value should be a number 1-12 */
xl?: gridSpans;
/** the number of rows the grid item spans on large device. Value should be a number 1-12 */
xlRowSpan?: gridSpans;
/** the number of columns the grid item is offset on xLarge device. Value should be a number 1-12 */
xlOffset?: gridSpans;
/** the number of columns the grid item spans on 2xLarge device. Value should be a number 1-12 */
xl2?: gridSpans;
/** the number of rows the grid item spans on 2xLarge device. Value should be a number 1-12 */
xl2RowSpan?: gridSpans;
/** the number of columns the grid item is offset on 2xLarge device. Value should be a number 1-12 */
xl2Offset?: gridSpans;
/** Modifies the flex layout element order property */
order?: {
default?: string;
md?: string;
lg?: string;
xl?: string;
'2xl'?: string;
};
/** Sets the base component to render. defaults to div */
component?: React.ElementType<any> | React.ComponentType<any>;
}
export declare const GridItem: React.FunctionComponent<GridItemProps>;
//# sourceMappingURL=GridItem.d.ts.map