@bonprix-ds/react-grid 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,47 @@
1
+ import { FC } from 'react';
2
+ import { ReactNode } from 'react';
3
+
4
+ export declare type ColumnSpan = Span | 0;
5
+
6
+ declare const Grid: FC<GridProps> & {
7
+ Item: typeof GridItem;
8
+ };
9
+ export default Grid;
10
+
11
+ export declare const GridItem: FC<GridItemProps>;
12
+
13
+ export declare interface GridItemProps {
14
+ /** The content of the grid item. */
15
+ children?: ReactNode;
16
+ /** The number of columns the item should span. Can be used if the amount of columns is not changed between breakpoints. */
17
+ span?: Span;
18
+ /** The number of columns the item should span on the "s" breakpoint. */
19
+ s?: ColumnSpan;
20
+ /** The number of columns the item should span on the "m" breakpoint. */
21
+ m?: ColumnSpan;
22
+ /** The number of columns the item should span on the "l" breakpoint. */
23
+ l?: ColumnSpan;
24
+ /** The number of columns the item should span on the "xl" breakpoint. */
25
+ xl?: ColumnSpan;
26
+ /** The number of columns the item should span on the "xxl" breakpoint. */
27
+ xxl?: ColumnSpan;
28
+ /** The number of columns the item should span on the "xxxl" breakpoint. */
29
+ xxxl?: ColumnSpan;
30
+ /** Additional CSS classes to apply to the grid item. */
31
+ className?: string;
32
+ }
33
+
34
+ export declare interface GridProps {
35
+ /** A place where Grid.Item components should be added. */
36
+ children: ReactNode;
37
+ /** Classes for the Grid wrapper element. Intended mainly for customize gap size. */
38
+ className?: string;
39
+ /** If set to `true`, the grid will not have gutters between items.
40
+ * @deprecated Use `className="gap-x-0"` instead.
41
+ */
42
+ disableGutters?: boolean;
43
+ }
44
+
45
+ export declare type Span = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
46
+
47
+ export { }