@workday/canvas-kit-react 6.0.0-alpha.0-next.21 → 6.0.0-alpha.0-next.27
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.
- package/action-bar/lib/ActionBar.tsx +43 -30
- package/common/lib/styles/accessibleHide.ts +2 -2
- package/common/lib/theming/README.md +189 -25
- package/common/lib/theming/breakpoints.ts +296 -16
- package/common/lib/theming/types.ts +191 -1
- package/dist/commonjs/action-bar/lib/ActionBar.d.ts.map +1 -1
- package/dist/commonjs/action-bar/lib/ActionBar.js +35 -27
- package/dist/commonjs/button/lib/parts/ButtonLabel.d.ts +1 -1
- package/dist/commonjs/common/lib/styles/accessibleHide.d.ts +2 -2
- package/dist/commonjs/common/lib/styles/accessibleHide.d.ts.map +1 -1
- package/dist/commonjs/common/lib/theming/breakpoints.d.ts +287 -6
- package/dist/commonjs/common/lib/theming/breakpoints.d.ts.map +1 -1
- package/dist/commonjs/common/lib/theming/breakpoints.js +192 -10
- package/dist/commonjs/common/lib/theming/types.d.ts +191 -1
- package/dist/commonjs/common/lib/theming/types.d.ts.map +1 -1
- package/dist/commonjs/common/lib/utils/components.d.ts +1 -1
- package/dist/commonjs/pagination/lib/Pagination/PageList.d.ts +1 -1
- package/dist/commonjs/pagination/lib/Pagination/Pagination.d.ts +5 -5
- package/dist/commonjs/pagination/lib/Pagination/common/List.d.ts +1 -1
- package/dist/commonjs/pagination/lib/Pagination/common/utils/space.d.ts +28 -28
- package/dist/commonjs/tokens/index.d.ts +3 -20
- package/dist/commonjs/tokens/index.d.ts.map +1 -1
- package/dist/commonjs/tokens/index.js +3 -6
- package/dist/commonjs/tokens/lib/depth.d.ts +109 -3
- package/dist/commonjs/tokens/lib/depth.d.ts.map +1 -1
- package/dist/commonjs/tokens/lib/depth.js +40 -5
- package/dist/es6/action-bar/lib/ActionBar.d.ts.map +1 -1
- package/dist/es6/action-bar/lib/ActionBar.js +33 -22
- package/dist/es6/button/lib/parts/ButtonLabel.d.ts +1 -1
- package/dist/es6/common/lib/styles/accessibleHide.d.ts +2 -2
- package/dist/es6/common/lib/styles/accessibleHide.d.ts.map +1 -1
- package/dist/es6/common/lib/theming/breakpoints.d.ts +287 -6
- package/dist/es6/common/lib/theming/breakpoints.d.ts.map +1 -1
- package/dist/es6/common/lib/theming/breakpoints.js +192 -10
- package/dist/es6/common/lib/theming/types.d.ts +191 -1
- package/dist/es6/common/lib/theming/types.d.ts.map +1 -1
- package/dist/es6/pagination/lib/Pagination/PageList.d.ts +1 -1
- package/dist/es6/pagination/lib/Pagination/Pagination.d.ts +5 -5
- package/dist/es6/pagination/lib/Pagination/common/List.d.ts +1 -1
- package/dist/es6/pagination/lib/Pagination/common/utils/space.d.ts +28 -28
- package/dist/es6/tokens/index.d.ts +3 -20
- package/dist/es6/tokens/index.d.ts.map +1 -1
- package/dist/es6/tokens/index.js +1 -1
- package/dist/es6/tokens/lib/depth.d.ts +109 -3
- package/dist/es6/tokens/lib/depth.d.ts.map +1 -1
- package/dist/es6/tokens/lib/depth.js +40 -2
- package/package.json +5 -6
- package/tokens/README.md +5 -12
- package/tokens/index.ts +2 -2
- package/tokens/lib/depth.ts +125 -3
- package/ts3.5/dist/commonjs/button/lib/parts/ButtonLabel.d.ts +1 -1
- package/ts3.5/dist/commonjs/common/lib/styles/accessibleHide.d.ts +2 -2
- package/ts3.5/dist/commonjs/common/lib/theming/breakpoints.d.ts +287 -6
- package/ts3.5/dist/commonjs/common/lib/theming/types.d.ts +191 -1
- package/ts3.5/dist/commonjs/common/lib/utils/components.d.ts +1 -1
- package/ts3.5/dist/commonjs/pagination/lib/Pagination/PageList.d.ts +1 -1
- package/ts3.5/dist/commonjs/pagination/lib/Pagination/Pagination.d.ts +5 -5
- package/ts3.5/dist/commonjs/pagination/lib/Pagination/common/List.d.ts +1 -1
- package/ts3.5/dist/commonjs/pagination/lib/Pagination/common/utils/space.d.ts +28 -28
- package/ts3.5/dist/commonjs/tokens/index.d.ts +3 -20
- package/ts3.5/dist/commonjs/tokens/lib/depth.d.ts +109 -3
- package/ts3.5/dist/es6/button/lib/parts/ButtonLabel.d.ts +1 -1
- package/ts3.5/dist/es6/common/lib/styles/accessibleHide.d.ts +2 -2
- package/ts3.5/dist/es6/common/lib/theming/breakpoints.d.ts +287 -6
- package/ts3.5/dist/es6/common/lib/theming/types.d.ts +191 -1
- package/ts3.5/dist/es6/pagination/lib/Pagination/PageList.d.ts +1 -1
- package/ts3.5/dist/es6/pagination/lib/Pagination/Pagination.d.ts +5 -5
- package/ts3.5/dist/es6/pagination/lib/Pagination/common/List.d.ts +1 -1
- package/ts3.5/dist/es6/pagination/lib/Pagination/common/utils/space.d.ts +28 -28
- package/ts3.5/dist/es6/tokens/index.d.ts +3 -20
- package/ts3.5/dist/es6/tokens/lib/depth.d.ts +109 -3
|
@@ -7,16 +7,297 @@ export declare enum BreakpointKey {
|
|
|
7
7
|
}
|
|
8
8
|
export declare type BreakpointFnParam = BreakpointKey | keyof typeof BreakpointKey;
|
|
9
9
|
export declare type CanvasBreakpoints = {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
10
|
+
/**
|
|
11
|
+
* ### Zero Breakpoint
|
|
12
|
+
*
|
|
13
|
+
* This breakpoint is useful when you need to set a media query `min-width` below small.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
18
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
19
|
+
*
|
|
20
|
+
* const theme = useTheme();
|
|
21
|
+
* const { values } = theme.canvas.breakpoints;
|
|
22
|
+
* const styles = {
|
|
23
|
+
* [`@media (min-width: ${values.zero}px)`]: {
|
|
24
|
+
* padding: space.xxs,
|
|
25
|
+
* },
|
|
26
|
+
* }
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
zero: 0;
|
|
30
|
+
/**
|
|
31
|
+
* ### Small Breakpoint
|
|
32
|
+
*
|
|
33
|
+
* The small breakpoint provides the `min-width` for mobile devices, such as phones and tablets.
|
|
34
|
+
* This size ranges from a min-width of 320px to a max-width of 767px.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
39
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
40
|
+
*
|
|
41
|
+
* const theme = useTheme();
|
|
42
|
+
* const { values } = theme.canvas.breakpoints;
|
|
43
|
+
* const styles = {
|
|
44
|
+
* [`@media (min-width: ${values.s}px)`]: {
|
|
45
|
+
* padding: space.xs,
|
|
46
|
+
* },
|
|
47
|
+
* }
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
s: 320;
|
|
51
|
+
/**
|
|
52
|
+
* ### Medium Breakpoint
|
|
53
|
+
*
|
|
54
|
+
* The medium breakpoint is the min-width for intended for medium screens, such as laptops.
|
|
55
|
+
* This size ranges from a min-width of 768px to a max-width of 1023px.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
60
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
61
|
+
*
|
|
62
|
+
* const theme = useTheme();
|
|
63
|
+
* const { values } = theme.canvas.breakpoints;
|
|
64
|
+
* const styles = {
|
|
65
|
+
* [`@media (min-width: ${values.m}px)`]: {
|
|
66
|
+
* padding: space.s,
|
|
67
|
+
* },
|
|
68
|
+
* }
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
m: 768;
|
|
72
|
+
/**
|
|
73
|
+
* ### Large Breakpoint
|
|
74
|
+
*
|
|
75
|
+
* The large breakpoint is the min-width for intended for large screens, such as desktops.
|
|
76
|
+
* This size ranges from a min-width of 1024px to a max-width of 1439px.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
81
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
82
|
+
*
|
|
83
|
+
* const theme = useTheme();
|
|
84
|
+
* const { values } = theme.canvas.breakpoints;
|
|
85
|
+
* const styles = {
|
|
86
|
+
* [`@media (min-width: ${values.m}px)`]: {
|
|
87
|
+
* padding: space.s,
|
|
88
|
+
* },
|
|
89
|
+
* }
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
l: 1024;
|
|
93
|
+
/**
|
|
94
|
+
* ### Extra-Large Breakpoint
|
|
95
|
+
*
|
|
96
|
+
* The large breakpoint is the min-width for intended for extra-large screens, such as wide monitors and TVs.
|
|
97
|
+
* This size has a min-width of 1440px and no max-width.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
102
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
103
|
+
*
|
|
104
|
+
* const theme = useTheme();
|
|
105
|
+
* const { values } = theme.canvas.breakpoints;
|
|
106
|
+
* const styles = {
|
|
107
|
+
* [`@media (min-width: ${values.m}px)`]: {
|
|
108
|
+
* padding: space.s
|
|
109
|
+
* },
|
|
110
|
+
* }
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
xl: 1440;
|
|
15
114
|
};
|
|
16
115
|
export declare const breakpointKeys: readonly ["zero", "s", "m", "l", "xl"];
|
|
116
|
+
/**
|
|
117
|
+
* ### Theme Breakpoint Values
|
|
118
|
+
*
|
|
119
|
+
* Breakpoints are used by media queries to conditionally apply or modify styles based on the viewport width.
|
|
120
|
+
* This allows the UI to be responsive to various screen sizes. This object provides five breakpoint values
|
|
121
|
+
* that correspond to the min-widths of our standard screen sizes.
|
|
122
|
+
*
|
|
123
|
+
* - `zero`: 0
|
|
124
|
+
* - `s`: 320
|
|
125
|
+
* - `m`: 768
|
|
126
|
+
* - `l`: 1024
|
|
127
|
+
* - `xl`: 1440
|
|
128
|
+
*
|
|
129
|
+
* And these are our standard screen size ranges:
|
|
130
|
+
*
|
|
131
|
+
* - `small` (320px - 767px) Used for mobile-sized screens
|
|
132
|
+
* - `medium` (768px - 1023px) Used for tablet-sized screens
|
|
133
|
+
* - `large` - (1024px - 1439px) Used for laptop and small desktop screens
|
|
134
|
+
* - `extra-large` (≥1440px) Used for very large screens
|
|
135
|
+
*
|
|
136
|
+
* Note: Some applications may only require a subset of screen sizes and not use all breakpoints.
|
|
137
|
+
*
|
|
138
|
+
*/
|
|
17
139
|
export declare const breakpoints: CanvasBreakpoints;
|
|
140
|
+
/**
|
|
141
|
+
* ### Up
|
|
142
|
+
*
|
|
143
|
+
* _Returns a media query above the `min-width` for the range of a given breakpoint_
|
|
144
|
+
*
|
|
145
|
+
* Given a `start` breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
146
|
+
* this function returns a media query (string) using a `min-width`.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```ts
|
|
150
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
151
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
152
|
+
*
|
|
153
|
+
* const theme = useTheme();
|
|
154
|
+
* const { up } = theme.canvas.breakpoints;
|
|
155
|
+
* const mediaQuery = up('l'); // Returns '@media (min-width: 1024px)'
|
|
156
|
+
* const styles = {
|
|
157
|
+
* [mediaQuery]: {
|
|
158
|
+
* padding: space.m,
|
|
159
|
+
* }
|
|
160
|
+
* };
|
|
161
|
+
* ```
|
|
162
|
+
*/
|
|
18
163
|
export declare function up(key: BreakpointFnParam): string;
|
|
19
|
-
|
|
164
|
+
/**
|
|
165
|
+
* ### Down
|
|
166
|
+
*
|
|
167
|
+
* _Returns a media query below the `max-width` for the range of a given breakpoint_
|
|
168
|
+
*
|
|
169
|
+
* Given an `end` breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
170
|
+
* this function returns a media query (string) using a `max-width`.
|
|
171
|
+
*
|
|
172
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
173
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
174
|
+
*
|
|
175
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of `0`,
|
|
176
|
+
* as seen in the second example below.
|
|
177
|
+
*
|
|
178
|
+
* @example
|
|
179
|
+
* ```ts
|
|
180
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
181
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
182
|
+
*
|
|
183
|
+
* const theme = useTheme();
|
|
184
|
+
* const { down } = theme.canvas.breakpoints;
|
|
185
|
+
* const mediaQuery = down('m'); // Returns '@media (max-width: 1023.5px)'
|
|
186
|
+
* const styles = {
|
|
187
|
+
* [mediaQuery]: {
|
|
188
|
+
* padding: space.m,
|
|
189
|
+
* }
|
|
190
|
+
* };
|
|
191
|
+
* ```
|
|
192
|
+
*
|
|
193
|
+
* This example uses the `xl` breakpoint and only adds a `min-width` of `0` to the media query.
|
|
194
|
+
* @example
|
|
195
|
+
* ```ts
|
|
196
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
197
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
198
|
+
*
|
|
199
|
+
* const theme = useTheme();
|
|
200
|
+
* const { down } = theme.canvas.breakpoints;
|
|
201
|
+
* const mediaQuery = down('xl'); // Returns '@media (min-width: 0)'
|
|
202
|
+
* const styles = {
|
|
203
|
+
* [mediaQuery]: {
|
|
204
|
+
* padding: space.m,
|
|
205
|
+
* }
|
|
206
|
+
* };
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
export declare function down(endKey: BreakpointFnParam): string;
|
|
210
|
+
/**
|
|
211
|
+
* ### Between
|
|
212
|
+
*
|
|
213
|
+
* _Returns a media query between two given breakpoints_
|
|
214
|
+
*
|
|
215
|
+
* Given `start` and `end` breakpoint keys ("zero", "s", "m", "l", "xl"),
|
|
216
|
+
* this function returns a media query (string) using a min-width and max-width.
|
|
217
|
+
*
|
|
218
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
219
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
220
|
+
*
|
|
221
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width`,
|
|
222
|
+
* as seen in the second example below.
|
|
223
|
+
*
|
|
224
|
+
* @example
|
|
225
|
+
* ```ts
|
|
226
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
227
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
228
|
+
*
|
|
229
|
+
* const theme = useTheme();
|
|
230
|
+
* const { between } = theme.canvas.breakpoints;
|
|
231
|
+
* // Returns '@media (min-width: 320px) and (max-width: 1023.5px)'
|
|
232
|
+
* const mediaQuery = between('s', 'm');
|
|
233
|
+
* const styles = {
|
|
234
|
+
* [mediaQuery]: {
|
|
235
|
+
* padding: space.s,
|
|
236
|
+
* }
|
|
237
|
+
* };
|
|
238
|
+
* ```
|
|
239
|
+
*
|
|
240
|
+
* This example uses `xl` as the `end` breakpoint and only adds a min-width to the media query.
|
|
241
|
+
* @example
|
|
242
|
+
* ```ts
|
|
243
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
244
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
245
|
+
*
|
|
246
|
+
* const theme = useTheme();
|
|
247
|
+
* const { between } = theme.canvas.breakpoints;
|
|
248
|
+
* const mediaQuery = between('m', 'xl'); // Returns '@media (min-width: 768px)'
|
|
249
|
+
* const styles = {
|
|
250
|
+
* [mediaQuery]: {
|
|
251
|
+
* padding: space.s,
|
|
252
|
+
* }
|
|
253
|
+
* };
|
|
254
|
+
* ```
|
|
255
|
+
*/
|
|
20
256
|
export declare function between(start: BreakpointFnParam, end: BreakpointFnParam): string;
|
|
257
|
+
/**
|
|
258
|
+
* ### Only
|
|
259
|
+
*
|
|
260
|
+
* _Returns a media query with a `min-width` and `max-width` for a given breakpoint_
|
|
261
|
+
*
|
|
262
|
+
* Given a breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
263
|
+
* this function returns a media query (string) using a `min-width` and `max-width`.
|
|
264
|
+
*
|
|
265
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
266
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
267
|
+
*
|
|
268
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of `1440px`,
|
|
269
|
+
* as seen in the second example below.
|
|
270
|
+
*
|
|
271
|
+
* @example
|
|
272
|
+
* ```ts
|
|
273
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
274
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
275
|
+
*
|
|
276
|
+
* const theme = useTheme();
|
|
277
|
+
* const { only } = theme.canvas.breakpoints;
|
|
278
|
+
* const mediaQuery = only('s'); // Returns '@media (min-width: 320px) and (max-width: 767.5px)'
|
|
279
|
+
* const styles = {
|
|
280
|
+
* [mediaQuery]: {
|
|
281
|
+
* padding: space.s,
|
|
282
|
+
* }
|
|
283
|
+
* };
|
|
284
|
+
* ```
|
|
285
|
+
*
|
|
286
|
+
* This example uses the `xl` breakpoint and only adds a `min-width` of `1440px` to the media query.
|
|
287
|
+
* @example
|
|
288
|
+
* ```ts
|
|
289
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
290
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
291
|
+
*
|
|
292
|
+
* const theme = useTheme();
|
|
293
|
+
* const { only } = theme.canvas.breakpoints;
|
|
294
|
+
* const mediaQuery = only('xl'); // Returns '@media (min-width: 1440px)'
|
|
295
|
+
* const styles = {
|
|
296
|
+
* [mediaQuery]: {
|
|
297
|
+
* padding: space.s,
|
|
298
|
+
* }
|
|
299
|
+
* };
|
|
300
|
+
* ```
|
|
301
|
+
*/
|
|
21
302
|
export declare function only(key: BreakpointFnParam): string;
|
|
22
303
|
//# sourceMappingURL=breakpoints.d.ts.map
|
|
@@ -32,12 +32,202 @@ export interface CanvasTheme {
|
|
|
32
32
|
success: CanvasThemePalette;
|
|
33
33
|
neutral: CanvasThemePalette;
|
|
34
34
|
};
|
|
35
|
+
/**
|
|
36
|
+
* ### Theme Breakpoints
|
|
37
|
+
*
|
|
38
|
+
* Breakpoints are used by media queries to conditionally apply or modify styles based on the viewport width.
|
|
39
|
+
* This allows the UI to be responsive to various screen sizes.
|
|
40
|
+
*
|
|
41
|
+
* This breakpoints object contains `values` and several helper functions: `up`, `down`, `between`, and `only`.
|
|
42
|
+
* You can find more detailed information by inspecting individual values and functions.
|
|
43
|
+
*/
|
|
35
44
|
breakpoints: {
|
|
45
|
+
/**
|
|
46
|
+
* ### Breakpoint Values
|
|
47
|
+
*
|
|
48
|
+
* This object provides five breakpoint values
|
|
49
|
+
* that correspond to the min-widths of our standard screen sizes.
|
|
50
|
+
*
|
|
51
|
+
* - `zero`: 0
|
|
52
|
+
* - `s`: 320
|
|
53
|
+
* - `m`: 768
|
|
54
|
+
* - `l`: 1024
|
|
55
|
+
* - `xl`: 1440
|
|
56
|
+
*
|
|
57
|
+
* And these are our standard screen size ranges:
|
|
58
|
+
*
|
|
59
|
+
* - `small` (320px - 767px) Used for mobile-sized screens
|
|
60
|
+
* - `medium` (768px - 1023px) Used for tablet-sized screens
|
|
61
|
+
* - `large` - (1024px - 1439px) Used for laptop and small desktop screens
|
|
62
|
+
* - `extra-large` (≥1440px) Used for very large screens
|
|
63
|
+
*
|
|
64
|
+
* Note: Some applications may only require a subset of screen sizes and not use all breakpoints.
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
36
67
|
values: CanvasBreakpoints;
|
|
68
|
+
/**
|
|
69
|
+
* ### Up
|
|
70
|
+
*
|
|
71
|
+
* _Returns a media query above the `min-width` for the range of a given breakpoint_
|
|
72
|
+
*
|
|
73
|
+
* Given a `start` breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
74
|
+
* this function returns a media query (string) using a `min-width`.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
79
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
80
|
+
*
|
|
81
|
+
* const theme = useTheme();
|
|
82
|
+
* const { up } = theme.canvas.breakpoints;
|
|
83
|
+
* const mediaQuery = up('l'); // Returns '@media (min-width: 1024px)'
|
|
84
|
+
* const styles = {
|
|
85
|
+
* [mediaQuery]: {
|
|
86
|
+
* padding: space.m,
|
|
87
|
+
* }
|
|
88
|
+
* };
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
37
91
|
up: (key: BreakpointFnParam) => string;
|
|
92
|
+
/**
|
|
93
|
+
* ### Down
|
|
94
|
+
*
|
|
95
|
+
* _Returns a media query below the `max-width` for the range of a given breakpoint_
|
|
96
|
+
*
|
|
97
|
+
* Given an `end` breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
98
|
+
* this function returns a media query (string) using a `max-width`.
|
|
99
|
+
*
|
|
100
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
101
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
102
|
+
*
|
|
103
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of `0`,
|
|
104
|
+
* as seen in the second example below.
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
109
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
110
|
+
*
|
|
111
|
+
* const theme = useTheme();
|
|
112
|
+
* const { down } = theme.canvas.breakpoints;
|
|
113
|
+
* const mediaQuery = down('m'); // Returns '@media (max-width: 1023.5px)'
|
|
114
|
+
* const styles = {
|
|
115
|
+
* [mediaQuery]: {
|
|
116
|
+
* padding: space.m,
|
|
117
|
+
* }
|
|
118
|
+
* };
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
121
|
+
* This example uses the `xl` breakpoint and only adds a `min-width` of `0` to the media query.
|
|
122
|
+
* @example
|
|
123
|
+
* ```ts
|
|
124
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
125
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
126
|
+
*
|
|
127
|
+
* const theme = useTheme();
|
|
128
|
+
* const { down } = theme.canvas.breakpoints;
|
|
129
|
+
* const mediaQuery = down('xl'); // Returns '@media (min-width: 0)'
|
|
130
|
+
* const styles = {
|
|
131
|
+
* [mediaQuery]: {
|
|
132
|
+
* padding: space.m,
|
|
133
|
+
* }
|
|
134
|
+
* };
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
38
137
|
down: (key: BreakpointFnParam) => string;
|
|
39
|
-
|
|
138
|
+
/**
|
|
139
|
+
* ### Between
|
|
140
|
+
*
|
|
141
|
+
* _Returns a media query between two given breakpoints_
|
|
142
|
+
*
|
|
143
|
+
* Given `start` and `end` breakpoint keys ("zero", "s", "m", "l", "xl"),
|
|
144
|
+
* this function returns a media query (string) using a min-width and max-width.
|
|
145
|
+
*
|
|
146
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
147
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
148
|
+
*
|
|
149
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width`,
|
|
150
|
+
* as seen in the second example below.
|
|
151
|
+
*
|
|
152
|
+
* @example
|
|
153
|
+
* ```ts
|
|
154
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
155
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
156
|
+
*
|
|
157
|
+
* const theme = useTheme();
|
|
158
|
+
* const { between } = theme.canvas.breakpoints;
|
|
159
|
+
* // Returns '@media (min-width: 320px) and (max-width: 1023.5px)'
|
|
160
|
+
* const mediaQuery = between('s', 'm');
|
|
161
|
+
* const styles = {
|
|
162
|
+
* [mediaQuery]: {
|
|
163
|
+
* padding: space.s,
|
|
164
|
+
* }
|
|
165
|
+
* };
|
|
166
|
+
* ```
|
|
167
|
+
*
|
|
168
|
+
* This example uses `xl` as the `end` breakpoint and only adds a min-width to the media query.
|
|
169
|
+
* @example
|
|
170
|
+
* ```ts
|
|
171
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
172
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
173
|
+
*
|
|
174
|
+
* const theme = useTheme();
|
|
175
|
+
* const { between } = theme.canvas.breakpoints;
|
|
176
|
+
* const mediaQuery = between('m', 'xl'); // Returns '@media (min-width: 768px)'
|
|
177
|
+
* const styles = {
|
|
178
|
+
* [mediaQuery]: {
|
|
179
|
+
* padding: space.s,
|
|
180
|
+
* }
|
|
181
|
+
* };
|
|
182
|
+
* ```
|
|
183
|
+
*/
|
|
40
184
|
between: (start: BreakpointFnParam, end: BreakpointFnParam) => string;
|
|
185
|
+
/**
|
|
186
|
+
* ### Only
|
|
187
|
+
*
|
|
188
|
+
* _Returns a media query with a `min-width` and `max-width` for a given breakpoint_
|
|
189
|
+
*
|
|
190
|
+
* Given a breakpoint key ("zero", "s", "m", "l", "xl"),
|
|
191
|
+
* this function returns a media query (string) using a `min-width` and `max-width`.
|
|
192
|
+
*
|
|
193
|
+
* Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.
|
|
194
|
+
* For example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
|
|
195
|
+
*
|
|
196
|
+
* If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of `1440px`,
|
|
197
|
+
* as seen in the second example below.
|
|
198
|
+
*
|
|
199
|
+
* @example
|
|
200
|
+
* ```ts
|
|
201
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
202
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
203
|
+
*
|
|
204
|
+
* const theme = useTheme();
|
|
205
|
+
* const { only } = theme.canvas.breakpoints;
|
|
206
|
+
* const mediaQuery = only('s'); // Returns '@media (min-width: 320px) and (max-width: 767.5px)'
|
|
207
|
+
* const styles = {
|
|
208
|
+
* [mediaQuery]: {
|
|
209
|
+
* padding: space.s,
|
|
210
|
+
* }
|
|
211
|
+
* };
|
|
212
|
+
* ```
|
|
213
|
+
*
|
|
214
|
+
* This example uses the `xl` breakpoint and only adds a `min-width` of `1440px` to the media query.
|
|
215
|
+
* @example
|
|
216
|
+
* ```ts
|
|
217
|
+
* import { useTheme } from '@workday/canvas-kit-react/common';
|
|
218
|
+
* import { space } from '@workday/canvas-kit-react/tokens';
|
|
219
|
+
*
|
|
220
|
+
* const theme = useTheme();
|
|
221
|
+
* const { only } = theme.canvas.breakpoints;
|
|
222
|
+
* const mediaQuery = only('xl'); // Returns '@media (min-width: 1440px)'
|
|
223
|
+
* const styles = {
|
|
224
|
+
* [mediaQuery]: {
|
|
225
|
+
* padding: space.s,
|
|
226
|
+
* }
|
|
227
|
+
* };
|
|
228
|
+
* ```
|
|
229
|
+
*/
|
|
230
|
+
only: (key: BreakpointFnParam) => string;
|
|
41
231
|
};
|
|
42
232
|
direction: ContentDirection;
|
|
43
233
|
}
|
|
@@ -8,5 +8,5 @@ export interface PageListProps extends Omit<ListProps, 'as'> {
|
|
|
8
8
|
}
|
|
9
9
|
export declare const PageList: ({ model, children, ...elemProps }: PageListProps) => JSX.Element;
|
|
10
10
|
export declare type PageListItemProps = ListItemProps;
|
|
11
|
-
export declare const PageListItem: ({ children, ...elemProps }: Pick<import("./common/Flex").FlexProps, "hidden" | "color" | "style" | "flex" | "wrap" | "padding" | "p" | "title" | "children" | "alignContent" | "alignItems" | "alignSelf" | "direction" | "display" | "flexBasis" | "flexDirection" | "flexGrow" | "flexShrink" | "flexWrap" | "height" | "justifyContent" | "justifyItems" | "justifySelf" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "order" | "overflowX" | "overflowY" | "verticalAlign" | "width" | "margin" | "overflow" | "m" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "
|
|
11
|
+
export declare const PageListItem: ({ children, ...elemProps }: Pick<import("./common/Flex").FlexProps, "hidden" | "color" | "style" | "flex" | "wrap" | "padding" | "p" | "title" | "children" | "alignContent" | "alignItems" | "alignSelf" | "direction" | "display" | "flexBasis" | "flexDirection" | "flexGrow" | "flexShrink" | "flexWrap" | "height" | "justifyContent" | "justifyItems" | "justifySelf" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "order" | "overflowX" | "overflowY" | "verticalAlign" | "width" | "margin" | "overflow" | "m" | "css" | "dir" | "slot" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "draggable" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "inputMode" | "is" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "grow" | "marginX" | "marginY" | "paddingX" | "paddingY" | "basis" | "mx" | "my" | "marginT" | "mt" | "marginR" | "mr" | "marginB" | "mb" | "marginL" | "ml" | "px" | "py" | "paddingT" | "pt" | "paddingR" | "pr" | "paddingB" | "pb" | "paddingL" | "pl" | "shrink">) => JSX.Element;
|
|
12
12
|
//# sourceMappingURL=PageList.d.ts.map
|