Skip to content

Commit 40b33db

Browse files
kopaxkopax
authored
Merge pull request #38 from tim-stasse/dev
feat(typescript): added typescript definition
2 parents 273fb82 + cae228f commit 40b33db

File tree

1 file changed

+330
-0
lines changed

1 file changed

+330
-0
lines changed

‎src/index.d.ts

Lines changed: 330 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,330 @@
1+
declare module '@bootstrap-styled/css-utils' {
2+
import { unitUtils as unit } from '@bootstrap-styled/utils';
3+
export { unit };
4+
5+
export const alignUtils: {
6+
getAlignUtilities: () => string;
7+
alignBaseline: () => string;
8+
alignTop: () => string;
9+
alignMiddle: () => string;
10+
alignBottom: () => string;
11+
alignTextBottom: () => string;
12+
alignTextTop: () => string;
13+
};
14+
15+
export const backgroundUtils: {
16+
defaultProps: {
17+
'$enable-hover-media-query': boolean;
18+
'$brand-primary': string;
19+
'$brand-success': string;
20+
'$brand-info': string;
21+
'$brand-warning': string;
22+
'$brand-danger': string;
23+
'$brand-inverse': string;
24+
'$gray-lightest': string;
25+
};
26+
getBackgroundUtilities: (
27+
$enableHoverMediaQuery?: boolean,
28+
$brandPrimary?: string,
29+
$brandSuccess?: string,
30+
$brandInfo?: string,
31+
$brandWarning?: string,
32+
$brandDanger?: string,
33+
$brandInverse?: string,
34+
$grayLightest?: string
35+
) => string;
36+
bgFaded: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
37+
bgPrimary: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
38+
bgSuccess: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
39+
bgInfo: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
40+
bgWarning: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
41+
bgDanger: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
42+
bgInverse: (enableHoverMediaQuery: boolean, bgColor?: string) => string;
43+
};
44+
45+
export const bordersUtils: {
46+
defaultProps: {
47+
'$border-radius': string;
48+
'$enable-rounded': boolean;
49+
};
50+
getBordersUtilities: (enableRounded?: boolean, radius?: string) => string;
51+
rounded: (enableRounded?: boolean, radius?: string) => string;
52+
roundedTop: (enableRounded?: boolean, radius?: string) => string;
53+
roundedRight: (enableRounded?: boolean, radius?: string) => string;
54+
roundedBottom: (enableRounded?: boolean, radius?: string) => string;
55+
roundedLeft: (enableRounded?: boolean, radius?: string) => string;
56+
roundedCircle: () => string;
57+
};
58+
59+
export const clearfixUtils: {
60+
getClearfixUtilities: () => string;
61+
getClearfix: () => string;
62+
};
63+
64+
export const cursorUtils: {
65+
getCursorUtilities: () => string;
66+
};
67+
68+
export const displayUtils: {
69+
defaultProps: {
70+
'$grid-breakpoints': {
71+
xs: string;
72+
sm: string;
73+
md: string;
74+
lg: string;
75+
xl: string;
76+
};
77+
};
78+
getDisplayUtilities: (gridBreakpoints?: {
79+
xs?: string;
80+
sm?: string;
81+
md?: string;
82+
lg?: string;
83+
xl?: string;
84+
}) => string;
85+
};
86+
87+
export const flexUtils: {
88+
defaultProps: {
89+
'$grid-breakpoints': {
90+
xs: string;
91+
sm: string;
92+
md: string;
93+
lg: string;
94+
xl: string;
95+
};
96+
};
97+
getFlexUtilities: (gridBreakpoints?: {
98+
xs?: string;
99+
sm?: string;
100+
md?: string;
101+
lg?: string;
102+
xl?: string;
103+
}) => string;
104+
};
105+
106+
export const floatUtils: {
107+
defaultProps: {
108+
'$grid-breakpoints': {
109+
xs: string;
110+
sm: string;
111+
md: string;
112+
lg: string;
113+
xl: string;
114+
};
115+
};
116+
getFloatUtilities: (gridBreakpoints?: {
117+
xs?: string;
118+
sm?: string;
119+
md?: string;
120+
lg?: string;
121+
xl?: string;
122+
}) => string;
123+
};
124+
125+
export const positionUtils: {
126+
defaultProps: {
127+
'$zindex-fixed': string;
128+
'$zindex-sticky': string;
129+
};
130+
getPositionUtilities: (
131+
zindexFixed?: string,
132+
zindexSticky?: string
133+
) => string;
134+
fixedTop: (zindexFixed?: string) => string;
135+
fixedBottom: (zindexFixed?: string) => string;
136+
stickTop: (zindexSticky?: string) => string;
137+
};
138+
139+
export const rebootUtils: {
140+
html: () => string;
141+
boxSizing: () => string;
142+
ie10FixViewport: () => string;
143+
body: (
144+
fontFamilyBase?: string,
145+
fontSizeBase?: string,
146+
fontWeightBase?: string,
147+
lineHeightBase?: string,
148+
bodyColor?: string,
149+
bodyBg?: string
150+
) => string;
151+
bodyUtils: () => string;
152+
tabIndex: () => string;
153+
svg: () => string;
154+
ie10FixHidden: () => string;
155+
getGlobalStyles: () => string;
156+
getGlobalStyleNoBootstrapProvider: (
157+
fontFamilyBase?: string,
158+
fontSizeBase?: string,
159+
fontWeightBase?: string,
160+
lineHeightBase?: string,
161+
bodyColor?: string,
162+
bodyBg?: string
163+
) => string;
164+
webkitFileUploadButton: () => string;
165+
};
166+
167+
export const getGlobalStyleNoBootstrapProvider: (typeof rebootUtils)['getGlobalStyleNoBootstrapProvider'];
168+
export const getGlobalStyles: (typeof rebootUtils)['getGlobalStyles'];
169+
170+
export const screenreadersUtils: {
171+
getScreenReadersUtilities: () => string;
172+
};
173+
174+
export const sizingUtils: {
175+
defaultProps: {
176+
$sizes: {
177+
25: string;
178+
50: string;
179+
75: string;
180+
100: string;
181+
};
182+
};
183+
getSizingUtilities: (sizes?: {
184+
25?: string;
185+
50?: string;
186+
75?: string;
187+
100?: string;
188+
}) => string;
189+
};
190+
191+
export const spacingUtils: {
192+
defaultProps: {
193+
'$grid-breakpoints': {
194+
xs: string;
195+
sm: string;
196+
md: string;
197+
lg: string;
198+
xl: string;
199+
};
200+
$spacers: {
201+
0: {
202+
x: string;
203+
y: string;
204+
};
205+
1: {
206+
x: string;
207+
y: string;
208+
};
209+
2: {
210+
x: string;
211+
y: string;
212+
};
213+
3: {
214+
x: string;
215+
y: string;
216+
};
217+
4: {
218+
x: string;
219+
y: string;
220+
};
221+
5: {
222+
x: string;
223+
y: string;
224+
};
225+
};
226+
};
227+
getSpacingUtilities: (
228+
gridBreakpoints?: {
229+
xs?: string;
230+
sm?: string;
231+
md?: string;
232+
lg?: string;
233+
xl?: string;
234+
},
235+
spacers?: {
236+
0?: {
237+
x: string;
238+
y: string;
239+
};
240+
1?: {
241+
x: string;
242+
y: string;
243+
};
244+
2?: {
245+
x: string;
246+
y: string;
247+
};
248+
3?: {
249+
x: string;
250+
y: string;
251+
};
252+
4?: {
253+
x: string;
254+
y: string;
255+
};
256+
5?: {
257+
x: string;
258+
y: string;
259+
};
260+
}
261+
) => string;
262+
};
263+
264+
export const textUtils: {
265+
defaultProps: {
266+
'$grid-breakpoints': {
267+
xs: string;
268+
sm: string;
269+
md: string;
270+
lg: string;
271+
xl: string;
272+
};
273+
'$enable-hover-media-query': boolean;
274+
'$font-weight-normal': string;
275+
'$font-weight-bold': string;
276+
'$text-muted': string;
277+
'$brand-primary': string;
278+
'$brand-success': string;
279+
'$brand-info': string;
280+
'$brand-warning': string;
281+
'$brand-danger': string;
282+
'$gray-dark': string;
283+
};
284+
getTextUtilities: (
285+
enableHoverMediaQuery?: boolean,
286+
gridBreakpoints?: {
287+
xs?: string;
288+
sm?: string;
289+
md?: string;
290+
lg?: string;
291+
xl?: string;
292+
},
293+
fontWeightNormal?: string,
294+
fontWeightBold?: string,
295+
textMuted?: string,
296+
brandPrimary?: string,
297+
brandSuccess?: string,
298+
brandInfo?: string,
299+
brandWarning?: string,
300+
brandDanger?: string,
301+
grayDark?: string
302+
) => string;
303+
};
304+
305+
export const transitionUtils: {
306+
defaultProps: {
307+
'$enable-transitions': boolean;
308+
'$transition-fade': string;
309+
'$transition-collapse': string;
310+
};
311+
getTransitionUtilities: (
312+
enableTransitions?: boolean,
313+
transitionFade?: string,
314+
transitionCollapse?: string
315+
) => string;
316+
getReactTransition: (
317+
enableTransitions: boolean,
318+
transition: string
319+
) => string;
320+
fade: (enableTransitions?: boolean, transitionFade?: string) => string;
321+
collapse: (
322+
enableTransitions?: boolean,
323+
transitionCollapse?: string
324+
) => string;
325+
};
326+
327+
export const visibilityUtils: {
328+
getVisibilityUtilities: () => string;
329+
};
330+
}

0 commit comments

Comments
 (0)