UNPKG

9.46 kBTypeScriptView Raw
1import * as React from 'react';
2export interface FlexProps extends React.HTMLProps<HTMLDivElement> {
3 /** content rendered inside the Flex layout */
4 children?: React.ReactNode;
5 /** additional classes added to the Flex layout */
6 className?: string;
7 /** Spacers at various breakpoints */
8 spacer?: {
9 default?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
10 sm?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
11 md?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
12 lg?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
13 xl?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
14 '2xl'?: 'spacerNone' | 'spacerXs' | 'spacerSm' | 'spacerMd' | 'spacerLg' | 'spacerXl' | 'spacer2xl' | 'spacer3xl' | 'spacer4xl';
15 };
16 /** Space items at various breakpoints */
17 spaceItems?: {
18 default?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
19 sm?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
20 md?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
21 lg?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
22 xl?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
23 '2xl'?: 'spaceItemsNone' | 'spaceItemsXs' | 'spaceItemsSm' | 'spaceItemsMd' | 'spaceItemsLg' | 'spaceItemsXl' | 'spaceItems2xl' | 'spaceItems3xl' | 'spaceItems4xl';
24 };
25 /** Whether to add flex: grow at various breakpoints */
26 grow?: {
27 default?: 'grow';
28 sm?: 'grow';
29 md?: 'grow';
30 lg?: 'grow';
31 xl?: 'grow';
32 '2xl'?: 'grow';
33 };
34 /** Whether to add flex: shrink at various breakpoints */
35 shrink?: {
36 default?: 'shrink';
37 sm?: 'shrink';
38 md?: 'shrink';
39 lg?: 'shrink';
40 xl?: 'shrink';
41 '2xl'?: 'shrink';
42 };
43 /** Value to add for flex property at various breakpoints */
44 flex?: {
45 default?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
46 sm?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
47 md?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
48 lg?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
49 xl?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
50 '2xl'?: 'flexDefault' | 'flexNone' | 'flex_1' | 'flex_2' | 'flex_3' | 'flex_4';
51 };
52 /** Value to add for flex-direction property at various breakpoints */
53 direction?: {
54 default?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
55 sm?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
56 md?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
57 lg?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
58 xl?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
59 '2xl'?: 'column' | 'columnReverse' | 'row' | 'rowReverse';
60 };
61 /** Value to add for align-items property at various breakpoints */
62 alignItems?: {
63 default?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
64 sm?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
65 md?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
66 lg?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
67 xl?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
68 '2xl'?: 'alignItemsFlexStart' | 'alignItemsFlexEnd' | 'alignItemsCenter' | 'alignItemsStretch' | 'alignItemsBaseline';
69 };
70 /** Value to add for align-content property at various breakpoints */
71 alignContent?: {
72 default?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
73 sm?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
74 md?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
75 lg?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
76 xl?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
77 '2xl'?: 'alignContentFlexStart' | 'alignContentFlexEnd' | 'alignContentCenter' | 'alignContentStretch' | 'alignContentSpaceBetween' | 'alignContentSpaceAround';
78 };
79 /** Value to add for align-self property at various breakpoints */
80 alignSelf?: {
81 default?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
82 sm?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
83 md?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
84 lg?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
85 xl?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
86 '2xl'?: 'alignSelfFlexStart' | 'alignSelfFlexEnd' | 'alignSelfCenter' | 'alignSelfStretch' | 'alignSelfBaseline';
87 };
88 /** Value to use for margin: auto at various breakpoints */
89 align?: {
90 default?: 'alignLeft' | 'alignRight';
91 sm?: 'alignLeft' | 'alignRight';
92 md?: 'alignLeft' | 'alignRight';
93 lg?: 'alignLeft' | 'alignRight';
94 xl?: 'alignLeft' | 'alignRight';
95 '2xl'?: 'alignLeft' | 'alignRight';
96 };
97 /** Value to add for justify-content property at various breakpoints */
98 justifyContent?: {
99 default?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
100 sm?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
101 md?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
102 lg?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
103 xl?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
104 '2xl'?: 'justifyContentFlexStart' | 'justifyContentFlexEnd' | 'justifyContentCenter' | 'justifyContentSpaceBetween' | 'justifyContentSpaceAround' | 'justifyContentSpaceEvenly';
105 };
106 /** Value to set to display property at various breakpoints */
107 display?: {
108 default?: 'inlineFlex';
109 sm?: 'flex' | 'inlineFlex';
110 md?: 'flex' | 'inlineFlex';
111 lg?: 'flex' | 'inlineFlex';
112 xl?: 'flex' | 'inlineFlex';
113 '2xl'?: 'flex' | 'inlineFlex';
114 };
115 /** Whether to set width: 100% at various breakpoints */
116 fullWidth?: {
117 default?: 'fullWidth';
118 sm?: 'fullWidth';
119 md?: 'fullWidth';
120 lg?: 'fullWidth';
121 xl?: 'fullWidth';
122 '2xl'?: 'fullWidth';
123 };
124 /** Value to set for flex-wrap property at various breakpoints */
125 flexWrap?: {
126 default?: 'wrap' | 'wrapReverse' | 'nowrap';
127 sm?: 'wrap' | 'wrapReverse' | 'nowrap';
128 md?: 'wrap' | 'wrapReverse' | 'nowrap';
129 lg?: 'wrap' | 'wrapReverse' | 'nowrap';
130 xl?: 'wrap' | 'wrapReverse' | 'nowrap';
131 '2xl'?: 'wrap' | 'wrapReverse' | 'nowrap';
132 };
133 /** Modifies the flex layout element order property */
134 order?: {
135 default?: string;
136 md?: string;
137 lg?: string;
138 xl?: string;
139 '2xl'?: string;
140 };
141 /** Sets the base component to render. defaults to div */
142 component?: React.ElementType<any> | React.ComponentType<any>;
143}
144export declare const Flex: React.FunctionComponent<FlexProps>;
145//# sourceMappingURL=Flex.d.ts.map
\No newline at end of file