@oaknational/oak-components 2.33.0 → 2.34.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.
- package/README.md +9 -11
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/types.d.ts +585 -812
- package/package.json +12 -3
package/dist/types.d.ts
CHANGED
|
@@ -1,13 +1,9 @@
|
|
|
1
|
-
import
|
|
2
|
-
import React__default, { CSSProperties as CSSProperties$1, ElementType, ComponentPropsWithoutRef, ComponentPropsWithRef, MouseEventHandler, FC, ReactNode, HTMLAttributes, DetailedHTMLProps, TextareaHTMLAttributes, InputHTMLAttributes, FocusEvent, ChangeEventHandler, ComponentProps, ReactElement, MutableRefObject, ButtonHTMLAttributes, PropsWithChildren } from 'react';
|
|
1
|
+
import React$1, { CSSProperties, MouseEventHandler, ElementType, ComponentPropsWithoutRef, ComponentPropsWithRef, FC, ReactNode, HTMLAttributes, DetailedHTMLProps, TextareaHTMLAttributes, InputHTMLAttributes, FocusEvent, ChangeEventHandler, ComponentProps, ReactElement, MutableRefObject, ButtonHTMLAttributes, PropsWithChildren } from 'react';
|
|
3
2
|
import * as styled_components from 'styled-components';
|
|
4
|
-
import { ThemedStyledProps, DefaultTheme, Interpolation, CSSProperties } from 'styled-components';
|
|
5
|
-
import
|
|
6
|
-
import Image__default, { ImageProps as ImageProps$1 } from 'next/image';
|
|
3
|
+
import { ThemedStyledProps, DefaultTheme, Interpolation, CSSProperties as CSSProperties$1 } from 'styled-components';
|
|
4
|
+
import Image, { ImageProps as ImageProps$1 } from 'next/image';
|
|
7
5
|
import { UrlObject } from 'url';
|
|
8
6
|
import { Announcements } from '@dnd-kit/core';
|
|
9
|
-
import * as next_dist_shared_lib_get_img_props from 'next/dist/shared/lib/get-img-props';
|
|
10
|
-
import * as _cloudinary_util_url_loader from '@cloudinary-util/url-loader';
|
|
11
7
|
import { CldImage } from 'next-cloudinary';
|
|
12
8
|
|
|
13
9
|
declare const oakColorTokens: {
|
|
@@ -127,6 +123,34 @@ type Generic = string | number | undefined | null;
|
|
|
127
123
|
*/
|
|
128
124
|
declare const responsiveStyle: <Props, T extends Generic>(attr: string, getValues: (props: Props) => ResponsiveValues<T | undefined | null>, parse?: ((unparsed: T | undefined | null) => Generic) | ((unparsed: T | undefined | null) => (props: PropsWithTheme) => Generic)) => (props: Props) => Interpolation<ThemedStyledProps<Props, DefaultTheme>>;
|
|
129
125
|
|
|
126
|
+
/**
|
|
127
|
+
* Color token!
|
|
128
|
+
*/
|
|
129
|
+
type ColorToken = ResponsiveValues<OakUiRoleToken | null>;
|
|
130
|
+
type ColorStyleProps = {
|
|
131
|
+
/**
|
|
132
|
+
* Sets the `color` of the element.
|
|
133
|
+
*
|
|
134
|
+
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
135
|
+
*/
|
|
136
|
+
$color?: ColorToken;
|
|
137
|
+
/**
|
|
138
|
+
* Sets the `background-color` of the element.
|
|
139
|
+
*
|
|
140
|
+
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
141
|
+
*/
|
|
142
|
+
$background?: ColorToken;
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
type DisplayStyleProps = {
|
|
146
|
+
/**
|
|
147
|
+
* Sets the `display` CSS property of the element.
|
|
148
|
+
*
|
|
149
|
+
* Accepts a `display` value or a responsive array of `display` values.
|
|
150
|
+
*/
|
|
151
|
+
$display?: ResponsiveValues<CSSProperties["display"]>;
|
|
152
|
+
};
|
|
153
|
+
|
|
130
154
|
declare const oakAllSpacingTokens: {
|
|
131
155
|
"spacing-0": number;
|
|
132
156
|
"spacing-2": number;
|
|
@@ -211,254 +235,6 @@ declare const additionalSpacingTokens: {
|
|
|
211
235
|
type AdditionalSpacingTypes = keyof typeof additionalSpacingTokens;
|
|
212
236
|
type OakCombinedSpacingToken = OakAllSpacingToken | OakInnerPaddingToken | OakSpaceBetweenToken | AdditionalSpacingTypes;
|
|
213
237
|
|
|
214
|
-
type ScrollMarginValue = OakAllSpacingToken | null | undefined;
|
|
215
|
-
type ScrollMarginValues = ResponsiveValues<ScrollMarginValue>;
|
|
216
|
-
type ScrollSnapStyleProps = {
|
|
217
|
-
/**
|
|
218
|
-
* Applies `scroll-margin-top` to the element
|
|
219
|
-
*
|
|
220
|
-
* Accepts any Oak spacing token or a responsive array of spacing tokens. Can be nulled.
|
|
221
|
-
*/
|
|
222
|
-
$scrollMarginTop?: ScrollMarginValues;
|
|
223
|
-
/**
|
|
224
|
-
* Applies `scroll-margin-left` to the element
|
|
225
|
-
*
|
|
226
|
-
* Accepts any Oak spacing token or a responsive array of spacing tokens. Can be nulled.
|
|
227
|
-
*/
|
|
228
|
-
$scrollMarginLeft?: ScrollMarginValues;
|
|
229
|
-
};
|
|
230
|
-
|
|
231
|
-
declare const oakZIndexTokens: {
|
|
232
|
-
readonly behind: -1;
|
|
233
|
-
readonly neutral: 0;
|
|
234
|
-
readonly "in-front": 1;
|
|
235
|
-
readonly "mobile-filters": 2;
|
|
236
|
-
readonly "fixed-header": 100;
|
|
237
|
-
readonly "modal-close-button": 150;
|
|
238
|
-
readonly "modal-dialog": 300;
|
|
239
|
-
readonly banner: number;
|
|
240
|
-
};
|
|
241
|
-
type OakZIndexToken = keyof typeof oakZIndexTokens | null;
|
|
242
|
-
|
|
243
|
-
type ZIndexStyleProps = {
|
|
244
|
-
/**
|
|
245
|
-
* Sets the `z-index` CSS property of the element.
|
|
246
|
-
*
|
|
247
|
-
* Accepts a z-index token or a responsive array of z-index tokens.
|
|
248
|
-
*/
|
|
249
|
-
$zIndex?: ResponsiveValues<OakZIndexToken | number>;
|
|
250
|
-
};
|
|
251
|
-
|
|
252
|
-
declare const oakTransitionTokens: {
|
|
253
|
-
"standard-ease": string;
|
|
254
|
-
"standard-transform": string;
|
|
255
|
-
};
|
|
256
|
-
type OakTransitionToken = keyof typeof oakTransitionTokens;
|
|
257
|
-
|
|
258
|
-
type Transition = OakTransitionToken;
|
|
259
|
-
type TransitionStyleProps = {
|
|
260
|
-
/**
|
|
261
|
-
* Sets the `transition` CSS property of the element.
|
|
262
|
-
*
|
|
263
|
-
* Accepts a transition token or a responsive array of transition tokens.
|
|
264
|
-
*/
|
|
265
|
-
$transition?: ResponsiveValues<Transition>;
|
|
266
|
-
};
|
|
267
|
-
|
|
268
|
-
type TransformStyleProps = {
|
|
269
|
-
/**
|
|
270
|
-
* Sets the `transform` CSS property of the element.
|
|
271
|
-
*
|
|
272
|
-
* Accepts a `transform` value or a responsive array of `transform` values. Can be nulled.
|
|
273
|
-
*/
|
|
274
|
-
$transform?: ResponsiveValues<CSSProperties["transform"] | null>;
|
|
275
|
-
/**
|
|
276
|
-
* Sets the `transform-origin` CSS property of the element.
|
|
277
|
-
*
|
|
278
|
-
* Accepts a `transform-origin` value or a responsive array of `transform-origin` values. Can be nulled.
|
|
279
|
-
*/
|
|
280
|
-
$transformOrigin?: ResponsiveValues<CSSProperties["transformOrigin"] | null>;
|
|
281
|
-
};
|
|
282
|
-
|
|
283
|
-
declare const oakOpacityTokens: {
|
|
284
|
-
transparent: number;
|
|
285
|
-
"semi-transparent": number;
|
|
286
|
-
"semi-opaque": number;
|
|
287
|
-
opaque: number;
|
|
288
|
-
};
|
|
289
|
-
type OakOpacityToken = keyof typeof oakOpacityTokens;
|
|
290
|
-
|
|
291
|
-
type OpacityStyleProps = {
|
|
292
|
-
/**
|
|
293
|
-
* Sets the `opacity` CSS property of the element.
|
|
294
|
-
*
|
|
295
|
-
* Accepts an opacity token or a responsive array of opacity tokens.
|
|
296
|
-
*/
|
|
297
|
-
$opacity?: ResponsiveValues<OakOpacityToken>;
|
|
298
|
-
};
|
|
299
|
-
|
|
300
|
-
declare const oakDropShadowTokens: {
|
|
301
|
-
"drop-shadow-standard": string;
|
|
302
|
-
"drop-shadow-lemon": string;
|
|
303
|
-
"drop-shadow-wide-lemon": string;
|
|
304
|
-
"drop-shadow-centered-lemon": string;
|
|
305
|
-
"drop-shadow-grey": string;
|
|
306
|
-
"drop-shadow-centered-grey": string;
|
|
307
|
-
"drop-shadow-black": string;
|
|
308
|
-
"drop-shadow-centred-standard": string;
|
|
309
|
-
"drop-shadow-none": string;
|
|
310
|
-
};
|
|
311
|
-
type OakDropShadowToken = keyof typeof oakDropShadowTokens;
|
|
312
|
-
|
|
313
|
-
type DropShadowStyleProps = {
|
|
314
|
-
/**
|
|
315
|
-
* Applies a drop-shadow to the element.
|
|
316
|
-
*
|
|
317
|
-
* Accepts a drop-shadow token or a responsive array of drop-shadow tokens.
|
|
318
|
-
*/
|
|
319
|
-
$dropShadow?: ResponsiveValues<OakDropShadowToken>;
|
|
320
|
-
};
|
|
321
|
-
|
|
322
|
-
declare const oakBorderWidthTokens: {
|
|
323
|
-
"border-solid-none": number;
|
|
324
|
-
"border-solid-s": number;
|
|
325
|
-
"border-solid-m": number;
|
|
326
|
-
"border-solid-l": number;
|
|
327
|
-
"border-solid-xl": number;
|
|
328
|
-
"border-solid-xxl": number;
|
|
329
|
-
"border-solid-xxxl": number;
|
|
330
|
-
"border-solid-xxxxl": number;
|
|
331
|
-
};
|
|
332
|
-
declare const oakBorderRadiusTokens: {
|
|
333
|
-
"border-radius-square": number;
|
|
334
|
-
"border-radius-xs": number;
|
|
335
|
-
"border-radius-s": number;
|
|
336
|
-
"border-radius-m": number;
|
|
337
|
-
"border-radius-m2": number;
|
|
338
|
-
"border-radius-l": number;
|
|
339
|
-
"border-radius-xl": number;
|
|
340
|
-
"border-radius-circle": number;
|
|
341
|
-
};
|
|
342
|
-
type OakBorderRadiusToken = keyof typeof oakBorderRadiusTokens;
|
|
343
|
-
type OakBorderWidthToken = keyof typeof oakBorderWidthTokens;
|
|
344
|
-
|
|
345
|
-
type BorderWidth = ResponsiveValues<OakBorderWidthToken>;
|
|
346
|
-
type _BorderStyleProps = ResponsiveValues<CSSProperties["borderStyle"]>;
|
|
347
|
-
type BorderColorProps = ResponsiveValues<OakUiRoleToken>;
|
|
348
|
-
type BorderRadiusProps = ResponsiveValues<OakBorderRadiusToken>;
|
|
349
|
-
type BorderStyleProps = {
|
|
350
|
-
/**
|
|
351
|
-
* Apply border on all sides
|
|
352
|
-
*
|
|
353
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
354
|
-
*/
|
|
355
|
-
$ba?: BorderWidth;
|
|
356
|
-
/**
|
|
357
|
-
* Apply border to the top
|
|
358
|
-
*
|
|
359
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
360
|
-
*/
|
|
361
|
-
$bt?: BorderWidth;
|
|
362
|
-
/**
|
|
363
|
-
* Apply border to the right
|
|
364
|
-
*
|
|
365
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
366
|
-
*/
|
|
367
|
-
$br?: BorderWidth;
|
|
368
|
-
/**
|
|
369
|
-
* Apply border to the bottom
|
|
370
|
-
*
|
|
371
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
372
|
-
*/
|
|
373
|
-
$bb?: BorderWidth;
|
|
374
|
-
/**
|
|
375
|
-
* Apply border to the left
|
|
376
|
-
*
|
|
377
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
378
|
-
*/
|
|
379
|
-
$bl?: BorderWidth;
|
|
380
|
-
/**
|
|
381
|
-
* Apply border to the left and right
|
|
382
|
-
*
|
|
383
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
384
|
-
*/
|
|
385
|
-
$bh?: BorderWidth;
|
|
386
|
-
/**
|
|
387
|
-
* Apply border to the top and bottom
|
|
388
|
-
*
|
|
389
|
-
* Accepts a border-width token or a responsive array of border-width tokens
|
|
390
|
-
*/
|
|
391
|
-
$bv?: BorderWidth;
|
|
392
|
-
/**
|
|
393
|
-
* Apply `border-style` to the element
|
|
394
|
-
*
|
|
395
|
-
* Accepts a single value or a responsive array of values.
|
|
396
|
-
*/
|
|
397
|
-
$borderStyle?: _BorderStyleProps;
|
|
398
|
-
/**
|
|
399
|
-
* Apply a border color to all sides of the element
|
|
400
|
-
*
|
|
401
|
-
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
402
|
-
*/
|
|
403
|
-
$borderColor?: BorderColorProps;
|
|
404
|
-
$borderRadius?: BorderRadiusProps;
|
|
405
|
-
/**
|
|
406
|
-
* Apply border radius to the top left
|
|
407
|
-
*
|
|
408
|
-
* Accepts an `OakBorderRadiusToken` or a responsive array of `OakBorderRadiusToken`s.
|
|
409
|
-
*/
|
|
410
|
-
$btlr?: BorderRadiusProps;
|
|
411
|
-
/**
|
|
412
|
-
* Apply border radius to the top right
|
|
413
|
-
*
|
|
414
|
-
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
415
|
-
*/
|
|
416
|
-
$btrr?: BorderRadiusProps;
|
|
417
|
-
/**
|
|
418
|
-
* Apply border radius to the bottom left
|
|
419
|
-
*
|
|
420
|
-
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
421
|
-
*/
|
|
422
|
-
$bblr?: BorderRadiusProps;
|
|
423
|
-
/**
|
|
424
|
-
* Apply border radius to the bottom right
|
|
425
|
-
*
|
|
426
|
-
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
427
|
-
*/
|
|
428
|
-
$bbrr?: BorderRadiusProps;
|
|
429
|
-
/**
|
|
430
|
-
* Apply border radius to the top right and top left
|
|
431
|
-
*
|
|
432
|
-
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
433
|
-
*/
|
|
434
|
-
$btr?: BorderRadiusProps;
|
|
435
|
-
/**
|
|
436
|
-
* Apply border radius to the bottom right and bottom left
|
|
437
|
-
*
|
|
438
|
-
* Accepts a border-radius token or a responsive array of border-radius tokens
|
|
439
|
-
*/
|
|
440
|
-
$bbr?: BorderRadiusProps;
|
|
441
|
-
};
|
|
442
|
-
|
|
443
|
-
/**
|
|
444
|
-
* Color token!
|
|
445
|
-
*/
|
|
446
|
-
type ColorToken = ResponsiveValues<OakUiRoleToken | null>;
|
|
447
|
-
type ColorStyleProps = {
|
|
448
|
-
/**
|
|
449
|
-
* Sets the `color` of the element.
|
|
450
|
-
*
|
|
451
|
-
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
452
|
-
*/
|
|
453
|
-
$color?: ColorToken;
|
|
454
|
-
/**
|
|
455
|
-
* Sets the `background-color` of the element.
|
|
456
|
-
*
|
|
457
|
-
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
458
|
-
*/
|
|
459
|
-
$background?: ColorToken;
|
|
460
|
-
};
|
|
461
|
-
|
|
462
238
|
type PaddingValues = ResponsiveValues<OakInnerPaddingToken | null | undefined>;
|
|
463
239
|
type PaddingStyleProps = {
|
|
464
240
|
/**
|
|
@@ -552,15 +328,6 @@ type MarginStyleProps = {
|
|
|
552
328
|
};
|
|
553
329
|
type SpacingStyleProps = PaddingStyleProps & MarginStyleProps;
|
|
554
330
|
|
|
555
|
-
type DisplayStyleProps = {
|
|
556
|
-
/**
|
|
557
|
-
* Sets the `display` CSS property of the element.
|
|
558
|
-
*
|
|
559
|
-
* Accepts a `display` value or a responsive array of `display` values.
|
|
560
|
-
*/
|
|
561
|
-
$display?: ResponsiveValues<CSSProperties$1["display"]>;
|
|
562
|
-
};
|
|
563
|
-
|
|
564
331
|
declare const oakFontSizeTokens: {
|
|
565
332
|
"font-size-1": number;
|
|
566
333
|
"font-size-2": number;
|
|
@@ -633,7 +400,7 @@ type TypographyStyleProps = {
|
|
|
633
400
|
*
|
|
634
401
|
* Accepts a `text-align` value or a responsive array of `text-align` values.
|
|
635
402
|
*/
|
|
636
|
-
$textAlign?: ResponsiveValues<CSSProperties["textAlign"]>;
|
|
403
|
+
$textAlign?: ResponsiveValues<CSSProperties$1["textAlign"]>;
|
|
637
404
|
/**
|
|
638
405
|
* Sets the `white-space` CSS property of the element.
|
|
639
406
|
*
|
|
@@ -643,48 +410,208 @@ type TypographyStyleProps = {
|
|
|
643
410
|
/**
|
|
644
411
|
* Sets the `word-wrap` CSS property of the element.
|
|
645
412
|
*
|
|
646
|
-
* Accepts a word-wrap token or a responsive array of word-wrap tokens.
|
|
413
|
+
* Accepts a word-wrap token or a responsive array of word-wrap tokens.
|
|
414
|
+
*/
|
|
415
|
+
$wordWrap?: ResponsiveValues<OakWordWrap>;
|
|
416
|
+
/**
|
|
417
|
+
* Sets the `text-overflow` CSS property of the element.
|
|
418
|
+
*
|
|
419
|
+
* Accepts a text-overflow token or a responsive array of text-overflow tokens.
|
|
420
|
+
*/
|
|
421
|
+
$textOverflow?: ResponsiveValues<OakTextOverflow>;
|
|
422
|
+
/**
|
|
423
|
+
* Sets the `overflow` CSS property of the element.
|
|
424
|
+
*
|
|
425
|
+
* Accepts an overflow token or a responsive array of overflow tokens.
|
|
426
|
+
*/
|
|
427
|
+
$overflow?: ResponsiveValues<CSSProperties$1["overflow"]>;
|
|
428
|
+
/**
|
|
429
|
+
* Sets the `text-wrap` CSS property of the element.
|
|
430
|
+
*
|
|
431
|
+
* Accepts a text-wrap token or a responsive array of text-wrap tokens.
|
|
432
|
+
*
|
|
433
|
+
* Controls how text inside an element is wrapped. The different values provide:
|
|
434
|
+
* - Typographic improvements, for example more balanced line lengths across broken headings
|
|
435
|
+
* - A way to turn text wrapping off completely
|
|
436
|
+
*/
|
|
437
|
+
$textWrap?: ResponsiveValues<CSSProperties$1["textWrap"]>;
|
|
438
|
+
};
|
|
439
|
+
|
|
440
|
+
declare const oakDropShadowTokens: {
|
|
441
|
+
"drop-shadow-standard": string;
|
|
442
|
+
"drop-shadow-lemon": string;
|
|
443
|
+
"drop-shadow-wide-lemon": string;
|
|
444
|
+
"drop-shadow-centered-lemon": string;
|
|
445
|
+
"drop-shadow-grey": string;
|
|
446
|
+
"drop-shadow-centered-grey": string;
|
|
447
|
+
"drop-shadow-black": string;
|
|
448
|
+
"drop-shadow-centred-standard": string;
|
|
449
|
+
"drop-shadow-none": string;
|
|
450
|
+
};
|
|
451
|
+
type OakDropShadowToken = keyof typeof oakDropShadowTokens;
|
|
452
|
+
|
|
453
|
+
type DropShadowStyleProps = {
|
|
454
|
+
/**
|
|
455
|
+
* Applies a drop-shadow to the element.
|
|
456
|
+
*
|
|
457
|
+
* Accepts a drop-shadow token or a responsive array of drop-shadow tokens.
|
|
458
|
+
*/
|
|
459
|
+
$dropShadow?: ResponsiveValues<OakDropShadowToken>;
|
|
460
|
+
};
|
|
461
|
+
|
|
462
|
+
declare const oakBorderWidthTokens: {
|
|
463
|
+
"border-solid-none": number;
|
|
464
|
+
"border-solid-s": number;
|
|
465
|
+
"border-solid-m": number;
|
|
466
|
+
"border-solid-l": number;
|
|
467
|
+
"border-solid-xl": number;
|
|
468
|
+
"border-solid-xxl": number;
|
|
469
|
+
"border-solid-xxxl": number;
|
|
470
|
+
"border-solid-xxxxl": number;
|
|
471
|
+
};
|
|
472
|
+
declare const oakBorderRadiusTokens: {
|
|
473
|
+
"border-radius-square": number;
|
|
474
|
+
"border-radius-xs": number;
|
|
475
|
+
"border-radius-s": number;
|
|
476
|
+
"border-radius-m": number;
|
|
477
|
+
"border-radius-m2": number;
|
|
478
|
+
"border-radius-l": number;
|
|
479
|
+
"border-radius-xl": number;
|
|
480
|
+
"border-radius-circle": number;
|
|
481
|
+
};
|
|
482
|
+
type OakBorderRadiusToken = keyof typeof oakBorderRadiusTokens;
|
|
483
|
+
type OakBorderWidthToken = keyof typeof oakBorderWidthTokens;
|
|
484
|
+
|
|
485
|
+
type BorderWidth = ResponsiveValues<OakBorderWidthToken>;
|
|
486
|
+
type _BorderStyleProps = ResponsiveValues<CSSProperties$1["borderStyle"]>;
|
|
487
|
+
type BorderColorProps = ResponsiveValues<OakUiRoleToken>;
|
|
488
|
+
type BorderRadiusProps = ResponsiveValues<OakBorderRadiusToken>;
|
|
489
|
+
type BorderStyleProps = {
|
|
490
|
+
/**
|
|
491
|
+
* Apply border on all sides
|
|
492
|
+
*
|
|
493
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
494
|
+
*/
|
|
495
|
+
$ba?: BorderWidth;
|
|
496
|
+
/**
|
|
497
|
+
* Apply border to the top
|
|
498
|
+
*
|
|
499
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
500
|
+
*/
|
|
501
|
+
$bt?: BorderWidth;
|
|
502
|
+
/**
|
|
503
|
+
* Apply border to the right
|
|
504
|
+
*
|
|
505
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
506
|
+
*/
|
|
507
|
+
$br?: BorderWidth;
|
|
508
|
+
/**
|
|
509
|
+
* Apply border to the bottom
|
|
510
|
+
*
|
|
511
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
512
|
+
*/
|
|
513
|
+
$bb?: BorderWidth;
|
|
514
|
+
/**
|
|
515
|
+
* Apply border to the left
|
|
516
|
+
*
|
|
517
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
518
|
+
*/
|
|
519
|
+
$bl?: BorderWidth;
|
|
520
|
+
/**
|
|
521
|
+
* Apply border to the left and right
|
|
522
|
+
*
|
|
523
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
524
|
+
*/
|
|
525
|
+
$bh?: BorderWidth;
|
|
526
|
+
/**
|
|
527
|
+
* Apply border to the top and bottom
|
|
528
|
+
*
|
|
529
|
+
* Accepts a border-width token or a responsive array of border-width tokens
|
|
530
|
+
*/
|
|
531
|
+
$bv?: BorderWidth;
|
|
532
|
+
/**
|
|
533
|
+
* Apply `border-style` to the element
|
|
534
|
+
*
|
|
535
|
+
* Accepts a single value or a responsive array of values.
|
|
536
|
+
*/
|
|
537
|
+
$borderStyle?: _BorderStyleProps;
|
|
538
|
+
/**
|
|
539
|
+
* Apply a border color to all sides of the element
|
|
540
|
+
*
|
|
541
|
+
* Accepts a UI role token or a responsive array of UI role tokens.
|
|
542
|
+
*/
|
|
543
|
+
$borderColor?: BorderColorProps;
|
|
544
|
+
$borderRadius?: BorderRadiusProps;
|
|
545
|
+
/**
|
|
546
|
+
* Apply border radius to the top left
|
|
547
|
+
*
|
|
548
|
+
* Accepts an `OakBorderRadiusToken` or a responsive array of `OakBorderRadiusToken`s.
|
|
549
|
+
*/
|
|
550
|
+
$btlr?: BorderRadiusProps;
|
|
551
|
+
/**
|
|
552
|
+
* Apply border radius to the top right
|
|
553
|
+
*
|
|
554
|
+
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
555
|
+
*/
|
|
556
|
+
$btrr?: BorderRadiusProps;
|
|
557
|
+
/**
|
|
558
|
+
* Apply border radius to the bottom left
|
|
559
|
+
*
|
|
560
|
+
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
647
561
|
*/
|
|
648
|
-
$
|
|
562
|
+
$bblr?: BorderRadiusProps;
|
|
649
563
|
/**
|
|
650
|
-
*
|
|
564
|
+
* Apply border radius to the bottom right
|
|
651
565
|
*
|
|
652
|
-
* Accepts a
|
|
566
|
+
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
653
567
|
*/
|
|
654
|
-
$
|
|
568
|
+
$bbrr?: BorderRadiusProps;
|
|
655
569
|
/**
|
|
656
|
-
*
|
|
570
|
+
* Apply border radius to the top right and top left
|
|
657
571
|
*
|
|
658
|
-
* Accepts
|
|
572
|
+
* Accepts a border-radius token or a responsive array of border-radius tokens.
|
|
659
573
|
*/
|
|
660
|
-
$
|
|
574
|
+
$btr?: BorderRadiusProps;
|
|
661
575
|
/**
|
|
662
|
-
*
|
|
663
|
-
*
|
|
664
|
-
* Accepts a text-wrap token or a responsive array of text-wrap tokens.
|
|
576
|
+
* Apply border radius to the bottom right and bottom left
|
|
665
577
|
*
|
|
666
|
-
*
|
|
667
|
-
* - Typographic improvements, for example more balanced line lengths across broken headings
|
|
668
|
-
* - A way to turn text wrapping off completely
|
|
578
|
+
* Accepts a border-radius token or a responsive array of border-radius tokens
|
|
669
579
|
*/
|
|
670
|
-
$
|
|
671
|
-
};
|
|
672
|
-
|
|
673
|
-
type ElementProp<C extends ElementType> = {
|
|
674
|
-
element?: C;
|
|
675
|
-
};
|
|
676
|
-
type PolymorphicPropsWithoutRef<C extends ElementType> = ElementProp<C> & ComponentPropsWithoutRef<C>;
|
|
677
|
-
type PolymorphicRef<C extends React.ElementType> = ComponentPropsWithRef<C>["ref"];
|
|
678
|
-
type PolymorphicPropsWithRef<C extends ElementType> = ElementProp<C> & ComponentPropsWithoutRef<C> & {
|
|
679
|
-
ref?: PolymorphicRef<C>;
|
|
580
|
+
$bbr?: BorderRadiusProps;
|
|
680
581
|
};
|
|
681
582
|
|
|
682
583
|
type StyledButtonProps = TypographyStyleProps & SpacingStyleProps & ColorStyleProps & DisplayStyleProps & BorderStyleProps & DropShadowStyleProps & {
|
|
683
584
|
isLoading?: boolean;
|
|
684
585
|
};
|
|
685
586
|
type InternalButtonProps = StyledButtonProps & {
|
|
686
|
-
onHovered?: (event:
|
|
587
|
+
onHovered?: (event: React$1.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;
|
|
588
|
+
};
|
|
589
|
+
|
|
590
|
+
declare const oakOpacityTokens: {
|
|
591
|
+
transparent: number;
|
|
592
|
+
"semi-transparent": number;
|
|
593
|
+
"semi-opaque": number;
|
|
594
|
+
opaque: number;
|
|
595
|
+
};
|
|
596
|
+
type OakOpacityToken = keyof typeof oakOpacityTokens;
|
|
597
|
+
|
|
598
|
+
declare const oakTransitionTokens: {
|
|
599
|
+
"standard-ease": string;
|
|
600
|
+
"standard-transform": string;
|
|
687
601
|
};
|
|
602
|
+
type OakTransitionToken = keyof typeof oakTransitionTokens;
|
|
603
|
+
|
|
604
|
+
declare const oakZIndexTokens: {
|
|
605
|
+
readonly behind: -1;
|
|
606
|
+
readonly neutral: 0;
|
|
607
|
+
readonly "in-front": 1;
|
|
608
|
+
readonly "mobile-filters": 2;
|
|
609
|
+
readonly "fixed-header": 100;
|
|
610
|
+
readonly "modal-close-button": 150;
|
|
611
|
+
readonly "modal-dialog": 300;
|
|
612
|
+
readonly banner: number;
|
|
613
|
+
};
|
|
614
|
+
type OakZIndexToken = keyof typeof oakZIndexTokens | null;
|
|
688
615
|
|
|
689
616
|
declare const oakDefaultTheme: OakTheme;
|
|
690
617
|
|
|
@@ -933,7 +860,7 @@ type PositionStyleProps = {
|
|
|
933
860
|
*
|
|
934
861
|
* Accepts a `position` value or a responsive array of `position` values. Can be nulled.
|
|
935
862
|
*/
|
|
936
|
-
$position?: ResponsiveValues<CSSProperties
|
|
863
|
+
$position?: ResponsiveValues<CSSProperties["position"]>;
|
|
937
864
|
/**
|
|
938
865
|
* Sets the `top` CSS property of the element.
|
|
939
866
|
*
|
|
@@ -978,49 +905,49 @@ type PositionStyleProps = {
|
|
|
978
905
|
*
|
|
979
906
|
* Accepts an `overflow` value or a responsive array of `overflow` values.
|
|
980
907
|
*/
|
|
981
|
-
$overflow?: ResponsiveValues<CSSProperties
|
|
908
|
+
$overflow?: ResponsiveValues<CSSProperties["overflow"]>;
|
|
982
909
|
/**
|
|
983
910
|
* Sets the `overflow-x` CSS property of the element.
|
|
984
911
|
*
|
|
985
912
|
* Accepts an `overflow-x` value or a responsive array of `overflow-x` values.
|
|
986
913
|
*/
|
|
987
|
-
$overflowX?: ResponsiveValues<CSSProperties
|
|
914
|
+
$overflowX?: ResponsiveValues<CSSProperties["overflowX"]>;
|
|
988
915
|
/**
|
|
989
916
|
* Sets the `overflow-y` CSS property of the element.
|
|
990
917
|
*
|
|
991
918
|
* Accepts an `overflow-y` value or a responsive array of `overflow-y` values.
|
|
992
919
|
*/
|
|
993
|
-
$overflowY?: ResponsiveValues<CSSProperties
|
|
920
|
+
$overflowY?: ResponsiveValues<CSSProperties["overflowY"]>;
|
|
994
921
|
/**
|
|
995
922
|
* Sets the `object-fit` CSS property of the element.
|
|
996
923
|
*
|
|
997
924
|
* Accepts an `object-fit` value or a responsive array of `object-fit` values.
|
|
998
925
|
*/
|
|
999
|
-
$objectFit?: ResponsiveValues<CSSProperties
|
|
926
|
+
$objectFit?: ResponsiveValues<CSSProperties["objectFit"]>;
|
|
1000
927
|
/**
|
|
1001
928
|
* Sets the `object-position` CSS property of the element.
|
|
1002
929
|
*
|
|
1003
930
|
* Accepts an `object-position` value or a responsive array of `object-position` values.
|
|
1004
931
|
*/
|
|
1005
|
-
$objectPosition?: ResponsiveValues<CSSProperties
|
|
932
|
+
$objectPosition?: ResponsiveValues<CSSProperties["objectPosition"]>;
|
|
1006
933
|
/**
|
|
1007
934
|
* Sets the `pointer-events` CSS property of the element.
|
|
1008
935
|
*
|
|
1009
936
|
* Accepts a `pointer-events` value or a responsive array of `pointer-events` values.
|
|
1010
937
|
*/
|
|
1011
|
-
$pointerEvents?: ResponsiveValues<CSSProperties
|
|
938
|
+
$pointerEvents?: ResponsiveValues<CSSProperties["pointerEvents"]>;
|
|
1012
939
|
/**
|
|
1013
940
|
* Sets the `visibility` CSS property of the element.
|
|
1014
941
|
*
|
|
1015
942
|
* Accepts a `visibility` value or a responsive array of `visibility` values.
|
|
1016
943
|
*/
|
|
1017
|
-
$visibility?: ResponsiveValues<CSSProperties
|
|
944
|
+
$visibility?: ResponsiveValues<CSSProperties["visibility"]>;
|
|
1018
945
|
/**
|
|
1019
946
|
* Sets the `vertical-align` CSS property of the element.
|
|
1020
947
|
*
|
|
1021
948
|
* Accepts a `vertical-align` value or a responsive array of `vertical-align` values.
|
|
1022
949
|
*/
|
|
1023
|
-
$verticalAlign?: ResponsiveValues<CSSProperties
|
|
950
|
+
$verticalAlign?: ResponsiveValues<CSSProperties["verticalAlign"]>;
|
|
1024
951
|
};
|
|
1025
952
|
|
|
1026
953
|
type SizeValues = ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
@@ -1066,13 +993,73 @@ type SizeStyleProps = {
|
|
|
1066
993
|
*
|
|
1067
994
|
* Accepts an `aspect-ratio` value or a responsive array of `aspect-ratio` values.
|
|
1068
995
|
*/
|
|
1069
|
-
$aspectRatio?: ResponsiveValues<CSSProperties["aspectRatio"]>;
|
|
996
|
+
$aspectRatio?: ResponsiveValues<CSSProperties$1["aspectRatio"]>;
|
|
1070
997
|
/**
|
|
1071
998
|
* Sets the `box-sizing` CSS property of the element.
|
|
1072
999
|
*
|
|
1073
1000
|
* Accepts a `box-sizing` value or a responsive array of `box-sizing` values.
|
|
1074
1001
|
*/
|
|
1075
|
-
$boxSizing?: ResponsiveValues<CSSProperties["boxSizing"]>;
|
|
1002
|
+
$boxSizing?: ResponsiveValues<CSSProperties$1["boxSizing"]>;
|
|
1003
|
+
};
|
|
1004
|
+
|
|
1005
|
+
type OpacityStyleProps = {
|
|
1006
|
+
/**
|
|
1007
|
+
* Sets the `opacity` CSS property of the element.
|
|
1008
|
+
*
|
|
1009
|
+
* Accepts an opacity token or a responsive array of opacity tokens.
|
|
1010
|
+
*/
|
|
1011
|
+
$opacity?: ResponsiveValues<OakOpacityToken>;
|
|
1012
|
+
};
|
|
1013
|
+
|
|
1014
|
+
type TransformStyleProps = {
|
|
1015
|
+
/**
|
|
1016
|
+
* Sets the `transform` CSS property of the element.
|
|
1017
|
+
*
|
|
1018
|
+
* Accepts a `transform` value or a responsive array of `transform` values. Can be nulled.
|
|
1019
|
+
*/
|
|
1020
|
+
$transform?: ResponsiveValues<CSSProperties$1["transform"] | null>;
|
|
1021
|
+
/**
|
|
1022
|
+
* Sets the `transform-origin` CSS property of the element.
|
|
1023
|
+
*
|
|
1024
|
+
* Accepts a `transform-origin` value or a responsive array of `transform-origin` values. Can be nulled.
|
|
1025
|
+
*/
|
|
1026
|
+
$transformOrigin?: ResponsiveValues<CSSProperties$1["transformOrigin"] | null>;
|
|
1027
|
+
};
|
|
1028
|
+
|
|
1029
|
+
type Transition = OakTransitionToken;
|
|
1030
|
+
type TransitionStyleProps = {
|
|
1031
|
+
/**
|
|
1032
|
+
* Sets the `transition` CSS property of the element.
|
|
1033
|
+
*
|
|
1034
|
+
* Accepts a transition token or a responsive array of transition tokens.
|
|
1035
|
+
*/
|
|
1036
|
+
$transition?: ResponsiveValues<Transition>;
|
|
1037
|
+
};
|
|
1038
|
+
|
|
1039
|
+
type ZIndexStyleProps = {
|
|
1040
|
+
/**
|
|
1041
|
+
* Sets the `z-index` CSS property of the element.
|
|
1042
|
+
*
|
|
1043
|
+
* Accepts a z-index token or a responsive array of z-index tokens.
|
|
1044
|
+
*/
|
|
1045
|
+
$zIndex?: ResponsiveValues<OakZIndexToken | number>;
|
|
1046
|
+
};
|
|
1047
|
+
|
|
1048
|
+
type ScrollMarginValue = OakAllSpacingToken | null | undefined;
|
|
1049
|
+
type ScrollMarginValues = ResponsiveValues<ScrollMarginValue>;
|
|
1050
|
+
type ScrollSnapStyleProps = {
|
|
1051
|
+
/**
|
|
1052
|
+
* Applies `scroll-margin-top` to the element
|
|
1053
|
+
*
|
|
1054
|
+
* Accepts any Oak spacing token or a responsive array of spacing tokens. Can be nulled.
|
|
1055
|
+
*/
|
|
1056
|
+
$scrollMarginTop?: ScrollMarginValues;
|
|
1057
|
+
/**
|
|
1058
|
+
* Applies `scroll-margin-left` to the element
|
|
1059
|
+
*
|
|
1060
|
+
* Accepts any Oak spacing token or a responsive array of spacing tokens. Can be nulled.
|
|
1061
|
+
*/
|
|
1062
|
+
$scrollMarginLeft?: ScrollMarginValues;
|
|
1076
1063
|
};
|
|
1077
1064
|
|
|
1078
1065
|
type HTMLProps$1 = {
|
|
@@ -1099,12 +1086,12 @@ declare const oakBoxCss: styled_components.FlattenInterpolation<styled_component
|
|
|
1099
1086
|
* - scroll-margin-top/left
|
|
1100
1087
|
*
|
|
1101
1088
|
*/
|
|
1102
|
-
declare const OakBox:
|
|
1089
|
+
declare const OakBox: any;
|
|
1103
1090
|
|
|
1104
1091
|
type HTMLProps = {
|
|
1105
1092
|
onClick?: MouseEventHandler;
|
|
1106
1093
|
};
|
|
1107
|
-
type OakImageProps<C extends ElementType = typeof
|
|
1094
|
+
type OakImageProps<C extends ElementType = typeof Image> = Omit<ImageProps$1, "placeholder"> & OakBoxProps & ColorFilterStyleProps & HTMLProps & {
|
|
1108
1095
|
as?: C;
|
|
1109
1096
|
/**
|
|
1110
1097
|
* The placeholder to use while the image is loading
|
|
@@ -1134,7 +1121,7 @@ declare const placeholderStyles: styled_components.FlattenInterpolation<styled_c
|
|
|
1134
1121
|
* sizes is exposed for further optimisation read Next docs for more info.
|
|
1135
1122
|
*
|
|
1136
1123
|
*/
|
|
1137
|
-
declare const OakImage: <C extends ElementType = typeof
|
|
1124
|
+
declare const OakImage: <C extends ElementType = typeof Image>({ ...props }: OakImageProps<C>) => React$1.JSX.Element;
|
|
1138
1125
|
|
|
1139
1126
|
declare const oakIconNames: IconName[];
|
|
1140
1127
|
type OakIconName = IconName;
|
|
@@ -1160,7 +1147,16 @@ declare function generateOakIconURL(iconName: string): string;
|
|
|
1160
1147
|
/**
|
|
1161
1148
|
* A wrapper around OakImage which uses the image-map.json file to map icon names to image paths.
|
|
1162
1149
|
*/
|
|
1163
|
-
declare const OakIcon: (props: OakIconProps) =>
|
|
1150
|
+
declare const OakIcon: (props: OakIconProps) => React$1.JSX.Element;
|
|
1151
|
+
|
|
1152
|
+
type ElementProp<C extends ElementType> = {
|
|
1153
|
+
element?: C;
|
|
1154
|
+
};
|
|
1155
|
+
type PolymorphicPropsWithoutRef<C extends ElementType> = ElementProp<C> & ComponentPropsWithoutRef<C>;
|
|
1156
|
+
type PolymorphicRef<C extends React.ElementType> = ComponentPropsWithRef<C>["ref"];
|
|
1157
|
+
type PolymorphicPropsWithRef<C extends ElementType> = ElementProp<C> & ComponentPropsWithoutRef<C> & {
|
|
1158
|
+
ref?: PolymorphicRef<C>;
|
|
1159
|
+
};
|
|
1164
1160
|
|
|
1165
1161
|
type FlexStyleProps = DisplayStyleProps & {
|
|
1166
1162
|
/**
|
|
@@ -1168,55 +1164,55 @@ type FlexStyleProps = DisplayStyleProps & {
|
|
|
1168
1164
|
*
|
|
1169
1165
|
* Accepts a `flex-direction` value or a responsive array of flex-direction values.
|
|
1170
1166
|
*/
|
|
1171
|
-
$flexDirection?: ResponsiveValues<CSSProperties
|
|
1167
|
+
$flexDirection?: ResponsiveValues<CSSProperties["flexDirection"]>;
|
|
1172
1168
|
/**
|
|
1173
1169
|
* Sets the `flex-wrap` CSS property of the element.
|
|
1174
1170
|
*
|
|
1175
1171
|
* Accepts a `flex-wrap` value or a responsive array of flex-wrap values.
|
|
1176
1172
|
*/
|
|
1177
|
-
$flexWrap?: ResponsiveValues<CSSProperties
|
|
1173
|
+
$flexWrap?: ResponsiveValues<CSSProperties["flexWrap"]>;
|
|
1178
1174
|
/**
|
|
1179
1175
|
* Sets the `align-items` CSS property of the element.
|
|
1180
1176
|
*
|
|
1181
1177
|
* Accepts an `align-items` value or a responsive array of `align-items` values.
|
|
1182
1178
|
*/
|
|
1183
|
-
$alignItems?: ResponsiveValues<CSSProperties
|
|
1179
|
+
$alignItems?: ResponsiveValues<CSSProperties["alignItems"]>;
|
|
1184
1180
|
/**
|
|
1185
1181
|
* Sets the `align-content` CSS property of the element.
|
|
1186
1182
|
*
|
|
1187
1183
|
* Accepts an `align-content` value or a responsive array of `align-content` values.
|
|
1188
1184
|
*/
|
|
1189
|
-
$alignContent?: ResponsiveValues<CSSProperties
|
|
1185
|
+
$alignContent?: ResponsiveValues<CSSProperties["alignContent"]>;
|
|
1190
1186
|
/**
|
|
1191
1187
|
* Sets the `justify-content` CSS property of the element.
|
|
1192
1188
|
*
|
|
1193
1189
|
* Accepts a `justify-content` value or a responsive array of `justify-content` values.
|
|
1194
1190
|
*/
|
|
1195
|
-
$justifyContent?: ResponsiveValues<CSSProperties
|
|
1191
|
+
$justifyContent?: ResponsiveValues<CSSProperties["justifyContent"]>;
|
|
1196
1192
|
/**
|
|
1197
1193
|
* Sets the `align-self` CSS property of the element.
|
|
1198
1194
|
*
|
|
1199
1195
|
* Accepts an `align-self` value or a responsive array of `align-self` values.
|
|
1200
1196
|
*/
|
|
1201
|
-
$alignSelf?: ResponsiveValues<CSSProperties
|
|
1197
|
+
$alignSelf?: ResponsiveValues<CSSProperties["alignSelf"]>;
|
|
1202
1198
|
/**
|
|
1203
1199
|
* Sets the `flex-grow` CSS property of the element.
|
|
1204
1200
|
*
|
|
1205
1201
|
* Accepts a `flex-grow` value or a responsive array of `flex-grow` values.
|
|
1206
1202
|
*/
|
|
1207
|
-
$flexGrow?: ResponsiveValues<CSSProperties
|
|
1203
|
+
$flexGrow?: ResponsiveValues<CSSProperties["flexGrow"]>;
|
|
1208
1204
|
/**
|
|
1209
1205
|
* Sets the `flex-shrink` CSS property of the element.
|
|
1210
1206
|
*
|
|
1211
1207
|
* Accepts a `flex-shrink` value or a responsive array of `flex-shrink` values.
|
|
1212
1208
|
*/
|
|
1213
|
-
$flexShrink?: ResponsiveValues<CSSProperties
|
|
1209
|
+
$flexShrink?: ResponsiveValues<CSSProperties["flexShrink"]>;
|
|
1214
1210
|
/**
|
|
1215
1211
|
* Sets the `order` CSS property of the element.
|
|
1216
1212
|
*
|
|
1217
1213
|
* Accepts an `order` value or a responsive array of `order` values.
|
|
1218
1214
|
*/
|
|
1219
|
-
$order?: ResponsiveValues<CSSProperties
|
|
1215
|
+
$order?: ResponsiveValues<CSSProperties["order"]>;
|
|
1220
1216
|
/**
|
|
1221
1217
|
* Sets the `flex-basis` CSS property of the element.
|
|
1222
1218
|
*
|
|
@@ -1251,7 +1247,7 @@ type InternalShadowRectButtonProps = Omit<InternalButtonProps, "$pa" | "$ph" | "
|
|
|
1251
1247
|
/**
|
|
1252
1248
|
* we can set a custom icon if we want different sizes and padding
|
|
1253
1249
|
*/
|
|
1254
|
-
iconOverride?:
|
|
1250
|
+
iconOverride?: React$1.ReactNode;
|
|
1255
1251
|
isTrailingIcon?: boolean;
|
|
1256
1252
|
/**
|
|
1257
1253
|
* we can arrange the icon vertically or horizontally
|
|
@@ -1301,18 +1297,18 @@ type OakSecondaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorde
|
|
|
1301
1297
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1302
1298
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1303
1299
|
*/
|
|
1304
|
-
declare const OakSecondaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSecondaryButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1300
|
+
declare const OakSecondaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSecondaryButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1305
1301
|
|
|
1306
|
-
type ButtonComponent = <C extends
|
|
1302
|
+
type ButtonComponent = <C extends React$1.ElementType = "button">({ element, ...rest }: OakSecondaryButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1307
1303
|
type OakButtonWithDropdownProps = {
|
|
1308
1304
|
primaryActionText: string;
|
|
1309
1305
|
primaryActionIcon?: OakIconName;
|
|
1310
1306
|
onPrimaryAction?: () => void;
|
|
1311
|
-
children?:
|
|
1307
|
+
children?: React$1.ReactNode;
|
|
1312
1308
|
isLoading?: boolean;
|
|
1313
1309
|
disabled?: boolean;
|
|
1314
1310
|
ariaLabel?: string;
|
|
1315
|
-
leadingButtonIcon?:
|
|
1311
|
+
leadingButtonIcon?: React$1.ReactNode;
|
|
1316
1312
|
ariaDescription?: string;
|
|
1317
1313
|
"data-testid"?: string;
|
|
1318
1314
|
buttonComponent: ButtonComponent;
|
|
@@ -1325,11 +1321,11 @@ type OakButtonWithDropdownProps = {
|
|
|
1325
1321
|
* Accepts the button component as a prop to eliminate code duplication.
|
|
1326
1322
|
*/
|
|
1327
1323
|
declare const OakButtonWithDropdown: {
|
|
1328
|
-
({ primaryActionText, primaryActionIcon, onPrimaryAction, children, isLoading, disabled, ariaLabel, ariaDescription, leadingButtonIcon, "data-testid": dataTestId, buttonComponent: ButtonComponent, dropdownTopSpacing, flexWidth, closeOnChange, }: OakButtonWithDropdownProps):
|
|
1329
|
-
Divider():
|
|
1324
|
+
({ primaryActionText, primaryActionIcon, onPrimaryAction, children, isLoading, disabled, ariaLabel, ariaDescription, leadingButtonIcon, "data-testid": dataTestId, buttonComponent: ButtonComponent, dropdownTopSpacing, flexWidth, closeOnChange, }: OakButtonWithDropdownProps): React$1.JSX.Element;
|
|
1325
|
+
Divider(): React$1.ReactElement;
|
|
1330
1326
|
Item<C extends ElementType = "button">({ children, element, ...rest }: {
|
|
1331
|
-
children:
|
|
1332
|
-
} & OakSecondaryButtonProps & PolymorphicPropsWithoutRef<C>):
|
|
1327
|
+
children: React$1.ReactNode;
|
|
1328
|
+
} & OakSecondaryButtonProps & PolymorphicPropsWithoutRef<C>): React$1.ReactElement;
|
|
1333
1329
|
};
|
|
1334
1330
|
|
|
1335
1331
|
type OakCloseButtonProps = {
|
|
@@ -1343,7 +1339,7 @@ type OakCloseButtonProps = {
|
|
|
1343
1339
|
*
|
|
1344
1340
|
*
|
|
1345
1341
|
*/
|
|
1346
|
-
declare function OakCloseButton({ onClose, ...rest }: Readonly<OakCloseButtonProps>):
|
|
1342
|
+
declare function OakCloseButton({ onClose, ...rest }: Readonly<OakCloseButtonProps>): React$1.JSX.Element;
|
|
1347
1343
|
|
|
1348
1344
|
type OakPrimaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor">;
|
|
1349
1345
|
/**
|
|
@@ -1359,7 +1355,7 @@ type OakPrimaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderC
|
|
|
1359
1355
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1360
1356
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1361
1357
|
*/
|
|
1362
|
-
declare const OakPrimaryButton: <C extends ElementType = "button">({ element, ...rest }: OakPrimaryButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1358
|
+
declare const OakPrimaryButton: <C extends ElementType = "button">({ element, ...rest }: OakPrimaryButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1363
1359
|
|
|
1364
1360
|
type OakPrimaryInvertedButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor">;
|
|
1365
1361
|
/**
|
|
@@ -1375,17 +1371,17 @@ type OakPrimaryInvertedButtonProps = Omit<InternalShadowRectButtonProps, "defaul
|
|
|
1375
1371
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1376
1372
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1377
1373
|
*/
|
|
1378
|
-
declare const OakPrimaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1374
|
+
declare const OakPrimaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1379
1375
|
|
|
1380
1376
|
type OakSecondaryButtonWithDropdownProps = {
|
|
1381
1377
|
primaryActionText: string;
|
|
1382
1378
|
primaryActionIcon?: OakIconName;
|
|
1383
1379
|
onPrimaryAction?: () => void;
|
|
1384
|
-
children?:
|
|
1380
|
+
children?: React$1.ReactNode;
|
|
1385
1381
|
isLoading?: boolean;
|
|
1386
1382
|
disabled?: boolean;
|
|
1387
1383
|
ariaLabel?: string;
|
|
1388
|
-
leadingButtonIcon?:
|
|
1384
|
+
leadingButtonIcon?: React$1.ReactNode;
|
|
1389
1385
|
ariaDescription?: string;
|
|
1390
1386
|
"data-testid"?: string;
|
|
1391
1387
|
};
|
|
@@ -1394,11 +1390,11 @@ type OakSecondaryButtonWithDropdownProps = {
|
|
|
1394
1390
|
*
|
|
1395
1391
|
*/
|
|
1396
1392
|
declare const OakSecondaryButtonWithDropdown: {
|
|
1397
|
-
(props: OakSecondaryButtonWithDropdownProps):
|
|
1398
|
-
Divider():
|
|
1393
|
+
(props: OakSecondaryButtonWithDropdownProps): React$1.JSX.Element;
|
|
1394
|
+
Divider(): React$1.ReactElement;
|
|
1399
1395
|
Item<C extends ElementType = "button">({ children, element, ...rest }: {
|
|
1400
|
-
children:
|
|
1401
|
-
} & OakPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>):
|
|
1396
|
+
children: React$1.ReactNode;
|
|
1397
|
+
} & OakPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>): React$1.ReactElement;
|
|
1402
1398
|
};
|
|
1403
1399
|
|
|
1404
1400
|
type OakSmallPrimaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font">;
|
|
@@ -1415,7 +1411,7 @@ type OakSmallPrimaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBo
|
|
|
1415
1411
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1416
1412
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1417
1413
|
*/
|
|
1418
|
-
declare const OakSmallPrimaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallPrimaryButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1414
|
+
declare const OakSmallPrimaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallPrimaryButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1419
1415
|
|
|
1420
1416
|
type OakSmallPrimaryInvertedButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor">;
|
|
1421
1417
|
/**
|
|
@@ -1431,7 +1427,7 @@ type OakSmallPrimaryInvertedButtonProps = Omit<InternalShadowRectButtonProps, "d
|
|
|
1431
1427
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1432
1428
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1433
1429
|
*/
|
|
1434
|
-
declare const OakSmallPrimaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1430
|
+
declare const OakSmallPrimaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1435
1431
|
|
|
1436
1432
|
type OakSmallSecondaryButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font">;
|
|
1437
1433
|
/**
|
|
@@ -1447,7 +1443,7 @@ type OakSmallSecondaryButtonProps = Omit<InternalShadowRectButtonProps, "default
|
|
|
1447
1443
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1448
1444
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1449
1445
|
*/
|
|
1450
|
-
declare const OakSmallSecondaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallSecondaryButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1446
|
+
declare const OakSmallSecondaryButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallSecondaryButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1451
1447
|
|
|
1452
1448
|
declare const oakAllApectRatiosConst: readonly ["7:8", "2:3", "1:1", "3:2", "16:9"];
|
|
1453
1449
|
type OakAllApectRatios = (typeof oakAllApectRatiosConst)[number];
|
|
@@ -1456,7 +1452,7 @@ type OakAspectRatioOuterProps = {
|
|
|
1456
1452
|
ratio: OakAspectRatioValues;
|
|
1457
1453
|
};
|
|
1458
1454
|
type OakAspectRatioProps = {
|
|
1459
|
-
children?:
|
|
1455
|
+
children?: React$1.ReactNode;
|
|
1460
1456
|
} & OakAspectRatioOuterProps;
|
|
1461
1457
|
/**
|
|
1462
1458
|
*
|
|
@@ -1480,16 +1476,16 @@ declare const OakAspectRatio: FC<OakAspectRatioProps>;
|
|
|
1480
1476
|
* Should be used only in cases where OakIcon can't be used and if this list grows much bigger in the future we should consider refactoring
|
|
1481
1477
|
*/
|
|
1482
1478
|
declare const svgMap: {
|
|
1483
|
-
"header-underline": () =>
|
|
1484
|
-
underline: () =>
|
|
1485
|
-
"horizontal-rule": () =>
|
|
1486
|
-
"underline-3": () =>
|
|
1487
|
-
"button-border-top": () =>
|
|
1488
|
-
"button-border-bottom": () =>
|
|
1489
|
-
"button-border-left": () =>
|
|
1490
|
-
"button-border-right": () =>
|
|
1491
|
-
"icon-background": () =>
|
|
1492
|
-
scribble: () =>
|
|
1479
|
+
"header-underline": () => React$1.JSX.Element;
|
|
1480
|
+
underline: () => React$1.JSX.Element;
|
|
1481
|
+
"horizontal-rule": () => React$1.JSX.Element;
|
|
1482
|
+
"underline-3": () => React$1.JSX.Element;
|
|
1483
|
+
"button-border-top": () => React$1.JSX.Element;
|
|
1484
|
+
"button-border-bottom": () => React$1.JSX.Element;
|
|
1485
|
+
"button-border-left": () => React$1.JSX.Element;
|
|
1486
|
+
"button-border-right": () => React$1.JSX.Element;
|
|
1487
|
+
"icon-background": () => React$1.JSX.Element;
|
|
1488
|
+
scribble: () => React$1.JSX.Element;
|
|
1493
1489
|
};
|
|
1494
1490
|
type OakSvgNames = keyof typeof svgMap;
|
|
1495
1491
|
type OakSvgProps = OakBoxProps & {
|
|
@@ -1517,17 +1513,17 @@ type OakRoundIconProps = IconProps | ImageProps;
|
|
|
1517
1513
|
* A wrapper around `OakIcon` which applies a rounded background.
|
|
1518
1514
|
* Supports either an icon name or an image src
|
|
1519
1515
|
*/
|
|
1520
|
-
declare const OakRoundIcon: ({ $background, $borderRadius, $width, $height, $pa, className, ...rest }: OakRoundIconProps) =>
|
|
1516
|
+
declare const OakRoundIcon: ({ $background, $borderRadius, $width, $height, $pa, className, ...rest }: OakRoundIconProps) => React$1.JSX.Element;
|
|
1521
1517
|
|
|
1522
1518
|
type OakSmallSecondaryButtonWithDropdownProps = {
|
|
1523
1519
|
primaryActionText: string;
|
|
1524
1520
|
primaryActionIcon?: OakIconName;
|
|
1525
1521
|
onPrimaryAction?: () => void;
|
|
1526
|
-
children?:
|
|
1522
|
+
children?: React$1.ReactNode;
|
|
1527
1523
|
isLoading?: boolean;
|
|
1528
1524
|
disabled?: boolean;
|
|
1529
1525
|
ariaLabel?: string;
|
|
1530
|
-
leadingButtonIcon?:
|
|
1526
|
+
leadingButtonIcon?: React$1.ReactNode;
|
|
1531
1527
|
ariaDescription?: string;
|
|
1532
1528
|
"data-testid"?: string;
|
|
1533
1529
|
};
|
|
@@ -1536,11 +1532,11 @@ type OakSmallSecondaryButtonWithDropdownProps = {
|
|
|
1536
1532
|
*
|
|
1537
1533
|
*/
|
|
1538
1534
|
declare const OakSmallSecondaryButtonWithDropdown: {
|
|
1539
|
-
(props: OakSmallSecondaryButtonWithDropdownProps):
|
|
1540
|
-
Divider():
|
|
1535
|
+
(props: OakSmallSecondaryButtonWithDropdownProps): React$1.JSX.Element;
|
|
1536
|
+
Divider(): React$1.ReactElement;
|
|
1541
1537
|
Item<C extends ElementType = "button">({ children, element, ...rest }: {
|
|
1542
|
-
children:
|
|
1543
|
-
} & OakSmallPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>):
|
|
1538
|
+
children: React$1.ReactNode;
|
|
1539
|
+
} & OakSmallPrimaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>): React$1.ReactElement;
|
|
1544
1540
|
};
|
|
1545
1541
|
|
|
1546
1542
|
type OakSmallSecondaryToggleButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font"> & {
|
|
@@ -1561,7 +1557,7 @@ type OakSmallSecondaryToggleButtonProps = Omit<InternalShadowRectButtonProps, "d
|
|
|
1561
1557
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1562
1558
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1563
1559
|
*/
|
|
1564
|
-
declare const OakSmallSecondaryToggleButton: <C extends ElementType = "button">({ element, toggleOn, ...rest }: OakSmallSecondaryToggleButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1560
|
+
declare const OakSmallSecondaryToggleButton: <C extends ElementType = "button">({ element, toggleOn, ...rest }: OakSmallSecondaryToggleButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1565
1561
|
|
|
1566
1562
|
type InternalShadowIconButtonProps = Omit<InternalButtonProps, "$pa" | "$ph" | "$pv" | "$ba" | "$borderRadius" | "$borderColor" | "$background" | "$color"> & {
|
|
1567
1563
|
iconName?: OakIconName;
|
|
@@ -1590,7 +1586,7 @@ type OakSmallTertiaryInvertedButtonProps = Omit<InternalShadowIconButtonProps, "
|
|
|
1590
1586
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1591
1587
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1592
1588
|
*/
|
|
1593
|
-
declare const OakSmallTertiaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallTertiaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1589
|
+
declare const OakSmallTertiaryInvertedButton: <C extends ElementType = "button">({ element, ...rest }: OakSmallTertiaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1594
1590
|
|
|
1595
1591
|
type InternalShadowRoundButtonProps = Omit<InternalButtonProps, "$pa" | "$ph" | "$pv" | "$ba" | "$borderRadius" | "$borderColor" | "$background" | "$color"> & {
|
|
1596
1592
|
iconName?: OakIconName;
|
|
@@ -1626,7 +1622,7 @@ type InternalShadowRoundButtonProps = Omit<InternalButtonProps, "$pa" | "$ph" |
|
|
|
1626
1622
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
1627
1623
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1628
1624
|
*/
|
|
1629
|
-
declare const InternalShadowRoundButton: <C extends ElementType = "button">(props: InternalShadowRoundButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1625
|
+
declare const InternalShadowRoundButton: <C extends ElementType = "button">(props: InternalShadowRoundButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1630
1626
|
|
|
1631
1627
|
type OakTertiaryButtonProps = InternalButtonProps & {
|
|
1632
1628
|
iconBackground?: OakRoundIconProps["$background"];
|
|
@@ -1638,7 +1634,7 @@ type OakTertiaryButtonProps = InternalButtonProps & {
|
|
|
1638
1634
|
* An implementation of InternalShadowRoundButton, its a subtle button with no border and a round icon.
|
|
1639
1635
|
*
|
|
1640
1636
|
*/
|
|
1641
|
-
declare const OakTertiaryButton: <C extends ElementType = "button">({ element, isTrailingIcon, iconName, children, ...props }: OakTertiaryButtonProps & Partial<InternalShadowRoundButtonProps> & PolymorphicPropsWithoutRef<C>) =>
|
|
1637
|
+
declare const OakTertiaryButton: <C extends ElementType = "button">({ element, isTrailingIcon, iconName, children, ...props }: OakTertiaryButtonProps & Partial<InternalShadowRoundButtonProps> & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1642
1638
|
|
|
1643
1639
|
type OakTertiaryInvertedButtonProps = InternalButtonProps & {
|
|
1644
1640
|
iconBackground?: OakRoundIconProps["$background"];
|
|
@@ -1650,7 +1646,7 @@ type OakTertiaryInvertedButtonProps = InternalButtonProps & {
|
|
|
1650
1646
|
* An implementation of InternalShadowRoundButton, its a subtle button with no border and a round icon.
|
|
1651
1647
|
*
|
|
1652
1648
|
*/
|
|
1653
|
-
declare const OakTertiaryInvertedButton: <C extends ElementType = "button">({ element, isTrailingIcon, iconName, children, ...props }: OakTertiaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1649
|
+
declare const OakTertiaryInvertedButton: <C extends ElementType = "button">({ element, isTrailingIcon, iconName, children, ...props }: OakTertiaryInvertedButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1654
1650
|
|
|
1655
1651
|
type OakLeftAlignedButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor"> & {
|
|
1656
1652
|
/**
|
|
@@ -1671,7 +1667,7 @@ type OakLeftAlignedButtonProps = Omit<InternalShadowRectButtonProps, "defaultBor
|
|
|
1671
1667
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`
|
|
1672
1668
|
* called after a mouseEnter and mouseLeave event has happened
|
|
1673
1669
|
*/
|
|
1674
|
-
declare const OakLeftAlignedButton: <C extends ElementType = "button">(props: OakLeftAlignedButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
1670
|
+
declare const OakLeftAlignedButton: <C extends ElementType = "button">(props: OakLeftAlignedButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
1675
1671
|
|
|
1676
1672
|
type OakCookieBannerProps = {
|
|
1677
1673
|
/**
|
|
@@ -1723,7 +1719,7 @@ type OakCookieBannerProps = {
|
|
|
1723
1719
|
/**
|
|
1724
1720
|
* A banner presenting the user with options to accept or reject cookies.
|
|
1725
1721
|
*/
|
|
1726
|
-
declare const OakCookieBanner: ({ state, innerMaxWidth, onOpenSettings, onHide, onAccept, onReject, isFixed, zIndex, }: OakCookieBannerProps) =>
|
|
1722
|
+
declare const OakCookieBanner: ({ state, innerMaxWidth, onOpenSettings, onHide, onAccept, onReject, isFixed, zIndex, }: OakCookieBannerProps) => React$1.JSX.Element;
|
|
1727
1723
|
|
|
1728
1724
|
type CookieConsentReducerState = {
|
|
1729
1725
|
isSettingsModalOpen: boolean;
|
|
@@ -1825,7 +1821,7 @@ type OakCookieConsentContextType = {
|
|
|
1825
1821
|
bannerState: CookieConsentReducerState["bannerState"];
|
|
1826
1822
|
};
|
|
1827
1823
|
declare function getDefaultContextState(): OakCookieConsentContextType;
|
|
1828
|
-
declare const OakCookieConsentContext:
|
|
1824
|
+
declare const OakCookieConsentContext: React$1.Context<OakCookieConsentContextType>;
|
|
1829
1825
|
type OakCookieConsentProviderProps = Pick<OakCookieConsentContextType, "policyConsents"> & {
|
|
1830
1826
|
children: ReactNode;
|
|
1831
1827
|
/**
|
|
@@ -1846,9 +1842,9 @@ declare function useCookieConsent(): {
|
|
|
1846
1842
|
*
|
|
1847
1843
|
* Intended to be used with `OakCookieConsent`
|
|
1848
1844
|
*/
|
|
1849
|
-
declare const OakCookieConsentProvider: ({ children, policyConsents, onConsentChange, }: OakCookieConsentProviderProps) =>
|
|
1845
|
+
declare const OakCookieConsentProvider: ({ children, policyConsents, onConsentChange, }: OakCookieConsentProviderProps) => React$1.JSX.Element;
|
|
1850
1846
|
|
|
1851
|
-
declare const OakInformativeModalBorderColor:
|
|
1847
|
+
declare const OakInformativeModalBorderColor: React$1.Context<("transparent" | "text-primary" | "text-subdued" | "text-error" | "text-disabled" | "text-link-active" | "text-link-hover" | "text-link-visited" | "text-link-pressed" | "text-inverted" | "text-success" | "text-promo" | "bg-primary" | "bg-inverted" | "bg-inverted-semi-transparent" | "bg-neutral" | "bg-neutral-stronger" | "bg-btn-primary" | "bg-btn-primary-hover" | "bg-btn-primary-disabled" | "bg-btn-secondary" | "bg-btn-secondary-hover" | "bg-btn-secondary-disabled" | "bg-decorative1-main" | "bg-decorative1-subdued" | "bg-decorative1-very-subdued" | "bg-decorative2-main" | "bg-decorative2-subdued" | "bg-decorative2-very-subdued" | "bg-decorative3-main" | "bg-decorative3-subdued" | "bg-decorative3-very-subdued" | "bg-decorative4-main" | "bg-decorative4-subdued" | "bg-decorative4-very-subdued" | "bg-decorative5-main" | "bg-decorative5-subdued" | "bg-decorative5-very-subdued" | "bg-decorative6-main" | "bg-decorative6-subdued" | "bg-decorative6-very-subdued" | "bg-interactive-element1" | "bg-interactive-element2" | "bg-correct" | "bg-incorrect" | "bg-success" | "bg-error" | "icon-inverted" | "icon-disabled" | "icon-brand" | "icon-success" | "icon-error" | "icon-warning" | "icon-primary" | "icon-subdued" | "icon-link-active" | "icon-link-hover" | "icon-link-pressed" | "icon-link-visited" | "icon-decorative1" | "icon-decorative2" | "icon-decorative3" | "icon-decorative4" | "icon-decorative5" | "icon-decorative6" | "icon-promo" | "border-primary" | "border-inverted" | "border-neutral" | "border-neutral-lighter" | "border-neutral-stronger" | "border-brand" | "border-success" | "border-error" | "border-warning" | "border-decorative1" | "border-decorative1-stronger" | "border-decorative2" | "border-decorative2-stronger" | "border-decorative3" | "border-decorative3-stronger" | "border-decorative4" | "border-decorative4-stronger" | "border-decorative5" | "border-decorative5-stronger" | "border-decorative6" | "border-decorative6-stronger" | "code-blue" | "code-green" | "code-grey" | "code-pink" | ("transparent" | "text-primary" | "text-subdued" | "text-error" | "text-disabled" | "text-link-active" | "text-link-hover" | "text-link-visited" | "text-link-pressed" | "text-inverted" | "text-success" | "text-promo" | "bg-primary" | "bg-inverted" | "bg-inverted-semi-transparent" | "bg-neutral" | "bg-neutral-stronger" | "bg-btn-primary" | "bg-btn-primary-hover" | "bg-btn-primary-disabled" | "bg-btn-secondary" | "bg-btn-secondary-hover" | "bg-btn-secondary-disabled" | "bg-decorative1-main" | "bg-decorative1-subdued" | "bg-decorative1-very-subdued" | "bg-decorative2-main" | "bg-decorative2-subdued" | "bg-decorative2-very-subdued" | "bg-decorative3-main" | "bg-decorative3-subdued" | "bg-decorative3-very-subdued" | "bg-decorative4-main" | "bg-decorative4-subdued" | "bg-decorative4-very-subdued" | "bg-decorative5-main" | "bg-decorative5-subdued" | "bg-decorative5-very-subdued" | "bg-decorative6-main" | "bg-decorative6-subdued" | "bg-decorative6-very-subdued" | "bg-interactive-element1" | "bg-interactive-element2" | "bg-correct" | "bg-incorrect" | "bg-success" | "bg-error" | "icon-inverted" | "icon-disabled" | "icon-brand" | "icon-success" | "icon-error" | "icon-warning" | "icon-primary" | "icon-subdued" | "icon-link-active" | "icon-link-hover" | "icon-link-pressed" | "icon-link-visited" | "icon-decorative1" | "icon-decorative2" | "icon-decorative3" | "icon-decorative4" | "icon-decorative5" | "icon-decorative6" | "icon-promo" | "border-primary" | "border-inverted" | "border-neutral" | "border-neutral-lighter" | "border-neutral-stronger" | "border-brand" | "border-success" | "border-error" | "border-warning" | "border-decorative1" | "border-decorative1-stronger" | "border-decorative2" | "border-decorative2-stronger" | "border-decorative3" | "border-decorative3-stronger" | "border-decorative4" | "border-decorative4-stronger" | "border-decorative5" | "border-decorative5-stronger" | "border-decorative6" | "border-decorative6-stronger" | "code-blue" | "code-green" | "code-grey" | "code-pink" | null)[] | null) | undefined>;
|
|
1852
1848
|
type OakInformativeModalCloseAction = "close_button" | undefined;
|
|
1853
1849
|
type OakInformativeModalProps = {
|
|
1854
1850
|
/**
|
|
@@ -1902,7 +1898,7 @@ type OakInformativeModalProps = {
|
|
|
1902
1898
|
/**
|
|
1903
1899
|
* Modal dialog with trapped focus and a close button. See the [design specification](https://www.figma.com/design/YcWQMMhHPVVmc47cHHEEAl/Oak-Design-Kit?node-id=15135-2063)
|
|
1904
1900
|
*/
|
|
1905
|
-
declare const OakInformativeModal: ({ children, footerSlot, domContainer, isOpen, onClose, zIndex, isLeftHandSide, closeOnBackgroundClick, largeScreenMaxWidth, ...rest }: OakInformativeModalProps) =>
|
|
1901
|
+
declare const OakInformativeModal: ({ children, footerSlot, domContainer, isOpen, onClose, zIndex, isLeftHandSide, closeOnBackgroundClick, largeScreenMaxWidth, ...rest }: OakInformativeModalProps) => React$1.ReactPortal | null;
|
|
1906
1902
|
|
|
1907
1903
|
type OakInformativeModalBodyProps = {
|
|
1908
1904
|
children: ReactNode;
|
|
@@ -1912,7 +1908,7 @@ type OakInformativeModalBodyProps = {
|
|
|
1912
1908
|
* it applies some padding and margin to ensure that the contents
|
|
1913
1909
|
* line up with the modal's header and footer
|
|
1914
1910
|
*/
|
|
1915
|
-
declare const OakInformativeModalBody: (props: OakInformativeModalBodyProps) =>
|
|
1911
|
+
declare const OakInformativeModalBody: (props: OakInformativeModalBodyProps) => React$1.JSX.Element;
|
|
1916
1912
|
|
|
1917
1913
|
type OakInformativeModalFooterProps = {
|
|
1918
1914
|
children: ReactNode;
|
|
@@ -1922,7 +1918,7 @@ type OakInformativeModalFooterProps = {
|
|
|
1922
1918
|
* it is ideal as a container for one or more buttons.
|
|
1923
1919
|
* It switches from a horizontal to vertical layout on smaller screens
|
|
1924
1920
|
*/
|
|
1925
|
-
declare const OakInformativeModalFooter: (props: OakInformativeModalFooterProps) =>
|
|
1921
|
+
declare const OakInformativeModalFooter: (props: OakInformativeModalFooterProps) => React$1.JSX.Element;
|
|
1926
1922
|
|
|
1927
1923
|
type OakCookieSettingsModalProps = Pick<OakInformativeModalProps, "isOpen" | "onClose" | "zIndex"> & {
|
|
1928
1924
|
/**
|
|
@@ -1950,7 +1946,7 @@ type OakCookieSettingsModalProps = Pick<OakInformativeModalProps, "isOpen" | "on
|
|
|
1950
1946
|
/**
|
|
1951
1947
|
* Modal for managing cookie consent settings.
|
|
1952
1948
|
*/
|
|
1953
|
-
declare const OakCookieSettingsModal: ({ isOpen, onClose, onReject, onConfirm, onAccept, policyURL, policyConsents, zIndex, }: OakCookieSettingsModalProps) =>
|
|
1949
|
+
declare const OakCookieSettingsModal: ({ isOpen, onClose, onReject, onConfirm, onAccept, policyURL, policyConsents, zIndex, }: OakCookieSettingsModalProps) => React$1.JSX.Element;
|
|
1954
1950
|
|
|
1955
1951
|
type OakCookieConsentProps = Pick<OakCookieSettingsModalProps, "policyURL"> & Pick<OakCookieBannerProps, "isFixed" | "innerMaxWidth"> & {
|
|
1956
1952
|
/**
|
|
@@ -1964,14 +1960,14 @@ type OakCookieConsentProps = Pick<OakCookieSettingsModalProps, "policyURL"> & Pi
|
|
|
1964
1960
|
/**
|
|
1965
1961
|
* Connects `OakCookieBanner` and `OakCookieSettingsModal` to `OakCookieConsentProvider`.
|
|
1966
1962
|
*/
|
|
1967
|
-
declare const OakCookieConsent: ({ policyURL, isFixed, innerMaxWidth, zIndex, }: OakCookieConsentProps) =>
|
|
1963
|
+
declare const OakCookieConsent: ({ policyURL, isFixed, innerMaxWidth, zIndex, }: OakCookieConsentProps) => React$1.JSX.Element;
|
|
1968
1964
|
|
|
1969
1965
|
type OakFieldsetProps = OakBoxProps;
|
|
1970
1966
|
/**
|
|
1971
1967
|
* OakFieldset renders a custom `fieldset` component, removes default styling of fieldset.
|
|
1972
1968
|
color, opacity, margin, padding, border and typography styles can be passed in also.
|
|
1973
1969
|
*/
|
|
1974
|
-
declare const OakFieldset:
|
|
1970
|
+
declare const OakFieldset: any;
|
|
1975
1971
|
|
|
1976
1972
|
/**
|
|
1977
1973
|
*
|
|
@@ -1981,7 +1977,7 @@ declare const OakFieldset: styled_components.StyledComponent<"fieldset", styled_
|
|
|
1981
1977
|
* Use `<OakBox as="form">` instead
|
|
1982
1978
|
* @deprecated Use `<OakBox as="form">` instead
|
|
1983
1979
|
*/
|
|
1984
|
-
declare const OakForm:
|
|
1980
|
+
declare const OakForm: any;
|
|
1985
1981
|
type OakFormProps = OakBoxProps;
|
|
1986
1982
|
|
|
1987
1983
|
type OakLabelProps = TypographyStyleProps & ColorStyleProps;
|
|
@@ -1991,7 +1987,7 @@ type OakLabelProps = TypographyStyleProps & ColorStyleProps;
|
|
|
1991
1987
|
* Use this component when you want to apply styles to a label, likely within
|
|
1992
1988
|
* a form.
|
|
1993
1989
|
*/
|
|
1994
|
-
declare const OakLabel:
|
|
1990
|
+
declare const OakLabel: any;
|
|
1995
1991
|
|
|
1996
1992
|
type OakTextAreaProps = Omit<DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement>, "ref"> & StyledTextAreaProps;
|
|
1997
1993
|
type StyledTextAreaProps = SizeStyleProps & BorderStyleProps & SpacingStyleProps & TypographyStyleProps & PositionStyleProps & ColorStyleProps;
|
|
@@ -2000,7 +1996,7 @@ type StyledTextAreaProps = SizeStyleProps & BorderStyleProps & SpacingStyleProps
|
|
|
2000
1996
|
* A textarea that can be used for longer text inputs where text should wrap.
|
|
2001
1997
|
*
|
|
2002
1998
|
*/
|
|
2003
|
-
declare const OakTextArea:
|
|
1999
|
+
declare const OakTextArea: any;
|
|
2004
2000
|
|
|
2005
2001
|
type OakButtonAsRadioGroupProps = {
|
|
2006
2002
|
label?: string;
|
|
@@ -2008,7 +2004,7 @@ type OakButtonAsRadioGroupProps = {
|
|
|
2008
2004
|
ariaLabelledby?: string;
|
|
2009
2005
|
name: string;
|
|
2010
2006
|
disabled?: boolean;
|
|
2011
|
-
children:
|
|
2007
|
+
children: React$1.ReactNode;
|
|
2012
2008
|
onChange?: (value: string) => void;
|
|
2013
2009
|
/**
|
|
2014
2010
|
* Sets the value of the radio group
|
|
@@ -2031,7 +2027,7 @@ type OakButtonAsRadioGroupProps = {
|
|
|
2031
2027
|
* use the callback onChange to get the value of the clicked button.
|
|
2032
2028
|
*
|
|
2033
2029
|
*/
|
|
2034
|
-
declare const OakButtonAsRadioGroup: (props: OakButtonAsRadioGroupProps) =>
|
|
2030
|
+
declare const OakButtonAsRadioGroup: (props: OakButtonAsRadioGroupProps) => React$1.JSX.Element;
|
|
2035
2031
|
|
|
2036
2032
|
/**
|
|
2037
2033
|
*
|
|
@@ -2061,9 +2057,9 @@ type BaseCheckBoxProps = {
|
|
|
2061
2057
|
*/
|
|
2062
2058
|
checked?: boolean;
|
|
2063
2059
|
onHovered?: (value: string, id: string, duration: number) => void;
|
|
2064
|
-
onChange?: (event:
|
|
2065
|
-
onFocus?: (event:
|
|
2066
|
-
onBlur?: (event:
|
|
2060
|
+
onChange?: (event: React$1.ChangeEvent<HTMLInputElement>) => void;
|
|
2061
|
+
onFocus?: (event: React$1.FocusEvent<HTMLInputElement>) => void;
|
|
2062
|
+
onBlur?: (event: React$1.FocusEvent<HTMLInputElement>) => void;
|
|
2067
2063
|
"aria-label"?: string;
|
|
2068
2064
|
"aria-labelledby"?: string;
|
|
2069
2065
|
"data-testid"?: string;
|
|
@@ -2073,7 +2069,7 @@ type InternalCheckBoxLabelProps = {
|
|
|
2073
2069
|
labelAlignItems?: FlexStyleProps["$alignItems"];
|
|
2074
2070
|
labelGap?: FlexStyleProps["$gap"];
|
|
2075
2071
|
disabled?: boolean;
|
|
2076
|
-
pointerEvents?: CSSProperties["pointerEvents"];
|
|
2072
|
+
pointerEvents?: CSSProperties$1["pointerEvents"];
|
|
2077
2073
|
"data-testid"?: string;
|
|
2078
2074
|
} & OakLabelProps;
|
|
2079
2075
|
|
|
@@ -2083,7 +2079,7 @@ type OakCheckBoxProps = BaseCheckBoxProps & {
|
|
|
2083
2079
|
checkboxBorderRadius?: OakBorderRadiusToken;
|
|
2084
2080
|
checkedBorderColor?: OakUiRoleToken;
|
|
2085
2081
|
uncheckedBorderColor?: OakUiRoleToken;
|
|
2086
|
-
checkedIcon?:
|
|
2082
|
+
checkedIcon?: React$1.JSX.Element;
|
|
2087
2083
|
checkedBackgroundFill?: boolean;
|
|
2088
2084
|
hoverBorderRadius?: OakBorderRadiusToken;
|
|
2089
2085
|
iconPadding?: OakInnerPaddingToken;
|
|
@@ -2115,17 +2111,17 @@ type OakCheckBoxProps = BaseCheckBoxProps & {
|
|
|
2115
2111
|
*
|
|
2116
2112
|
*
|
|
2117
2113
|
*/
|
|
2118
|
-
declare const OakCheckBox: (props: OakCheckBoxProps) =>
|
|
2114
|
+
declare const OakCheckBox: (props: OakCheckBoxProps) => React$1.JSX.Element;
|
|
2119
2115
|
|
|
2120
2116
|
type OakFieldErrorProps = {
|
|
2121
|
-
children?:
|
|
2117
|
+
children?: React$1.ReactNode;
|
|
2122
2118
|
};
|
|
2123
2119
|
/**
|
|
2124
2120
|
*
|
|
2125
2121
|
* OakFieldError renders a error message when passed children.
|
|
2126
2122
|
*
|
|
2127
2123
|
*/
|
|
2128
|
-
declare const OakFieldError: (props: OakFieldErrorProps) =>
|
|
2124
|
+
declare const OakFieldError: (props: OakFieldErrorProps) => React$1.JSX.Element | null;
|
|
2129
2125
|
|
|
2130
2126
|
type StyledInputProps = Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & SpacingStyleProps & SizeStyleProps;
|
|
2131
2127
|
type InternalTextInputProps = Omit<StyledInputProps, "placeholder"> & {
|
|
@@ -2187,12 +2183,12 @@ type OakFormInputProps = {
|
|
|
2187
2183
|
/**
|
|
2188
2184
|
* Default input which can be extended to create specialised inputs.
|
|
2189
2185
|
*/
|
|
2190
|
-
declare const OakFormInput: ({ type, borderColor, focusBorderColor, focusBackgroundColor, background, hoverBackground, hoverBorderColor, disabledBackgroundColor, color, disabledBorderColor, disabledColor, invalid, invalidBorderColor, wrapperWidth, wrapperMaxWidth, ...props }: OakFormInputProps) =>
|
|
2186
|
+
declare const OakFormInput: ({ type, borderColor, focusBorderColor, focusBackgroundColor, background, hoverBackground, hoverBorderColor, disabledBackgroundColor, color, disabledBorderColor, disabledColor, invalid, invalidBorderColor, wrapperWidth, wrapperMaxWidth, ...props }: OakFormInputProps) => React$1.JSX.Element;
|
|
2191
2187
|
|
|
2192
2188
|
type OakJauntyAngleLabelProps = {
|
|
2193
2189
|
label: string;
|
|
2194
2190
|
} & ComponentProps<typeof OakBox>;
|
|
2195
|
-
declare const OakJauntyAngleLabel: (props: OakJauntyAngleLabelProps) =>
|
|
2191
|
+
declare const OakJauntyAngleLabel: (props: OakJauntyAngleLabelProps) => React$1.JSX.Element;
|
|
2196
2192
|
|
|
2197
2193
|
type OakMultilineTextProps = {
|
|
2198
2194
|
/**
|
|
@@ -2228,7 +2224,7 @@ type OakMultilineTextProps = {
|
|
|
2228
2224
|
* - Current method of clearing the component is to reset its key in the parent component
|
|
2229
2225
|
* - useImperativeHandle could be used to expose a clear method
|
|
2230
2226
|
*/
|
|
2231
|
-
declare const OakMultilineText:
|
|
2227
|
+
declare const OakMultilineText: React$1.ForwardRefExoticComponent<{
|
|
2232
2228
|
/**
|
|
2233
2229
|
* Set the textarea text on first render when state is controlled internally (i.e. if `value` has not been provided)
|
|
2234
2230
|
*/
|
|
@@ -2243,7 +2239,7 @@ declare const OakMultilineText: React__default.ForwardRefExoticComponent<{
|
|
|
2243
2239
|
*/
|
|
2244
2240
|
errors?: Array<string>;
|
|
2245
2241
|
label?: string;
|
|
2246
|
-
} & Omit<OakTextAreaProps, "$width"> &
|
|
2242
|
+
} & Omit<OakTextAreaProps, "$width"> & React$1.RefAttributes<HTMLTextAreaElement>>;
|
|
2247
2243
|
declare function useDevice<T>(values: T | Array<T>): T;
|
|
2248
2244
|
|
|
2249
2245
|
type RadioButtonLabelProps = {
|
|
@@ -2290,7 +2286,7 @@ type OakRadioButtonProps = {
|
|
|
2290
2286
|
*
|
|
2291
2287
|
* Use within `OakRadioGroup` component.
|
|
2292
2288
|
*/
|
|
2293
|
-
declare const OakRadioButton:
|
|
2289
|
+
declare const OakRadioButton: React$1.ForwardRefExoticComponent<{
|
|
2294
2290
|
id: string;
|
|
2295
2291
|
label: ReactNode;
|
|
2296
2292
|
value: string;
|
|
@@ -2324,28 +2320,28 @@ declare const OakRadioButton: React__default.ForwardRefExoticComponent<{
|
|
|
2324
2320
|
*/
|
|
2325
2321
|
checkedRadioBorderWidth?: OakBorderWidthToken;
|
|
2326
2322
|
} & {
|
|
2327
|
-
children?:
|
|
2323
|
+
children?: React$1.ReactNode;
|
|
2328
2324
|
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2329
|
-
onClick?:
|
|
2325
|
+
onClick?: React$1.MouseEventHandler;
|
|
2330
2326
|
} & ScrollSnapStyleProps & {
|
|
2331
2327
|
$labelAlignItems?: FlexStyleProps["$alignItems"];
|
|
2332
2328
|
$labelGap?: FlexStyleProps["$gap"];
|
|
2333
2329
|
disabled?: boolean;
|
|
2334
|
-
} &
|
|
2330
|
+
} & React$1.RefAttributes<HTMLInputElement>>;
|
|
2335
2331
|
|
|
2336
2332
|
type RadioContextType = {
|
|
2337
2333
|
currentValue: string;
|
|
2338
2334
|
name: string;
|
|
2339
2335
|
disabled?: boolean;
|
|
2340
|
-
onValueUpdated?: (event:
|
|
2336
|
+
onValueUpdated?: (event: React$1.ChangeEvent<HTMLInputElement>) => void;
|
|
2341
2337
|
};
|
|
2342
|
-
declare const RadioContext:
|
|
2338
|
+
declare const RadioContext: React$1.Context<RadioContextType>;
|
|
2343
2339
|
type OakRadioGroupProps = {
|
|
2344
2340
|
label?: string;
|
|
2345
2341
|
name: string;
|
|
2346
2342
|
disabled?: boolean;
|
|
2347
|
-
children:
|
|
2348
|
-
onChange?: (event:
|
|
2343
|
+
children: React$1.ReactNode;
|
|
2344
|
+
onChange?: (event: React$1.ChangeEvent<HTMLInputElement>) => void;
|
|
2349
2345
|
/**
|
|
2350
2346
|
* Sets the value of the radio group
|
|
2351
2347
|
* for use as a controlled component
|
|
@@ -2366,10 +2362,10 @@ type OakRadioGroupProps = {
|
|
|
2366
2362
|
* use the callback onChange to get the value of the selected radio button.
|
|
2367
2363
|
*
|
|
2368
2364
|
*/
|
|
2369
|
-
declare const OakRadioGroup: (props: OakRadioGroupProps) =>
|
|
2365
|
+
declare const OakRadioGroup: (props: OakRadioGroupProps) => React$1.JSX.Element;
|
|
2370
2366
|
|
|
2371
2367
|
type OakSecondaryButtonAsRadioProps = {
|
|
2372
|
-
children?:
|
|
2368
|
+
children?: React$1.ReactNode;
|
|
2373
2369
|
value: string;
|
|
2374
2370
|
};
|
|
2375
2371
|
/**
|
|
@@ -2383,48 +2379,10 @@ type OakSecondaryButtonAsRadioProps = {
|
|
|
2383
2379
|
* See OakButtonAsRadioGroup.
|
|
2384
2380
|
*
|
|
2385
2381
|
*/
|
|
2386
|
-
declare const OakSecondaryButtonAsRadio: ({ children, value, }: OakSecondaryButtonAsRadioProps) =>
|
|
2382
|
+
declare const OakSecondaryButtonAsRadio: ({ children, value, }: OakSecondaryButtonAsRadioProps) => React$1.JSX.Element;
|
|
2387
2383
|
|
|
2388
|
-
declare const IconUp:
|
|
2389
|
-
|
|
2390
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2391
|
-
onClick?: React__default.MouseEventHandler;
|
|
2392
|
-
} & ScrollSnapStyleProps & {
|
|
2393
|
-
$flexDirection?: ResponsiveValues<React__default.CSSProperties["flexDirection"]>;
|
|
2394
|
-
$flexWrap?: ResponsiveValues<React__default.CSSProperties["flexWrap"]>;
|
|
2395
|
-
$alignItems?: ResponsiveValues<React__default.CSSProperties["alignItems"]>;
|
|
2396
|
-
$alignContent?: ResponsiveValues<React__default.CSSProperties["alignContent"]>;
|
|
2397
|
-
$justifyContent?: ResponsiveValues<React__default.CSSProperties["justifyContent"]>;
|
|
2398
|
-
$alignSelf?: ResponsiveValues<React__default.CSSProperties["alignSelf"]>;
|
|
2399
|
-
$flexGrow?: ResponsiveValues<React__default.CSSProperties["flexGrow"]>;
|
|
2400
|
-
$flexShrink?: ResponsiveValues<React__default.CSSProperties["flexShrink"]>;
|
|
2401
|
-
$order?: ResponsiveValues<React__default.CSSProperties["order"]>;
|
|
2402
|
-
$flexBasis?: ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
2403
|
-
$gap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2404
|
-
$columnGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2405
|
-
$rowGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2406
|
-
focusable?: boolean;
|
|
2407
|
-
}, never>;
|
|
2408
|
-
declare const IconDown: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {
|
|
2409
|
-
children?: React__default.ReactNode;
|
|
2410
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2411
|
-
onClick?: React__default.MouseEventHandler;
|
|
2412
|
-
} & ScrollSnapStyleProps & {
|
|
2413
|
-
$flexDirection?: ResponsiveValues<React__default.CSSProperties["flexDirection"]>;
|
|
2414
|
-
$flexWrap?: ResponsiveValues<React__default.CSSProperties["flexWrap"]>;
|
|
2415
|
-
$alignItems?: ResponsiveValues<React__default.CSSProperties["alignItems"]>;
|
|
2416
|
-
$alignContent?: ResponsiveValues<React__default.CSSProperties["alignContent"]>;
|
|
2417
|
-
$justifyContent?: ResponsiveValues<React__default.CSSProperties["justifyContent"]>;
|
|
2418
|
-
$alignSelf?: ResponsiveValues<React__default.CSSProperties["alignSelf"]>;
|
|
2419
|
-
$flexGrow?: ResponsiveValues<React__default.CSSProperties["flexGrow"]>;
|
|
2420
|
-
$flexShrink?: ResponsiveValues<React__default.CSSProperties["flexShrink"]>;
|
|
2421
|
-
$order?: ResponsiveValues<React__default.CSSProperties["order"]>;
|
|
2422
|
-
$flexBasis?: ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
2423
|
-
$gap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2424
|
-
$columnGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2425
|
-
$rowGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2426
|
-
focusable?: boolean;
|
|
2427
|
-
}, never>;
|
|
2384
|
+
declare const IconUp: any;
|
|
2385
|
+
declare const IconDown: any;
|
|
2428
2386
|
type OakSelectProps = {
|
|
2429
2387
|
id?: string;
|
|
2430
2388
|
children: ReactNode;
|
|
@@ -2470,7 +2428,7 @@ type OakSelectProps = {
|
|
|
2470
2428
|
$display?: DisplayStyleProps["$display"];
|
|
2471
2429
|
name?: HTMLSelectElement["name"];
|
|
2472
2430
|
};
|
|
2473
|
-
declare function OakSelect({ id, borderColor, readOnlyBorderColor, focusRingDropShadows, background, hoverBackground, disabledBackgroundColor, highlightBackgroundColor, color, disabledColor, readOnlyColor, validity, validBorderColor, invalidBorderColor, isHighlighted, $display, children, name, onChange, ...props }: Readonly<OakSelectProps>):
|
|
2431
|
+
declare function OakSelect({ id, borderColor, readOnlyBorderColor, focusRingDropShadows, background, hoverBackground, disabledBackgroundColor, highlightBackgroundColor, color, disabledColor, readOnlyColor, validity, validBorderColor, invalidBorderColor, isHighlighted, $display, children, name, onChange, ...props }: Readonly<OakSelectProps>): React$1.JSX.Element;
|
|
2474
2432
|
|
|
2475
2433
|
type OakOptionProps = {
|
|
2476
2434
|
children: ReactNode;
|
|
@@ -2480,13 +2438,13 @@ type OakOptionProps = {
|
|
|
2480
2438
|
asDefault?: boolean;
|
|
2481
2439
|
$focusRingDropShadows?: OakDropShadowToken[];
|
|
2482
2440
|
};
|
|
2483
|
-
declare function OakOption({ selected, disabled, value, children, asDefault, $focusRingDropShadows, }: Readonly<OakOptionProps>):
|
|
2441
|
+
declare function OakOption({ selected, disabled, value, children, asDefault, $focusRingDropShadows, }: Readonly<OakOptionProps>): React$1.JSX.Element;
|
|
2484
2442
|
|
|
2485
2443
|
type OakOptGroupProps = {
|
|
2486
2444
|
label: string;
|
|
2487
2445
|
children: ReactNode;
|
|
2488
2446
|
};
|
|
2489
|
-
declare function OakOptGroup({ label, children }: Readonly<OakOptGroupProps>):
|
|
2447
|
+
declare function OakOptGroup({ label, children }: Readonly<OakOptGroupProps>): React$1.JSX.Element;
|
|
2490
2448
|
|
|
2491
2449
|
type OakTextInputProps = {
|
|
2492
2450
|
/**
|
|
@@ -2553,7 +2511,7 @@ type OakTextInputProps = {
|
|
|
2553
2511
|
/**
|
|
2554
2512
|
* Default input which can be extended to create specialised inputs.
|
|
2555
2513
|
*/
|
|
2556
|
-
declare const OakTextInput: ({ type, borderColor, readOnlyBorderColor, focusRingDropShadows, background, hoverBackground, disabledBackgroundColor, highlightBackgroundColor, color, disabledColor, readOnlyColor, validity, iconColor, validBorderColor, invalidBorderColor, validIconColor, invalidIconColor, iconName, iconAlt, isTrailingIcon, isHighlighted, wrapperWidth, wrapperMaxWidth, ...props }: OakTextInputProps) =>
|
|
2514
|
+
declare const OakTextInput: ({ type, borderColor, readOnlyBorderColor, focusRingDropShadows, background, hoverBackground, disabledBackgroundColor, highlightBackgroundColor, color, disabledColor, readOnlyColor, validity, iconColor, validBorderColor, invalidBorderColor, validIconColor, invalidIconColor, iconName, iconAlt, isTrailingIcon, isHighlighted, wrapperWidth, wrapperMaxWidth, ...props }: OakTextInputProps) => React$1.JSX.Element;
|
|
2557
2515
|
|
|
2558
2516
|
/**
|
|
2559
2517
|
*
|
|
@@ -2590,15 +2548,15 @@ type BaseRadioProps = {
|
|
|
2590
2548
|
/**
|
|
2591
2549
|
* Called when the checked value changes.
|
|
2592
2550
|
*/
|
|
2593
|
-
onChange?: (event:
|
|
2551
|
+
onChange?: (event: React$1.ChangeEvent<HTMLInputElement>) => void;
|
|
2594
2552
|
/**
|
|
2595
2553
|
* Called when the input receives focus.
|
|
2596
2554
|
*/
|
|
2597
|
-
onFocus?: (event:
|
|
2555
|
+
onFocus?: (event: React$1.FocusEvent<HTMLInputElement>) => void;
|
|
2598
2556
|
/**
|
|
2599
2557
|
* Called when the input loses focus.
|
|
2600
2558
|
*/
|
|
2601
|
-
onBlur?: (event:
|
|
2559
|
+
onBlur?: (event: React$1.FocusEvent<HTMLInputElement>) => void;
|
|
2602
2560
|
"aria-label"?: string;
|
|
2603
2561
|
"aria-labelledby"?: string;
|
|
2604
2562
|
"data-testid"?: string;
|
|
@@ -2608,8 +2566,8 @@ declare const colorSchemes: ["primary", "decorative1", "decorative2", "decorativ
|
|
|
2608
2566
|
type OakRadioAsButtonColorScheme = (typeof colorSchemes)[number];
|
|
2609
2567
|
type OakRadioAsButtonProps = Omit<BaseRadioProps, "defaultChecked" | "id" | "checked" | "variant" | "icon"> & {
|
|
2610
2568
|
value?: HTMLInputElement["value"];
|
|
2611
|
-
innerRef?:
|
|
2612
|
-
displayValue:
|
|
2569
|
+
innerRef?: React$1.RefObject<HTMLInputElement>;
|
|
2570
|
+
displayValue: React$1.ReactNode;
|
|
2613
2571
|
/**
|
|
2614
2572
|
* Whether to keep the icon color when the component is checked.
|
|
2615
2573
|
*
|
|
@@ -2619,8 +2577,8 @@ type OakRadioAsButtonProps = Omit<BaseRadioProps, "defaultChecked" | "id" | "che
|
|
|
2619
2577
|
*/
|
|
2620
2578
|
keepIconColor?: boolean;
|
|
2621
2579
|
disabled?: HTMLInputElement["disabled"];
|
|
2622
|
-
"aria-labelledby"?:
|
|
2623
|
-
"aria-label"?:
|
|
2580
|
+
"aria-labelledby"?: React$1.AriaAttributes["aria-labelledby"];
|
|
2581
|
+
"aria-label"?: React$1.AriaAttributes["aria-label"];
|
|
2624
2582
|
/**
|
|
2625
2583
|
* Sets the color scheme of the component.
|
|
2626
2584
|
* Defaults to `"primary"`.
|
|
@@ -2645,10 +2603,10 @@ type OakRadioAsButtonProps = Omit<BaseRadioProps, "defaultChecked" | "id" | "che
|
|
|
2645
2603
|
/**
|
|
2646
2604
|
* A radio input styled as a button, to be used within `<OakRadioGroup/>`.
|
|
2647
2605
|
*/
|
|
2648
|
-
declare const OakRadioAsButton: (props: OakRadioAsButtonProps) =>
|
|
2606
|
+
declare const OakRadioAsButton: (props: OakRadioAsButtonProps) => React$1.JSX.Element;
|
|
2649
2607
|
|
|
2650
2608
|
type OakSearchFilterCheckBoxProps = Omit<BaseCheckBoxProps, "defaultChecked"> & {
|
|
2651
|
-
innerRef?:
|
|
2609
|
+
innerRef?: React$1.RefObject<HTMLInputElement>;
|
|
2652
2610
|
displayValue: string;
|
|
2653
2611
|
icon?: OakIconName;
|
|
2654
2612
|
keepIconColor?: boolean;
|
|
@@ -2679,7 +2637,7 @@ type OakSearchFilterCheckBoxProps = Omit<BaseCheckBoxProps, "defaultChecked"> &
|
|
|
2679
2637
|
* called after a mouseEnter and mouseLeave event has happened
|
|
2680
2638
|
*
|
|
2681
2639
|
*/
|
|
2682
|
-
declare const OakSearchFilterCheckBox: (props: OakSearchFilterCheckBoxProps) =>
|
|
2640
|
+
declare const OakSearchFilterCheckBox: (props: OakSearchFilterCheckBoxProps) => React$1.JSX.Element;
|
|
2683
2641
|
|
|
2684
2642
|
interface OakCaptionCardProps {
|
|
2685
2643
|
captionId: string;
|
|
@@ -2691,8 +2649,8 @@ interface OakCaptionCardProps {
|
|
|
2691
2649
|
checked?: boolean;
|
|
2692
2650
|
highlighted?: boolean;
|
|
2693
2651
|
disabled?: boolean;
|
|
2694
|
-
onCheckChanged?: (event:
|
|
2695
|
-
onClick?: (event:
|
|
2652
|
+
onCheckChanged?: (event: React$1.ChangeEvent<HTMLInputElement>) => void;
|
|
2653
|
+
onClick?: (event: React$1.MouseEvent<HTMLDivElement>) => void;
|
|
2696
2654
|
editHref: string;
|
|
2697
2655
|
lessonHref: string;
|
|
2698
2656
|
"data-testid"?: string;
|
|
@@ -2707,7 +2665,7 @@ interface OakCaptionCardProps {
|
|
|
2707
2665
|
* onCheckChanged?: (event: React.ChangeEvent<HTMLInputElement>) => void;
|
|
2708
2666
|
*
|
|
2709
2667
|
*/
|
|
2710
|
-
declare const OakCaptionCard: (props: OakCaptionCardProps) =>
|
|
2668
|
+
declare const OakCaptionCard: (props: OakCaptionCardProps) => React$1.JSX.Element;
|
|
2711
2669
|
|
|
2712
2670
|
interface OakCaptionSearchProps {
|
|
2713
2671
|
defaultValue?: string;
|
|
@@ -2729,7 +2687,7 @@ interface OakCaptionSearchProps {
|
|
|
2729
2687
|
*/
|
|
2730
2688
|
isLoading?: boolean;
|
|
2731
2689
|
}
|
|
2732
|
-
declare const OakCaptionSearch: ({ onSearch, hasError, errorText, isLoading, defaultValue, }: OakCaptionSearchProps) =>
|
|
2690
|
+
declare const OakCaptionSearch: ({ onSearch, hasError, errorText, isLoading, defaultValue, }: OakCaptionSearchProps) => React$1.JSX.Element;
|
|
2733
2691
|
|
|
2734
2692
|
type OakFlexProps = FlexStyleProps & OakBoxProps;
|
|
2735
2693
|
declare const oakFlexCss: styled_components.FlattenInterpolation<styled_components.ThemedStyledProps<FlexStyleProps, styled_components.DefaultTheme>>;
|
|
@@ -2741,26 +2699,7 @@ declare const oakFlexCss: styled_components.FlattenInterpolation<styled_componen
|
|
|
2741
2699
|
* Before adding props to this component, think about whether it makes sense
|
|
2742
2700
|
* to add it to Box instead, as this component extends that.
|
|
2743
2701
|
*/
|
|
2744
|
-
declare const OakFlex:
|
|
2745
|
-
children?: React.ReactNode;
|
|
2746
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2747
|
-
onClick?: React$1.MouseEventHandler;
|
|
2748
|
-
} & ScrollSnapStyleProps & {
|
|
2749
|
-
$flexDirection?: ResponsiveValues<React$1.CSSProperties["flexDirection"]>;
|
|
2750
|
-
$flexWrap?: ResponsiveValues<React$1.CSSProperties["flexWrap"]>;
|
|
2751
|
-
$alignItems?: ResponsiveValues<React$1.CSSProperties["alignItems"]>;
|
|
2752
|
-
$alignContent?: ResponsiveValues<React$1.CSSProperties["alignContent"]>;
|
|
2753
|
-
$justifyContent?: ResponsiveValues<React$1.CSSProperties["justifyContent"]>;
|
|
2754
|
-
$alignSelf?: ResponsiveValues<React$1.CSSProperties["alignSelf"]>;
|
|
2755
|
-
$flexGrow?: ResponsiveValues<React$1.CSSProperties["flexGrow"]>;
|
|
2756
|
-
$flexShrink?: ResponsiveValues<React$1.CSSProperties["flexShrink"]>;
|
|
2757
|
-
$order?: ResponsiveValues<React$1.CSSProperties["order"]>;
|
|
2758
|
-
$flexBasis?: ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
2759
|
-
$gap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2760
|
-
$columnGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2761
|
-
$rowGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2762
|
-
focusable?: boolean;
|
|
2763
|
-
}, never>;
|
|
2702
|
+
declare const OakFlex: any;
|
|
2764
2703
|
|
|
2765
2704
|
type OakGridProps = OakBoxProps & {
|
|
2766
2705
|
/**
|
|
@@ -2780,73 +2719,32 @@ type OakGridProps = OakBoxProps & {
|
|
|
2780
2719
|
*
|
|
2781
2720
|
* Accepts a `grid-auto-rows` value or a responsive array of `grid-auto-rows` values.
|
|
2782
2721
|
*/
|
|
2783
|
-
$gridAutoRows?: ResponsiveValues<CSSProperties["gridAutoRows"]>;
|
|
2722
|
+
$gridAutoRows?: ResponsiveValues<CSSProperties$1["gridAutoRows"]>;
|
|
2784
2723
|
/**
|
|
2785
2724
|
* Applies `grid-template-areas` to the grid
|
|
2786
2725
|
*
|
|
2787
2726
|
* Accepts a `grid-template-areas` value or a responsive array of `grid-template-areas` values.
|
|
2788
2727
|
*/
|
|
2789
|
-
$gridTemplateAreas?: ResponsiveValues<CSSProperties["gridTemplateAreas"]>;
|
|
2728
|
+
$gridTemplateAreas?: ResponsiveValues<CSSProperties$1["gridTemplateAreas"]>;
|
|
2790
2729
|
/**
|
|
2791
2730
|
* Applies `grid-template-columns` to the grid
|
|
2792
2731
|
*
|
|
2793
2732
|
* Accepts a `grid-template-columns` value or a responsive array of `grid-template-columns` values.
|
|
2794
2733
|
*/
|
|
2795
|
-
$gridTemplateColumns?: ResponsiveValues<CSSProperties["gridTemplateColumns"]>;
|
|
2734
|
+
$gridTemplateColumns?: ResponsiveValues<CSSProperties$1["gridTemplateColumns"]>;
|
|
2796
2735
|
/**
|
|
2797
2736
|
* Applies `grid-template-rows` to the grid
|
|
2798
2737
|
*
|
|
2799
2738
|
* Accepts a `grid-template-rows` value or a responsive array of `grid-template-rows` values.
|
|
2800
2739
|
*/
|
|
2801
|
-
$gridTemplateRows?: ResponsiveValues<CSSProperties["gridTemplateRows"]>;
|
|
2740
|
+
$gridTemplateRows?: ResponsiveValues<CSSProperties$1["gridTemplateRows"]>;
|
|
2802
2741
|
};
|
|
2803
2742
|
/**
|
|
2804
2743
|
* Creates a grid layout
|
|
2805
2744
|
*
|
|
2806
2745
|
* Defaults to a 12 column grid
|
|
2807
2746
|
*/
|
|
2808
|
-
declare const OakGrid:
|
|
2809
|
-
children?: React.ReactNode;
|
|
2810
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2811
|
-
onClick?: React$1.MouseEventHandler;
|
|
2812
|
-
} & ScrollSnapStyleProps & {
|
|
2813
|
-
/**
|
|
2814
|
-
* Applies `row-gap` to the grid
|
|
2815
|
-
*
|
|
2816
|
-
* Accepts a spacing token or a responsive array of spacing tokens.
|
|
2817
|
-
*/
|
|
2818
|
-
$rg?: ResponsiveValues<OakCombinedSpacingToken>;
|
|
2819
|
-
/**
|
|
2820
|
-
* Applies `column-gap` to the grid
|
|
2821
|
-
*
|
|
2822
|
-
* Accepts a spacing token or a responsive array of spacing tokens.
|
|
2823
|
-
*/
|
|
2824
|
-
$cg?: ResponsiveValues<OakCombinedSpacingToken>;
|
|
2825
|
-
/**
|
|
2826
|
-
* Applies `grid-auto-rows` to the grid
|
|
2827
|
-
*
|
|
2828
|
-
* Accepts a `grid-auto-rows` value or a responsive array of `grid-auto-rows` values.
|
|
2829
|
-
*/
|
|
2830
|
-
$gridAutoRows?: ResponsiveValues<CSSProperties["gridAutoRows"]>;
|
|
2831
|
-
/**
|
|
2832
|
-
* Applies `grid-template-areas` to the grid
|
|
2833
|
-
*
|
|
2834
|
-
* Accepts a `grid-template-areas` value or a responsive array of `grid-template-areas` values.
|
|
2835
|
-
*/
|
|
2836
|
-
$gridTemplateAreas?: ResponsiveValues<CSSProperties["gridTemplateAreas"]>;
|
|
2837
|
-
/**
|
|
2838
|
-
* Applies `grid-template-columns` to the grid
|
|
2839
|
-
*
|
|
2840
|
-
* Accepts a `grid-template-columns` value or a responsive array of `grid-template-columns` values.
|
|
2841
|
-
*/
|
|
2842
|
-
$gridTemplateColumns?: ResponsiveValues<CSSProperties["gridTemplateColumns"]>;
|
|
2843
|
-
/**
|
|
2844
|
-
* Applies `grid-template-rows` to the grid
|
|
2845
|
-
*
|
|
2846
|
-
* Accepts a `grid-template-rows` value or a responsive array of `grid-template-rows` values.
|
|
2847
|
-
*/
|
|
2848
|
-
$gridTemplateRows?: ResponsiveValues<CSSProperties["gridTemplateRows"]>;
|
|
2849
|
-
}, never>;
|
|
2747
|
+
declare const OakGrid: any;
|
|
2850
2748
|
|
|
2851
2749
|
type ColRowSpan = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
|
|
2852
2750
|
type OakGridAreaProps = {
|
|
@@ -2867,7 +2765,7 @@ type OakGridAreaProps = {
|
|
|
2867
2765
|
*
|
|
2868
2766
|
* Accepts a number or a responsive array of numbers.
|
|
2869
2767
|
*/
|
|
2870
|
-
$order?: ResponsiveValues<CSSProperties["order"]>;
|
|
2768
|
+
$order?: ResponsiveValues<CSSProperties$1["order"]>;
|
|
2871
2769
|
/**
|
|
2872
2770
|
* The start column of the element.
|
|
2873
2771
|
*
|
|
@@ -2895,63 +2793,7 @@ type OakGridAreaProps = {
|
|
|
2895
2793
|
* - Column and row arrangements are achieved through $colSpan, $rowSpan, $colStart, $colEnd, $rowStart, $rowEnd
|
|
2896
2794
|
*
|
|
2897
2795
|
*/
|
|
2898
|
-
declare const OakGridArea:
|
|
2899
|
-
children?: React.ReactNode;
|
|
2900
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2901
|
-
onClick?: React$1.MouseEventHandler;
|
|
2902
|
-
} & ScrollSnapStyleProps & {
|
|
2903
|
-
$flexDirection?: ResponsiveValues<React$1.CSSProperties["flexDirection"]>;
|
|
2904
|
-
$flexWrap?: ResponsiveValues<React$1.CSSProperties["flexWrap"]>;
|
|
2905
|
-
$alignItems?: ResponsiveValues<React$1.CSSProperties["alignItems"]>;
|
|
2906
|
-
$alignContent?: ResponsiveValues<React$1.CSSProperties["alignContent"]>;
|
|
2907
|
-
$justifyContent?: ResponsiveValues<React$1.CSSProperties["justifyContent"]>;
|
|
2908
|
-
$alignSelf?: ResponsiveValues<React$1.CSSProperties["alignSelf"]>;
|
|
2909
|
-
$flexGrow?: ResponsiveValues<React$1.CSSProperties["flexGrow"]>;
|
|
2910
|
-
$flexShrink?: ResponsiveValues<React$1.CSSProperties["flexShrink"]>;
|
|
2911
|
-
$order?: ResponsiveValues<React$1.CSSProperties["order"]>;
|
|
2912
|
-
$flexBasis?: ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
2913
|
-
$gap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2914
|
-
$columnGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2915
|
-
$rowGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2916
|
-
focusable?: boolean;
|
|
2917
|
-
} & {
|
|
2918
|
-
/**
|
|
2919
|
-
* Determines the number of columns the element should span.
|
|
2920
|
-
*
|
|
2921
|
-
* Accepts a value from 0-12 or a responsive value of 0-12.
|
|
2922
|
-
*/
|
|
2923
|
-
$colSpan: ResponsiveValues<ColRowSpan>;
|
|
2924
|
-
/**
|
|
2925
|
-
* Determines the number of rows the element should span.
|
|
2926
|
-
*
|
|
2927
|
-
* Accepts a value from 0-12 or a responsive value of 0-12.
|
|
2928
|
-
*/
|
|
2929
|
-
$rowSpan?: ResponsiveValues<ColRowSpan>;
|
|
2930
|
-
/**
|
|
2931
|
-
* Sets the order of the element.
|
|
2932
|
-
*
|
|
2933
|
-
* Accepts a number or a responsive array of numbers.
|
|
2934
|
-
*/
|
|
2935
|
-
$order?: ResponsiveValues<CSSProperties["order"]>;
|
|
2936
|
-
/**
|
|
2937
|
-
* The start column of the element.
|
|
2938
|
-
*
|
|
2939
|
-
* Accepts a value from 0-12 or a responsive value of 0-12.
|
|
2940
|
-
*/
|
|
2941
|
-
$colStart?: ResponsiveValues<ColRowSpan>;
|
|
2942
|
-
/**
|
|
2943
|
-
* The end column of the element.
|
|
2944
|
-
*
|
|
2945
|
-
* Accepts a value from 0-12 or a responsive value of 0-12.
|
|
2946
|
-
*/
|
|
2947
|
-
$colEnd?: ResponsiveValues<ColRowSpan>;
|
|
2948
|
-
/**
|
|
2949
|
-
* The start row of the element.
|
|
2950
|
-
*
|
|
2951
|
-
* Accepts a value from 0-12 or a responsive value of 0-12.
|
|
2952
|
-
*/
|
|
2953
|
-
$rowStart?: ResponsiveValues<ColRowSpan>;
|
|
2954
|
-
}, never>;
|
|
2796
|
+
declare const OakGridArea: any;
|
|
2955
2797
|
|
|
2956
2798
|
/**
|
|
2957
2799
|
* This component will provide a default maxWidth and ph value, it take Flex props.
|
|
@@ -2960,26 +2802,7 @@ declare const OakGridArea: styled_components.StyledComponent<"div", styled_compo
|
|
|
2960
2802
|
* This will make it easier to create full browser width or custom width containers on the same page
|
|
2961
2803
|
* with different background colors / image url.
|
|
2962
2804
|
*/
|
|
2963
|
-
declare const OakMaxWidth:
|
|
2964
|
-
children?: React.ReactNode;
|
|
2965
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
2966
|
-
onClick?: React$1.MouseEventHandler;
|
|
2967
|
-
} & ScrollSnapStyleProps & {
|
|
2968
|
-
$flexDirection?: ResponsiveValues<React$1.CSSProperties["flexDirection"]>;
|
|
2969
|
-
$flexWrap?: ResponsiveValues<React$1.CSSProperties["flexWrap"]>;
|
|
2970
|
-
$alignItems?: ResponsiveValues<React$1.CSSProperties["alignItems"]>;
|
|
2971
|
-
$alignContent?: ResponsiveValues<React$1.CSSProperties["alignContent"]>;
|
|
2972
|
-
$justifyContent?: ResponsiveValues<React$1.CSSProperties["justifyContent"]>;
|
|
2973
|
-
$alignSelf?: ResponsiveValues<React$1.CSSProperties["alignSelf"]>;
|
|
2974
|
-
$flexGrow?: ResponsiveValues<React$1.CSSProperties["flexGrow"]>;
|
|
2975
|
-
$flexShrink?: ResponsiveValues<React$1.CSSProperties["flexShrink"]>;
|
|
2976
|
-
$order?: ResponsiveValues<React$1.CSSProperties["order"]>;
|
|
2977
|
-
$flexBasis?: ResponsiveValues<OakCombinedSpacingToken | null | undefined>;
|
|
2978
|
-
$gap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2979
|
-
$columnGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2980
|
-
$rowGap?: ResponsiveValues<OakAllSpacingToken | OakSpaceBetweenToken | null | undefined>;
|
|
2981
|
-
focusable?: boolean;
|
|
2982
|
-
}, never>;
|
|
2805
|
+
declare const OakMaxWidth: any;
|
|
2983
2806
|
|
|
2984
2807
|
type OakAccordionProps = {
|
|
2985
2808
|
/**
|
|
@@ -3010,7 +2833,7 @@ type OakAccordionProps = {
|
|
|
3010
2833
|
/**
|
|
3011
2834
|
* An accordion component that can be used to show/hide content
|
|
3012
2835
|
*/
|
|
3013
|
-
declare const OakAccordion: (props: OakAccordionProps) =>
|
|
2836
|
+
declare const OakAccordion: (props: OakAccordionProps) => React$1.JSX.Element;
|
|
3014
2837
|
|
|
3015
2838
|
type OakBasicAccordionProps = {
|
|
3016
2839
|
/**
|
|
@@ -3034,7 +2857,7 @@ type OakBasicAccordionProps = {
|
|
|
3034
2857
|
*/
|
|
3035
2858
|
id: string;
|
|
3036
2859
|
} & BorderStyleProps & FlexStyleProps;
|
|
3037
|
-
declare const OakBasicAccordion: ({ header, children, id, initialOpen, subheading, ...styleProps }: OakBasicAccordionProps) =>
|
|
2860
|
+
declare const OakBasicAccordion: ({ header, children, id, initialOpen, subheading, ...styleProps }: OakBasicAccordionProps) => React$1.JSX.Element;
|
|
3038
2861
|
|
|
3039
2862
|
type OakCollapsibleContentProps = ComponentProps<typeof OakFlex> & {
|
|
3040
2863
|
/**
|
|
@@ -3046,7 +2869,7 @@ type OakCollapsibleContentProps = ComponentProps<typeof OakFlex> & {
|
|
|
3046
2869
|
* A filled scrollable box that can be hidden with the `isOpen` prop.
|
|
3047
2870
|
* Useful for hiding content that is not immediately relevant
|
|
3048
2871
|
*/
|
|
3049
|
-
declare const OakCollapsibleContent: ({ isOpen, children, id, ...rest }: OakCollapsibleContentProps) =>
|
|
2872
|
+
declare const OakCollapsibleContent: ({ isOpen, children, id, ...rest }: OakCollapsibleContentProps) => React$1.JSX.Element;
|
|
3050
2873
|
|
|
3051
2874
|
type OakKbdProps = {
|
|
3052
2875
|
children: ReactNode;
|
|
@@ -3054,7 +2877,7 @@ type OakKbdProps = {
|
|
|
3054
2877
|
/**
|
|
3055
2878
|
* Represents textual user input from a keyboard, voice input, or any other text entry device.
|
|
3056
2879
|
* */
|
|
3057
|
-
declare const OakKbd: ({ children }: OakKbdProps) =>
|
|
2880
|
+
declare const OakKbd: ({ children }: OakKbdProps) => React$1.JSX.Element;
|
|
3058
2881
|
|
|
3059
2882
|
/**
|
|
3060
2883
|
* This component will visually hide its contents but will still be available
|
|
@@ -3063,7 +2886,7 @@ declare const OakKbd: ({ children }: OakKbdProps) => React__default.JSX.Element;
|
|
|
3063
2886
|
* Use this component in places where content shouldn't be visible, but should
|
|
3064
2887
|
* be accessible to assistive technology.
|
|
3065
2888
|
*/
|
|
3066
|
-
declare const OakScreenReader:
|
|
2889
|
+
declare const OakScreenReader: any;
|
|
3067
2890
|
|
|
3068
2891
|
type OakLoadingSpinnerProps = Pick<SizeStyleProps, "$width"> & ColorStyleProps & {
|
|
3069
2892
|
loaderColor?: OakUiRoleToken;
|
|
@@ -3079,13 +2902,13 @@ type OakLoadingSpinnerProps = Pick<SizeStyleProps, "$width"> & ColorStyleProps &
|
|
|
3079
2902
|
* A loading spinner of variable size.
|
|
3080
2903
|
*
|
|
3081
2904
|
*/
|
|
3082
|
-
declare const OakLoadingSpinner: (props: OakLoadingSpinnerProps) =>
|
|
2905
|
+
declare const OakLoadingSpinner: (props: OakLoadingSpinnerProps) => React$1.JSX.Element;
|
|
3083
2906
|
|
|
3084
2907
|
declare const oakHeadingTagsConst: readonly ["div", "h1", "h2", "h3", "h4", "h5", "h6"];
|
|
3085
2908
|
type OakHeadingTag = (typeof oakHeadingTagsConst)[number];
|
|
3086
2909
|
declare const oakHeadingTags: ("div" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
|
|
3087
2910
|
type OakHeadingTagProps = {
|
|
3088
|
-
children?:
|
|
2911
|
+
children?: React$1.ReactNode;
|
|
3089
2912
|
id?: string;
|
|
3090
2913
|
/**
|
|
3091
2914
|
* HTML tag to be used for the heading
|
|
@@ -3104,7 +2927,7 @@ type OakHeadingProps = TypographyStyleProps & OakHeadingTagProps & ColorStylePro
|
|
|
3104
2927
|
* Use the controls to view different font styles.
|
|
3105
2928
|
*
|
|
3106
2929
|
*/
|
|
3107
|
-
declare const OakHeading:
|
|
2930
|
+
declare const OakHeading: any;
|
|
3108
2931
|
|
|
3109
2932
|
type OakInlineBannerTypes = "info" | "neutral" | "success" | "alert" | "error" | "warning";
|
|
3110
2933
|
type OakInlineBannerVariants = "regular" | "large";
|
|
@@ -3200,7 +3023,7 @@ declare const bannerVariants: OakInlineBannerVariantProps;
|
|
|
3200
3023
|
* - **variant?** \- The variant of the inline banner to display (regular, large) (default: regular)
|
|
3201
3024
|
* - **...rest** \- Other props to be passed to the wrapper OakFlex component (can be used to override styles of the banner)
|
|
3202
3025
|
*/
|
|
3203
|
-
declare const OakInlineBanner: ({ isOpen, title, message, type, icon, iconColorFilter, isLoading, cta, canDismiss, onDismiss, closeButtonOverrideProps, variant, titleTag, ...props }: OakInlineBannerProps) =>
|
|
3026
|
+
declare const OakInlineBanner: ({ isOpen, title, message, type, icon, iconColorFilter, isLoading, cta, canDismiss, onDismiss, closeButtonOverrideProps, variant, titleTag, ...props }: OakInlineBannerProps) => React$1.JSX.Element;
|
|
3204
3027
|
|
|
3205
3028
|
type OakModalCenterProps = {
|
|
3206
3029
|
/**
|
|
@@ -3274,7 +3097,7 @@ type OakModalCenterProps = {
|
|
|
3274
3097
|
* - **backdropFlexProps?** \- Override HTMLAttributes & OakFlex props for the backdrop container
|
|
3275
3098
|
* - **footerSlot?** \- Fixed area at the bottom of the modal, this will remain fixed in view if the content is scrollable
|
|
3276
3099
|
*/
|
|
3277
|
-
declare const OakModalCenter: ({ children, domContainer, isOpen, onClose, disableBackdropClick, disableEscapeKey, hideCloseButton, modalFlexProps, modalOuterFlexProps, modalInnerFlexProps, backdropFlexProps, footerSlot, returnFocus, }: OakModalCenterProps) =>
|
|
3100
|
+
declare const OakModalCenter: ({ children, domContainer, isOpen, onClose, disableBackdropClick, disableEscapeKey, hideCloseButton, modalFlexProps, modalOuterFlexProps, modalInnerFlexProps, backdropFlexProps, footerSlot, returnFocus, }: OakModalCenterProps) => React$1.JSX.Element;
|
|
3278
3101
|
|
|
3279
3102
|
type OakModalCenterBodyProps = {
|
|
3280
3103
|
/**
|
|
@@ -3316,7 +3139,7 @@ type OakModalCenterBodyProps = {
|
|
|
3316
3139
|
* - **headingOverride** \- Override HTMLAttributes & OakHEading props for the heading
|
|
3317
3140
|
* - **iconOverride** \- Override HTMLAttributes & OakIcon props for the icon
|
|
3318
3141
|
*/
|
|
3319
|
-
declare const OakModalCenterBody: ({ children, iconName, title, headingOverride, iconOverride, hideIcon, }: OakModalCenterBodyProps) =>
|
|
3142
|
+
declare const OakModalCenterBody: ({ children, iconName, title, headingOverride, iconOverride, hideIcon, }: OakModalCenterBodyProps) => React$1.JSX.Element;
|
|
3320
3143
|
|
|
3321
3144
|
type OakTagFunctionalProps = {
|
|
3322
3145
|
label: string;
|
|
@@ -3324,10 +3147,10 @@ type OakTagFunctionalProps = {
|
|
|
3324
3147
|
isTrailingIcon?: boolean;
|
|
3325
3148
|
useSpan?: boolean;
|
|
3326
3149
|
} & Omit<OakFlexProps, "onClick" | "label">;
|
|
3327
|
-
declare const OakTagFunctional: (props: OakTagFunctionalProps) =>
|
|
3150
|
+
declare const OakTagFunctional: (props: OakTagFunctionalProps) => React$1.JSX.Element;
|
|
3328
3151
|
|
|
3329
3152
|
type OakToastProps = {
|
|
3330
|
-
message:
|
|
3153
|
+
message: React$1.ReactNode;
|
|
3331
3154
|
variant: VariantKey;
|
|
3332
3155
|
autoDismissDuration?: number;
|
|
3333
3156
|
autoDismiss: boolean;
|
|
@@ -3337,7 +3160,7 @@ type OakToastProps = {
|
|
|
3337
3160
|
showClose?: boolean;
|
|
3338
3161
|
};
|
|
3339
3162
|
type VariantKey = "green" | "yellow" | "pink" | "blue" | "aqua" | "light" | "dark" | "error" | "success";
|
|
3340
|
-
declare const OakToast: ({ message, variant, autoDismiss, autoDismissDuration, showIcon, onClose, id, showClose, }: OakToastProps) =>
|
|
3163
|
+
declare const OakToast: ({ message, variant, autoDismiss, autoDismissDuration, showIcon, onClose, id, showClose, }: OakToastProps) => React$1.JSX.Element;
|
|
3341
3164
|
|
|
3342
3165
|
type InternalTooltipProps = OakFlexProps & HTMLAttributes<Element> & {
|
|
3343
3166
|
children?: ReactNode;
|
|
@@ -3367,7 +3190,7 @@ type OakTooltipProps = InternalTooltipProps & {
|
|
|
3367
3190
|
/**
|
|
3368
3191
|
* A tooltip with oven-ready styling and positioning.
|
|
3369
3192
|
*/
|
|
3370
|
-
declare const OakTooltip: ({ tooltipPosition, children, tooltip, isOpen, domContainer, ...props }: OakTooltipProps) =>
|
|
3193
|
+
declare const OakTooltip: ({ tooltipPosition, children, tooltip, isOpen, domContainer, ...props }: OakTooltipProps) => React$1.JSX.Element;
|
|
3371
3194
|
|
|
3372
3195
|
type OakFocusIndicatorProps = {
|
|
3373
3196
|
hoverBackground?: OakUiRoleToken;
|
|
@@ -3378,11 +3201,7 @@ type OakFocusIndicatorProps = {
|
|
|
3378
3201
|
/**
|
|
3379
3202
|
* Wrap focusable components `<a/>`/`<button/>` and this will add focus styles then the inner element is focused
|
|
3380
3203
|
*/
|
|
3381
|
-
declare const OakFocusIndicator:
|
|
3382
|
-
children?: React.ReactNode;
|
|
3383
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
3384
|
-
onClick?: React$1.MouseEventHandler;
|
|
3385
|
-
} & ScrollSnapStyleProps & OakFocusIndicatorProps, never>;
|
|
3204
|
+
declare const OakFocusIndicator: any;
|
|
3386
3205
|
|
|
3387
3206
|
type InternalStyledSvgProps = {
|
|
3388
3207
|
$fill?: ResponsiveValues<OakUiRoleToken>;
|
|
@@ -3400,7 +3219,7 @@ type OakHandDrawnFocusUnderlineProps = {
|
|
|
3400
3219
|
*
|
|
3401
3220
|
* change the sizeProps of the flex container to change the size and dimentions of the FocusUnderline
|
|
3402
3221
|
*/
|
|
3403
|
-
declare const OakHandDrawnFocusUnderline: (props: OakHandDrawnFocusUnderlineProps) =>
|
|
3222
|
+
declare const OakHandDrawnFocusUnderline: (props: OakHandDrawnFocusUnderlineProps) => React$1.JSX.Element;
|
|
3404
3223
|
|
|
3405
3224
|
type OakAnchorTargetProps = PaddingStyleProps;
|
|
3406
3225
|
/**
|
|
@@ -3414,7 +3233,7 @@ type OakAnchorTargetProps = PaddingStyleProps;
|
|
|
3414
3233
|
* it a unique 'id'. Then link it elsewhere using `<a href='#${id}' />`.
|
|
3415
3234
|
*
|
|
3416
3235
|
* */
|
|
3417
|
-
declare const OakAnchorTarget:
|
|
3236
|
+
declare const OakAnchorTarget: any;
|
|
3418
3237
|
|
|
3419
3238
|
type InternalLinkProps = {
|
|
3420
3239
|
/**
|
|
@@ -3443,13 +3262,13 @@ type OakHoverLinkProps = Pick<InternalLinkProps, "iconName" | "isTrailingIcon" |
|
|
|
3443
3262
|
iconWidth?: OakAllSpacingToken;
|
|
3444
3263
|
iconHeight?: OakAllSpacingToken;
|
|
3445
3264
|
};
|
|
3446
|
-
type OakHoverLinkComponent = <C extends
|
|
3265
|
+
type OakHoverLinkComponent = <C extends React$1.ElementType = "a">(props: {
|
|
3447
3266
|
/**
|
|
3448
3267
|
* This colours the link as disabled, but does not disable the link.
|
|
3449
3268
|
* It should be used when the link is wrapped in an element which prevents cursor interaction, such as a card
|
|
3450
3269
|
*/
|
|
3451
3270
|
displayDisabled?: boolean;
|
|
3452
|
-
} & PolymorphicPropsWithRef<C> & OakHoverLinkProps) =>
|
|
3271
|
+
} & PolymorphicPropsWithRef<C> & OakHoverLinkProps) => React$1.ReactNode;
|
|
3453
3272
|
/**
|
|
3454
3273
|
* deprecated - use `<OakLink />` instead
|
|
3455
3274
|
* @deprecated
|
|
@@ -3474,7 +3293,7 @@ type OakLinkProps = Pick<InternalLinkProps, "iconName" | "isTrailingIcon" | "isL
|
|
|
3474
3293
|
*/
|
|
3475
3294
|
variant?: Variant;
|
|
3476
3295
|
} & Pick<TypographyStyleProps, "$font">;
|
|
3477
|
-
type OakLinkComponent$1 = <C extends
|
|
3296
|
+
type OakLinkComponent$1 = <C extends React$1.ElementType = "a">(props: PolymorphicPropsWithRef<C> & OakLinkProps) => React$1.ReactNode;
|
|
3478
3297
|
/**
|
|
3479
3298
|
* A link with an optional icon and loading state.
|
|
3480
3299
|
*
|
|
@@ -3491,7 +3310,7 @@ type OakPaginationProps = {
|
|
|
3491
3310
|
pageName: string;
|
|
3492
3311
|
onPageChange: (page: number) => void;
|
|
3493
3312
|
};
|
|
3494
|
-
declare const OakPagination: ({ totalPages, nextHref, prevHref, paginationHref, pageName, onPageChange, currentPage, }: OakPaginationProps) =>
|
|
3313
|
+
declare const OakPagination: ({ totalPages, nextHref, prevHref, paginationHref, pageName, onPageChange, currentPage, }: OakPaginationProps) => React$1.JSX.Element | null;
|
|
3495
3314
|
|
|
3496
3315
|
type Url = string | UrlObject;
|
|
3497
3316
|
type OakPrimaryNavItemProps = {
|
|
@@ -3508,7 +3327,7 @@ type OakPrimaryNavItemProps = {
|
|
|
3508
3327
|
* ⚠️ To be deprecated
|
|
3509
3328
|
* @deprecated
|
|
3510
3329
|
*/
|
|
3511
|
-
declare const OakPrimaryNavItem: ({ href, isCurrent, shallow, children, }: OakPrimaryNavItemProps) =>
|
|
3330
|
+
declare const OakPrimaryNavItem: ({ href, isCurrent, shallow, children, }: OakPrimaryNavItemProps) => React$1.JSX.Element;
|
|
3512
3331
|
|
|
3513
3332
|
type OakPrimaryNavProps = {
|
|
3514
3333
|
ariaLabel?: string;
|
|
@@ -3520,12 +3339,12 @@ type OakPrimaryNavProps = {
|
|
|
3520
3339
|
* ⚠️ To be deprecated
|
|
3521
3340
|
* @deprecated
|
|
3522
3341
|
*/
|
|
3523
|
-
declare const OakPrimaryNav: ({ ariaLabel, navItems }: OakPrimaryNavProps) =>
|
|
3342
|
+
declare const OakPrimaryNav: ({ ariaLabel, navItems }: OakPrimaryNavProps) => React$1.JSX.Element;
|
|
3524
3343
|
|
|
3525
3344
|
type OakSecondaryLinkProps = {
|
|
3526
3345
|
displayDisabled?: boolean;
|
|
3527
3346
|
} & Pick<InternalLinkProps, "iconName" | "isTrailingIcon" | "isLoading">;
|
|
3528
|
-
type OakLinkComponent = <C extends
|
|
3347
|
+
type OakLinkComponent = <C extends React$1.ElementType = "a">(props: PolymorphicPropsWithRef<C> & OakSecondaryLinkProps) => React$1.ReactNode;
|
|
3529
3348
|
/**
|
|
3530
3349
|
* deprecated - use `<OakLink variant="secondary"/>` instead
|
|
3531
3350
|
* @deprecated
|
|
@@ -3560,7 +3379,7 @@ type OakTabsProps<T extends string> = {
|
|
|
3560
3379
|
*/
|
|
3561
3380
|
onTabClick?: (tab: T, event: Event) => void;
|
|
3562
3381
|
};
|
|
3563
|
-
declare function OakTabs<T extends string>(props: Readonly<OakTabsProps<T>>):
|
|
3382
|
+
declare function OakTabs<T extends string>(props: Readonly<OakTabsProps<T>>): React$1.JSX.Element;
|
|
3564
3383
|
|
|
3565
3384
|
type OakCardProps = {
|
|
3566
3385
|
/**
|
|
@@ -3628,7 +3447,7 @@ type OakCardProps = {
|
|
|
3628
3447
|
* The card can be oriented in a row or column layout and its width can be adjusted using spacing tokens.
|
|
3629
3448
|
* The image aspect ratio can be set to either 1:1 or 4:3.
|
|
3630
3449
|
*/
|
|
3631
|
-
declare const OakCard: ({ heading, headingLevel, href, cardOrientation, cardWidth, imageSrc, imageAlt, aspectRatio, subCopy, tagName, tagBackground, linkText, linkIconName, hoverBackground, }: OakCardProps) =>
|
|
3450
|
+
declare const OakCard: ({ heading, headingLevel, href, cardOrientation, cardWidth, imageSrc, imageAlt, aspectRatio, subCopy, tagName, tagBackground, linkText, linkIconName, hoverBackground, }: OakCardProps) => React$1.JSX.Element;
|
|
3632
3451
|
|
|
3633
3452
|
type OakBreadcrumb = {
|
|
3634
3453
|
text: string;
|
|
@@ -3646,7 +3465,7 @@ type OakBreadcrumbsProps = {
|
|
|
3646
3465
|
/**
|
|
3647
3466
|
* The breadcrumb component helps users to understand where they are within a website’s structure and move between levels.
|
|
3648
3467
|
*/
|
|
3649
|
-
declare const OakBreadcrumbs: ({ breadcrumbs, }: Readonly<OakBreadcrumbsProps>) =>
|
|
3468
|
+
declare const OakBreadcrumbs: ({ breadcrumbs, }: Readonly<OakBreadcrumbsProps>) => React$1.JSX.Element;
|
|
3650
3469
|
|
|
3651
3470
|
type OakDownloadsAccordionProps = {
|
|
3652
3471
|
/**
|
|
@@ -3678,22 +3497,22 @@ type OakDownloadsAccordionProps = {
|
|
|
3678
3497
|
* OakDownloadsAccordion
|
|
3679
3498
|
*
|
|
3680
3499
|
*/
|
|
3681
|
-
declare const OakDownloadsAccordion: ({ initialOpen, ...props }: OakDownloadsAccordionProps) =>
|
|
3500
|
+
declare const OakDownloadsAccordion: ({ initialOpen, ...props }: OakDownloadsAccordionProps) => React$1.JSX.Element;
|
|
3682
3501
|
|
|
3683
3502
|
type OakInlineRegistrationBannerProps = {
|
|
3684
3503
|
onSubmit: (email: string) => Promise<string | undefined>;
|
|
3685
|
-
headerText:
|
|
3686
|
-
bodyText:
|
|
3504
|
+
headerText: React$1.ReactNode;
|
|
3505
|
+
bodyText: React$1.ReactNode;
|
|
3687
3506
|
} & ColorStyleProps & BorderStyleProps;
|
|
3688
|
-
declare const OakInlineRegistrationBanner: (props: OakInlineRegistrationBannerProps) =>
|
|
3507
|
+
declare const OakInlineRegistrationBanner: (props: OakInlineRegistrationBannerProps) => React$1.JSX.Element;
|
|
3689
3508
|
|
|
3690
3509
|
type OakTeacherNotesInlineProps = {
|
|
3691
3510
|
sanitizedHtml?: string | TrustedHTML;
|
|
3692
3511
|
};
|
|
3693
|
-
declare const OakTeacherNotesInline: ({ sanitizedHtml, }: OakTeacherNotesInlineProps) =>
|
|
3512
|
+
declare const OakTeacherNotesInline: ({ sanitizedHtml, }: OakTeacherNotesInlineProps) => React$1.JSX.Element;
|
|
3694
3513
|
|
|
3695
3514
|
type EditorContainerProps = {
|
|
3696
|
-
editorNode:
|
|
3515
|
+
editorNode: React$1.ReactNode;
|
|
3697
3516
|
onBoldClick: () => void;
|
|
3698
3517
|
onBulletListClick: () => void;
|
|
3699
3518
|
isBold: boolean;
|
|
@@ -3709,9 +3528,9 @@ type OakTeacherNotesModalProps = {
|
|
|
3709
3528
|
error?: boolean;
|
|
3710
3529
|
termsAndConditionsHref: string;
|
|
3711
3530
|
shareLinkDisabled?: boolean;
|
|
3712
|
-
footer?:
|
|
3531
|
+
footer?: React$1.ReactNode;
|
|
3713
3532
|
} & EditorContainerProps;
|
|
3714
|
-
declare const OakTeacherNotesModal: ({ isOpen, onClose, onShareClicked, progressSaved, noteShared, error, termsAndConditionsHref, shareLinkDisabled, footer, ...rest }: OakTeacherNotesModalProps) =>
|
|
3533
|
+
declare const OakTeacherNotesModal: ({ isOpen, onClose, onShareClicked, progressSaved, noteShared, error, termsAndConditionsHref, shareLinkDisabled, footer, ...rest }: OakTeacherNotesModalProps) => React$1.JSX.Element;
|
|
3715
3534
|
|
|
3716
3535
|
type OakTertiaryOLNavProps = {
|
|
3717
3536
|
title?: string;
|
|
@@ -3721,9 +3540,9 @@ type OakTertiaryOLNavProps = {
|
|
|
3721
3540
|
}[];
|
|
3722
3541
|
ariaLabel?: string;
|
|
3723
3542
|
anchorTarget?: string;
|
|
3724
|
-
onClick?: (event:
|
|
3543
|
+
onClick?: (event: React$1.MouseEvent<HTMLAnchorElement, MouseEvent>) => void;
|
|
3725
3544
|
};
|
|
3726
|
-
declare const OakTertiaryOLNav: ({ items, ariaLabel, title, anchorTarget, onClick, ...rest }: OakTertiaryOLNavProps) =>
|
|
3545
|
+
declare const OakTertiaryOLNav: ({ items, ariaLabel, title, anchorTarget, onClick, ...rest }: OakTertiaryOLNavProps) => React$1.JSX.Element;
|
|
3727
3546
|
|
|
3728
3547
|
type OakUnitListItemProps<element extends ElementType> = {
|
|
3729
3548
|
unavailable?: boolean;
|
|
@@ -3734,7 +3553,7 @@ type OakUnitListItemProps<element extends ElementType> = {
|
|
|
3734
3553
|
isLegacy: boolean;
|
|
3735
3554
|
href: string;
|
|
3736
3555
|
firstItemRef?: MutableRefObject<HTMLAnchorElement | null> | null | undefined;
|
|
3737
|
-
onClick?: (event:
|
|
3556
|
+
onClick?: (event: React$1.MouseEvent<HTMLAnchorElement, MouseEvent>) => void;
|
|
3738
3557
|
onSave?: () => void;
|
|
3739
3558
|
isSaved?: boolean;
|
|
3740
3559
|
isSaving?: boolean;
|
|
@@ -3745,7 +3564,7 @@ type OakUnitListItemProps<element extends ElementType> = {
|
|
|
3745
3564
|
*
|
|
3746
3565
|
* OakUnitsListItem component used as links for unit cards
|
|
3747
3566
|
*/
|
|
3748
|
-
declare const OakUnitListItem: <element extends ElementType = "a">(props: OakUnitListItemProps<element>) =>
|
|
3567
|
+
declare const OakUnitListItem: <element extends ElementType = "a">(props: OakUnitListItemProps<element>) => React$1.JSX.Element;
|
|
3749
3568
|
|
|
3750
3569
|
type OakUnitListOptionalityItemProps = {
|
|
3751
3570
|
unavailable?: boolean;
|
|
@@ -3761,7 +3580,7 @@ type OakUnitListOptionalityItemProps = {
|
|
|
3761
3580
|
slug: string;
|
|
3762
3581
|
href: string;
|
|
3763
3582
|
lessonCount: string;
|
|
3764
|
-
onClick?: (event:
|
|
3583
|
+
onClick?: (event: React$1.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
3765
3584
|
firstItemRef?: MutableRefObject<HTMLAnchorElement | null> | null | undefined;
|
|
3766
3585
|
}[];
|
|
3767
3586
|
};
|
|
@@ -3769,7 +3588,7 @@ type OakUnitListOptionalityItemProps = {
|
|
|
3769
3588
|
*
|
|
3770
3589
|
* OakUnitsListOptionalityItem component used as links for unit cards with optionality
|
|
3771
3590
|
*/
|
|
3772
|
-
declare const OakUnitListOptionalityItem: (props: OakUnitListOptionalityItemProps) =>
|
|
3591
|
+
declare const OakUnitListOptionalityItem: (props: OakUnitListOptionalityItemProps) => React$1.JSX.Element;
|
|
3773
3592
|
|
|
3774
3593
|
type OakUnitListOptionalityItemCardProps = {
|
|
3775
3594
|
unavailable?: boolean;
|
|
@@ -3778,7 +3597,7 @@ type OakUnitListOptionalityItemCardProps = {
|
|
|
3778
3597
|
href: string;
|
|
3779
3598
|
slug: string;
|
|
3780
3599
|
firstItemRef?: MutableRefObject<HTMLAnchorElement | null> | null | undefined;
|
|
3781
|
-
onClick?: (event:
|
|
3600
|
+
onClick?: (event: React$1.MouseEvent<HTMLAnchorElement, MouseEvent>) => void;
|
|
3782
3601
|
onSave?: (unitSlug: string) => void;
|
|
3783
3602
|
isSaved?: boolean;
|
|
3784
3603
|
isSaving?: boolean;
|
|
@@ -3787,7 +3606,7 @@ type OakUnitListOptionalityItemCardProps = {
|
|
|
3787
3606
|
*
|
|
3788
3607
|
* OakUnitsListItem component used as links for unit cards
|
|
3789
3608
|
*/
|
|
3790
|
-
declare const OakUnitListOptionalityItemCard: (props: OakUnitListOptionalityItemCardProps) =>
|
|
3609
|
+
declare const OakUnitListOptionalityItemCard: (props: OakUnitListOptionalityItemCardProps) => React$1.JSX.Element;
|
|
3791
3610
|
|
|
3792
3611
|
type OakPupilContentGuidance = {
|
|
3793
3612
|
contentguidanceLabel: string | null;
|
|
@@ -3847,7 +3666,7 @@ declare const removedGuidanceDuplicates: (contentGuidance?: OakPupilContentGuida
|
|
|
3847
3666
|
* - **declineText** \- The text to be displayed on the decline button
|
|
3848
3667
|
* - **declineIcon** \- The icon to be displayed on the decline button
|
|
3849
3668
|
*/
|
|
3850
|
-
declare const OakPupilJourneyContentGuidance: ({ isOpen, onAccept, onDecline, title, contentGuidance, supervisionLevel, acceptText, declineText, declineIcon, }: OakPupilJourneyContentGuidanceProps) =>
|
|
3669
|
+
declare const OakPupilJourneyContentGuidance: ({ isOpen, onAccept, onDecline, title, contentGuidance, supervisionLevel, acceptText, declineText, declineIcon, }: OakPupilJourneyContentGuidanceProps) => React$1.JSX.Element;
|
|
3851
3670
|
|
|
3852
3671
|
type OakSpanProps = ColorStyleProps & OpacityStyleProps & MarginStyleProps & PaddingStyleProps & BorderStyleProps & TypographyStyleProps & PositionStyleProps;
|
|
3853
3672
|
/**
|
|
@@ -3855,7 +3674,7 @@ type OakSpanProps = ColorStyleProps & OpacityStyleProps & MarginStyleProps & Pad
|
|
|
3855
3674
|
* ## Usage
|
|
3856
3675
|
* Use this component when you want to apply styles to a piece of inline text.
|
|
3857
3676
|
*/
|
|
3858
|
-
declare const OakSpan:
|
|
3677
|
+
declare const OakSpan: any;
|
|
3859
3678
|
|
|
3860
3679
|
type OakBulletListProps = {
|
|
3861
3680
|
listItems: string[];
|
|
@@ -3863,7 +3682,7 @@ type OakBulletListProps = {
|
|
|
3863
3682
|
/**
|
|
3864
3683
|
* An inline bulleted list
|
|
3865
3684
|
*/
|
|
3866
|
-
declare const OakBulletList: (props: OakBulletListProps) =>
|
|
3685
|
+
declare const OakBulletList: (props: OakBulletListProps) => React$1.JSX.Element;
|
|
3867
3686
|
|
|
3868
3687
|
type OakPupilJourneyHeaderProps = {
|
|
3869
3688
|
title: string;
|
|
@@ -3880,7 +3699,7 @@ type OakPupilJourneyHeaderProps = {
|
|
|
3880
3699
|
*
|
|
3881
3700
|
*
|
|
3882
3701
|
*/
|
|
3883
|
-
declare const OakPupilJourneyHeader: ({ iconBackground, title, iconName, alt, breadcrumbs, optionalityTitle, }: OakPupilJourneyHeaderProps) =>
|
|
3702
|
+
declare const OakPupilJourneyHeader: ({ iconBackground, title, iconName, alt, breadcrumbs, optionalityTitle, }: OakPupilJourneyHeaderProps) => React$1.JSX.Element;
|
|
3884
3703
|
|
|
3885
3704
|
type PupilJourneySectionName = "tier-listing" | "examboard-listing" | "unit-listing" | "lesson-listing" | "subject-listing" | "year-listing";
|
|
3886
3705
|
type Phase$1 = "primary" | "secondary";
|
|
@@ -3897,15 +3716,15 @@ type OakPupilJourneyLayoutProps = {
|
|
|
3897
3716
|
*
|
|
3898
3717
|
* the sections of the page are passed in as props and children
|
|
3899
3718
|
*/
|
|
3900
|
-
declare const OakPupilJourneyLayout: ({ sectionName, topNavSlot, phase, children, }: OakPupilJourneyLayoutProps) =>
|
|
3719
|
+
declare const OakPupilJourneyLayout: ({ sectionName, topNavSlot, phase, children, }: OakPupilJourneyLayoutProps) => React$1.JSX.Element;
|
|
3901
3720
|
declare function getBackgroundUrlForSection(sectionName: PupilJourneySectionName, phase?: Phase$1): string;
|
|
3902
3721
|
|
|
3903
3722
|
type OakPupilJourneyListProps = {
|
|
3904
|
-
children:
|
|
3723
|
+
children: React$1.ReactNode;
|
|
3905
3724
|
phase: "primary" | "secondary";
|
|
3906
|
-
titleSlot?:
|
|
3907
|
-
filterSlot?:
|
|
3908
|
-
subheadingSlot:
|
|
3725
|
+
titleSlot?: React$1.ReactNode;
|
|
3726
|
+
filterSlot?: React$1.ReactNode;
|
|
3727
|
+
subheadingSlot: React$1.ReactNode;
|
|
3909
3728
|
};
|
|
3910
3729
|
/**
|
|
3911
3730
|
*
|
|
@@ -3913,14 +3732,14 @@ type OakPupilJourneyListProps = {
|
|
|
3913
3732
|
*
|
|
3914
3733
|
*
|
|
3915
3734
|
*/
|
|
3916
|
-
declare const OakPupilJourneyList: ({ children, phase, titleSlot, subheadingSlot, filterSlot, }: OakPupilJourneyListProps) =>
|
|
3735
|
+
declare const OakPupilJourneyList: ({ children, phase, titleSlot, subheadingSlot, filterSlot, }: OakPupilJourneyListProps) => React$1.JSX.Element;
|
|
3917
3736
|
|
|
3918
3737
|
type OakPupilJourneyListCounterProps = {
|
|
3919
3738
|
count: number;
|
|
3920
3739
|
countHeader: string;
|
|
3921
3740
|
tag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
3922
3741
|
};
|
|
3923
|
-
declare const OakPupilJourneyListCounter: (props: OakPupilJourneyListCounterProps) =>
|
|
3742
|
+
declare const OakPupilJourneyListCounter: (props: OakPupilJourneyListCounterProps) => React$1.JSX.Element;
|
|
3924
3743
|
|
|
3925
3744
|
type OakPupilJourneyListItemProps<C extends ElementType> = {
|
|
3926
3745
|
as?: C;
|
|
@@ -3939,10 +3758,10 @@ type OakPupilJourneyListItemProps<C extends ElementType> = {
|
|
|
3939
3758
|
/**
|
|
3940
3759
|
* Enables navigation to the given section of a lesson as well as displaying current progress
|
|
3941
3760
|
*/
|
|
3942
|
-
declare const OakPupilJourneyListItem: <C extends ElementType = "a">(props: OakPupilJourneyListItemProps<C>) =>
|
|
3761
|
+
declare const OakPupilJourneyListItem: <C extends ElementType = "a">(props: OakPupilJourneyListItemProps<C>) => React$1.JSX.Element;
|
|
3943
3762
|
|
|
3944
3763
|
type OakPupilJourneyListItemSubheadingProps = {
|
|
3945
|
-
textSlot?:
|
|
3764
|
+
textSlot?: React$1.ReactNode;
|
|
3946
3765
|
} & OakBulletListProps;
|
|
3947
3766
|
/**
|
|
3948
3767
|
* This component displays a heading for the previous lessons
|
|
@@ -3952,7 +3771,7 @@ type OakPupilJourneyListItemSubheadingProps = {
|
|
|
3952
3771
|
* textSlot? - Can pass if any react node, but <OakPupilJourneyListCounter /> is recommended
|
|
3953
3772
|
*
|
|
3954
3773
|
*/
|
|
3955
|
-
declare const OakPupilJourneyListItemSubheading: (props: OakPupilJourneyListItemSubheadingProps) =>
|
|
3774
|
+
declare const OakPupilJourneyListItemSubheading: (props: OakPupilJourneyListItemSubheadingProps) => React$1.JSX.Element;
|
|
3956
3775
|
|
|
3957
3776
|
type OakPupilJourneyOptionalityButtonProps<C extends ElementType> = {
|
|
3958
3777
|
/**
|
|
@@ -3969,10 +3788,10 @@ type OakPupilJourneyOptionalityButtonProps<C extends ElementType> = {
|
|
|
3969
3788
|
/**
|
|
3970
3789
|
* Button for units with optionality it is only used as the child of the PupilJourneyOptionailityitem component
|
|
3971
3790
|
*/
|
|
3972
|
-
declare const OakPupilJourneyOptionalityButton: <C extends ElementType = "a">(props: OakPupilJourneyOptionalityButtonProps<C>) =>
|
|
3791
|
+
declare const OakPupilJourneyOptionalityButton: <C extends ElementType = "a">(props: OakPupilJourneyOptionalityButtonProps<C>) => React$1.JSX.Element;
|
|
3973
3792
|
|
|
3974
3793
|
type OakPupilJourneyOptionalityItemProps = {
|
|
3975
|
-
children:
|
|
3794
|
+
children: React$1.ReactNode;
|
|
3976
3795
|
index: number;
|
|
3977
3796
|
title: string;
|
|
3978
3797
|
unavailable?: boolean;
|
|
@@ -3983,13 +3802,13 @@ type OakPupilJourneyOptionalityItemProps = {
|
|
|
3983
3802
|
* OakPupilJourneyOptionalityItem is a styled container to be used for units with optionality, OakPupilJourneyOptionalityButton should be used as children
|
|
3984
3803
|
*
|
|
3985
3804
|
*/
|
|
3986
|
-
declare const OakPupilJourneyOptionalityItem: (props: OakPupilJourneyOptionalityItemProps) =>
|
|
3805
|
+
declare const OakPupilJourneyOptionalityItem: (props: OakPupilJourneyOptionalityItemProps) => React$1.JSX.Element;
|
|
3987
3806
|
|
|
3988
3807
|
type OakPupilJourneyProgrammeOptionsProps = {
|
|
3989
|
-
children:
|
|
3808
|
+
children: React$1.ReactNode;
|
|
3990
3809
|
phase: "primary" | "secondary";
|
|
3991
|
-
titleSlot?:
|
|
3992
|
-
optionTitleSlot:
|
|
3810
|
+
titleSlot?: React$1.ReactNode;
|
|
3811
|
+
optionTitleSlot: React$1.ReactNode;
|
|
3993
3812
|
};
|
|
3994
3813
|
/**
|
|
3995
3814
|
*
|
|
@@ -3997,7 +3816,7 @@ type OakPupilJourneyProgrammeOptionsProps = {
|
|
|
3997
3816
|
*
|
|
3998
3817
|
*
|
|
3999
3818
|
*/
|
|
4000
|
-
declare const OakPupilJourneyProgrammeOptions: ({ children, phase, titleSlot, optionTitleSlot, }: OakPupilJourneyProgrammeOptionsProps) =>
|
|
3819
|
+
declare const OakPupilJourneyProgrammeOptions: ({ children, phase, titleSlot, optionTitleSlot, }: OakPupilJourneyProgrammeOptionsProps) => React$1.JSX.Element;
|
|
4001
3820
|
|
|
4002
3821
|
type MenuItem = {
|
|
4003
3822
|
displayText: string;
|
|
@@ -4019,7 +3838,7 @@ type OakPupilJourneyUnitsFilterProps = {
|
|
|
4019
3838
|
* onSelected: Callback when a menu item is selected, takes the selected item as an argument
|
|
4020
3839
|
*
|
|
4021
3840
|
*/
|
|
4022
|
-
declare const OakPupilJourneyUnitsFilter: (props: OakPupilJourneyUnitsFilterProps) =>
|
|
3841
|
+
declare const OakPupilJourneyUnitsFilter: (props: OakPupilJourneyUnitsFilterProps) => React$1.JSX.Element;
|
|
4023
3842
|
|
|
4024
3843
|
type OakPupilJourneyYearButtonProps = {
|
|
4025
3844
|
phase: "primary" | "secondary";
|
|
@@ -4038,7 +3857,7 @@ type OakPupilJourneyYearButtonProps = {
|
|
|
4038
3857
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
4039
3858
|
* called after a mouseEnter and mouseLeave event has happened
|
|
4040
3859
|
*/
|
|
4041
|
-
declare const OakPupilJourneyYearButton: <C extends ElementType = "button">({ phase, element, ...rest }: OakPupilJourneyYearButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
3860
|
+
declare const OakPupilJourneyYearButton: <C extends ElementType = "button">({ phase, element, ...rest }: OakPupilJourneyYearButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
4042
3861
|
|
|
4043
3862
|
type OakQuizHintProps = {
|
|
4044
3863
|
/**
|
|
@@ -4053,7 +3872,7 @@ type OakQuizHintProps = {
|
|
|
4053
3872
|
/**
|
|
4054
3873
|
* Presents a button which will show a hint when clicked
|
|
4055
3874
|
*/
|
|
4056
|
-
declare const OakQuizHint: ({ hint, id, hintToggled }: OakQuizHintProps) =>
|
|
3875
|
+
declare const OakQuizHint: ({ hint, id, hintToggled }: OakQuizHintProps) => React$1.JSX.Element;
|
|
4057
3876
|
|
|
4058
3877
|
type OakQuizFeedbackProps = {
|
|
4059
3878
|
/**
|
|
@@ -4073,7 +3892,7 @@ type OakQuizFeedbackProps = {
|
|
|
4073
3892
|
/**
|
|
4074
3893
|
* Gives feedback after a question has been answered
|
|
4075
3894
|
*/
|
|
4076
|
-
declare const OakQuizFeedback: ({ feedback, answerFeedback, }: OakQuizFeedbackProps) =>
|
|
3895
|
+
declare const OakQuizFeedback: ({ feedback, answerFeedback, }: OakQuizFeedbackProps) => React$1.JSX.Element;
|
|
4077
3896
|
|
|
4078
3897
|
type OakLessonBottomNavProps = {
|
|
4079
3898
|
children?: ReactNode;
|
|
@@ -4087,7 +3906,7 @@ type OakLessonBottomNavProps = {
|
|
|
4087
3906
|
/**
|
|
4088
3907
|
* Renders feedback for an answer and onward navigation buttons to continue the lesson
|
|
4089
3908
|
*/
|
|
4090
|
-
declare const OakLessonBottomNav: ({ hint, hintToggled, feedback, answerFeedback, children, }: OakLessonBottomNavProps) =>
|
|
3909
|
+
declare const OakLessonBottomNav: ({ hint, hintToggled, feedback, answerFeedback, children, }: OakLessonBottomNavProps) => React$1.JSX.Element;
|
|
4091
3910
|
|
|
4092
3911
|
declare const lessonSectionNames: string[];
|
|
4093
3912
|
type LessonSectionName$1 = (typeof lessonSectionNames)[number];
|
|
@@ -4103,7 +3922,7 @@ type OakLessonLayoutProps = {
|
|
|
4103
3922
|
/**
|
|
4104
3923
|
* Provides overall page layout and colours for the sections of a lesson.
|
|
4105
3924
|
*/
|
|
4106
|
-
declare const OakLessonLayout: ({ lessonSectionName, phase, celebrate, topNavSlot, bottomNavSlot, children, }: OakLessonLayoutProps) =>
|
|
3925
|
+
declare const OakLessonLayout: ({ lessonSectionName, phase, celebrate, topNavSlot, bottomNavSlot, children, }: OakLessonLayoutProps) => React$1.JSX.Element;
|
|
4107
3926
|
|
|
4108
3927
|
type BaseOakLessonNavItemProps<C extends ElementType> = {
|
|
4109
3928
|
as?: C;
|
|
@@ -4143,7 +3962,7 @@ type OakLessonNavItemProps<C extends ElementType> = BaseOakLessonNavItemProps<C>
|
|
|
4143
3962
|
/**
|
|
4144
3963
|
* Enables navigation to the given section of a lesson as well as displaying current progress
|
|
4145
3964
|
*/
|
|
4146
|
-
declare const OakLessonNavItem: <C extends ElementType = "a">(props: OakLessonNavItemProps<C>) =>
|
|
3965
|
+
declare const OakLessonNavItem: <C extends ElementType = "a">(props: OakLessonNavItemProps<C>) => React$1.JSX.Element;
|
|
4147
3966
|
|
|
4148
3967
|
type LessonSectionName = "intro" | "video";
|
|
4149
3968
|
type BaseOakLessonReviewItemProps$1 = {
|
|
@@ -4158,7 +3977,7 @@ type IntroSectionProps$1 = {
|
|
|
4158
3977
|
type OakLessonReviewIntroVideoProps = BaseOakLessonReviewItemProps$1 & {
|
|
4159
3978
|
lessonSectionName: LessonSectionName;
|
|
4160
3979
|
} & (IntroSectionProps$1 | VideoSectionProps$1);
|
|
4161
|
-
declare const OakLessonReviewIntroVideo: (props: OakLessonReviewIntroVideoProps) =>
|
|
3980
|
+
declare const OakLessonReviewIntroVideo: (props: OakLessonReviewIntroVideoProps) => React$1.JSX.Element;
|
|
4162
3981
|
|
|
4163
3982
|
type BaseOakLessonReviewItemProps = {
|
|
4164
3983
|
completed: boolean;
|
|
@@ -4181,7 +4000,7 @@ type IntroSectionProps = {
|
|
|
4181
4000
|
lessonSectionName: "intro";
|
|
4182
4001
|
};
|
|
4183
4002
|
type OakLessonReviewItemProps = BaseOakLessonReviewItemProps & (IntroSectionProps | QuizSectionProps | VideoSectionProps);
|
|
4184
|
-
declare const OakLessonReviewItem: (props: OakLessonReviewItemProps) =>
|
|
4003
|
+
declare const OakLessonReviewItem: (props: OakLessonReviewItemProps) => React$1.JSX.Element;
|
|
4185
4004
|
|
|
4186
4005
|
type LessonQuizName = "starter-quiz" | "exit-quiz";
|
|
4187
4006
|
type OakLessonReviewQuizProps = {
|
|
@@ -4198,21 +4017,21 @@ type OakLessonReviewQuizProps = {
|
|
|
4198
4017
|
/**
|
|
4199
4018
|
* You MUST use the OakLessonExpandableReviewItem as the container component for this slot
|
|
4200
4019
|
*/
|
|
4201
|
-
resultsSlot?:
|
|
4020
|
+
resultsSlot?: React$1.ReactNode;
|
|
4202
4021
|
};
|
|
4203
4022
|
type OakLessonReviewItemContainerProps = {
|
|
4204
4023
|
$background?: OakUiRoleToken;
|
|
4205
4024
|
$borderColor?: OakUiRoleToken;
|
|
4206
|
-
children:
|
|
4025
|
+
children: React$1.ReactNode;
|
|
4207
4026
|
};
|
|
4208
|
-
declare const ReviewItemContainer: (props: OakLessonReviewItemContainerProps) =>
|
|
4027
|
+
declare const ReviewItemContainer: (props: OakLessonReviewItemContainerProps) => React$1.JSX.Element;
|
|
4209
4028
|
type ReviewItemTitleSectionProps = {
|
|
4210
4029
|
sectionHeader: string;
|
|
4211
4030
|
completed: boolean;
|
|
4212
4031
|
summaryForIncomplete: ReactNode;
|
|
4213
4032
|
};
|
|
4214
|
-
declare const ReviewItemTitleSection: (props: ReviewItemTitleSectionProps) =>
|
|
4215
|
-
declare const OakLessonReviewQuiz: (props: OakLessonReviewQuizProps) =>
|
|
4033
|
+
declare const ReviewItemTitleSection: (props: ReviewItemTitleSectionProps) => React$1.JSX.Element;
|
|
4034
|
+
declare const OakLessonReviewQuiz: (props: OakLessonReviewQuizProps) => React$1.JSX.Element;
|
|
4216
4035
|
|
|
4217
4036
|
type LessonTopNavSectionName = Omit<LessonSectionName$1, "overview" | "review">;
|
|
4218
4037
|
type OakLessonTopNavProps = {
|
|
@@ -4235,7 +4054,7 @@ type OakLessonTopNavProps = {
|
|
|
4235
4054
|
/**
|
|
4236
4055
|
* Controls for navigating back and displaying progress in a lesson
|
|
4237
4056
|
*/
|
|
4238
|
-
declare const OakLessonTopNav: ({ lessonSectionName, backLinkSlot, counterSlot, heading, mobileSummary, }: OakLessonTopNavProps) =>
|
|
4057
|
+
declare const OakLessonTopNav: ({ lessonSectionName, backLinkSlot, counterSlot, heading, mobileSummary, }: OakLessonTopNavProps) => React$1.JSX.Element;
|
|
4239
4058
|
|
|
4240
4059
|
type OakLessonVideoTranscriptProps = {
|
|
4241
4060
|
/**
|
|
@@ -4257,7 +4076,7 @@ type OakLessonVideoTranscriptProps = {
|
|
|
4257
4076
|
/**
|
|
4258
4077
|
* Display a togglable video transcript with a slot to display a sign language control
|
|
4259
4078
|
*/
|
|
4260
|
-
declare const OakLessonVideoTranscript: ({ children, id, signLanguageControl, transcriptToggled, }: OakLessonVideoTranscriptProps) =>
|
|
4079
|
+
declare const OakLessonVideoTranscript: ({ children, id, signLanguageControl, transcriptToggled, }: OakLessonVideoTranscriptProps) => React$1.JSX.Element;
|
|
4261
4080
|
|
|
4262
4081
|
type OakHintButtonProps = {
|
|
4263
4082
|
isOpen: boolean;
|
|
@@ -4279,13 +4098,13 @@ type OakHintButtonProps = {
|
|
|
4279
4098
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
4280
4099
|
* called after a mouseEnter and mouseLeave event has happened
|
|
4281
4100
|
*/
|
|
4282
|
-
declare const OakHintButton: (props: OakHintButtonProps) =>
|
|
4101
|
+
declare const OakHintButton: (props: OakHintButtonProps) => React$1.JSX.Element;
|
|
4283
4102
|
|
|
4284
4103
|
type OakQuizCheckBoxProps = Omit<BaseCheckBoxProps, "defaultChecked"> & {
|
|
4285
4104
|
feedback?: "correct" | "incorrect" | null;
|
|
4286
|
-
image?:
|
|
4287
|
-
innerRef?:
|
|
4288
|
-
displayValue?: string |
|
|
4105
|
+
image?: React$1.JSX.Element;
|
|
4106
|
+
innerRef?: React$1.RefObject<HTMLInputElement>;
|
|
4107
|
+
displayValue?: string | React$1.JSX.Element;
|
|
4289
4108
|
/**
|
|
4290
4109
|
* Give the field a highlight to draw attention to it
|
|
4291
4110
|
*/
|
|
@@ -4294,7 +4113,7 @@ type OakQuizCheckBoxProps = Omit<BaseCheckBoxProps, "defaultChecked"> & {
|
|
|
4294
4113
|
/**
|
|
4295
4114
|
* A checkbox representing the options in a multiple choice question.
|
|
4296
4115
|
*/
|
|
4297
|
-
declare const OakQuizCheckBox: (props: OakQuizCheckBoxProps) =>
|
|
4116
|
+
declare const OakQuizCheckBox: (props: OakQuizCheckBoxProps) => React$1.JSX.Element;
|
|
4298
4117
|
|
|
4299
4118
|
type OakQuizCounterProps = {
|
|
4300
4119
|
counter: number;
|
|
@@ -4303,7 +4122,7 @@ type OakQuizCounterProps = {
|
|
|
4303
4122
|
/**
|
|
4304
4123
|
* A counter representing progress through the questions in a quiz
|
|
4305
4124
|
*/
|
|
4306
|
-
declare const OakQuizCounter: (props: OakQuizCounterProps) =>
|
|
4125
|
+
declare const OakQuizCounter: (props: OakQuizCounterProps) => React$1.JSX.Element;
|
|
4307
4126
|
|
|
4308
4127
|
declare const OakQuizMatchItemId: (id: string) => string;
|
|
4309
4128
|
type DraggableItem = {
|
|
@@ -4348,7 +4167,7 @@ type OakQuizMatchProps = {
|
|
|
4348
4167
|
*
|
|
4349
4168
|
* Keyboard navigation is supported with the `tab`, `space` and `arrow` keys
|
|
4350
4169
|
*/
|
|
4351
|
-
declare const OakQuizMatch: ({ initialOptions, initialSlots, isHighlighted, onChange, }: OakQuizMatchProps) =>
|
|
4170
|
+
declare const OakQuizMatch: ({ initialOptions, initialSlots, isHighlighted, onChange, }: OakQuizMatchProps) => React$1.JSX.Element;
|
|
4352
4171
|
declare const announcements: Announcements;
|
|
4353
4172
|
|
|
4354
4173
|
type OakQuizOrderItem = {
|
|
@@ -4378,7 +4197,7 @@ type OakQuizOrderProps = {
|
|
|
4378
4197
|
*
|
|
4379
4198
|
* Keyboard navigation is supported with the `tab`, `space` and `arrow` keys
|
|
4380
4199
|
*/
|
|
4381
|
-
declare const OakQuizOrder: ({ initialItems, announcements, onChange, isHighlighted, }: OakQuizOrderProps) =>
|
|
4200
|
+
declare const OakQuizOrder: ({ initialItems, announcements, onChange, isHighlighted, }: OakQuizOrderProps) => React$1.JSX.Element;
|
|
4382
4201
|
|
|
4383
4202
|
type OakQuizPrintableHeaderProps = {
|
|
4384
4203
|
title: string;
|
|
@@ -4396,7 +4215,7 @@ type OakQuizPrintableHeaderProps = {
|
|
|
4396
4215
|
*
|
|
4397
4216
|
*
|
|
4398
4217
|
*/
|
|
4399
|
-
declare const OakQuizPrintableHeader: ({ title, iconName, alt, breadcrumbs, worksheetDownloaded, workSheetAvailable, videoPercentage, }: OakQuizPrintableHeaderProps) =>
|
|
4218
|
+
declare const OakQuizPrintableHeader: ({ title, iconName, alt, breadcrumbs, worksheetDownloaded, workSheetAvailable, videoPercentage, }: OakQuizPrintableHeaderProps) => React$1.JSX.Element;
|
|
4400
4219
|
|
|
4401
4220
|
type OakQuizPrintableSubHeaderProps = {
|
|
4402
4221
|
title: string;
|
|
@@ -4410,7 +4229,7 @@ type OakQuizPrintableSubHeaderProps = {
|
|
|
4410
4229
|
*
|
|
4411
4230
|
*
|
|
4412
4231
|
*/
|
|
4413
|
-
declare const OakQuizPrintableSubHeader: ({ title, grade, numQuestions, attempts, }: OakQuizPrintableSubHeaderProps) =>
|
|
4232
|
+
declare const OakQuizPrintableSubHeader: ({ title, grade, numQuestions, attempts, }: OakQuizPrintableSubHeaderProps) => React$1.JSX.Element;
|
|
4414
4233
|
|
|
4415
4234
|
type OakQuizRadioButtonProps = OakRadioButtonProps & {
|
|
4416
4235
|
/**
|
|
@@ -4431,7 +4250,7 @@ type OakQuizRadioButtonProps = OakRadioButtonProps & {
|
|
|
4431
4250
|
*
|
|
4432
4251
|
* Use with `OakRadioGroup` to create a group of radio buttons.
|
|
4433
4252
|
*/
|
|
4434
|
-
declare const OakQuizRadioButton: (props: OakQuizRadioButtonProps) =>
|
|
4253
|
+
declare const OakQuizRadioButton: (props: OakQuizRadioButtonProps) => React$1.JSX.Element;
|
|
4435
4254
|
|
|
4436
4255
|
type InternalQuizResultItemProps = {
|
|
4437
4256
|
feedbackState?: "correct" | "incorrect" | null;
|
|
@@ -4450,7 +4269,7 @@ type InternalQuizResultItemProps = {
|
|
|
4450
4269
|
*
|
|
4451
4270
|
* NB. We must export a styled component for it to be inheritable
|
|
4452
4271
|
*/
|
|
4453
|
-
declare const OakQuizResultItem: ({ standardText, boldPrefixText, feedbackState, imageURL, imageAlt, }: InternalQuizResultItemProps) =>
|
|
4272
|
+
declare const OakQuizResultItem: ({ standardText, boldPrefixText, feedbackState, imageURL, imageAlt, }: InternalQuizResultItemProps) => React$1.JSX.Element;
|
|
4454
4273
|
|
|
4455
4274
|
type OakQuizTextInputProps = Omit<OakTextInputProps, "validity" | "iconName" | "iconAlt" | "isTrailingIcon"> & {
|
|
4456
4275
|
/**
|
|
@@ -4462,7 +4281,7 @@ type OakQuizTextInputProps = Omit<OakTextInputProps, "validity" | "iconName" | "
|
|
|
4462
4281
|
/**
|
|
4463
4282
|
* A text input for a free-text question in a quiz
|
|
4464
4283
|
*/
|
|
4465
|
-
declare const OakQuizTextInput: ({ feedback, readOnly, ...props }: OakQuizTextInputProps) =>
|
|
4284
|
+
declare const OakQuizTextInput: ({ feedback, readOnly, ...props }: OakQuizTextInputProps) => React$1.JSX.Element;
|
|
4466
4285
|
|
|
4467
4286
|
type OakBackLinkProps<C extends ElementType> = {
|
|
4468
4287
|
as?: C;
|
|
@@ -4479,7 +4298,7 @@ type OakBackLinkProps<C extends ElementType> = {
|
|
|
4479
4298
|
* * Button `<OakBackLink as="button" onClick={() => goBack(-1)} />`
|
|
4480
4299
|
*
|
|
4481
4300
|
*/
|
|
4482
|
-
declare const OakBackLink: <C extends ElementType = "a">({ as, label, ...props }: OakBackLinkProps<C>) =>
|
|
4301
|
+
declare const OakBackLink: <C extends ElementType = "a">({ as, label, ...props }: OakBackLinkProps<C>) => React$1.JSX.Element;
|
|
4483
4302
|
|
|
4484
4303
|
type InternalCardProps = OakFlexProps;
|
|
4485
4304
|
|
|
@@ -4497,7 +4316,7 @@ type OakCardWithHandDrawnBorderProps = Omit<InternalCardWithBackgroundElementPro
|
|
|
4497
4316
|
*
|
|
4498
4317
|
* An optional `stroke` and `fill` can be applied to change the color of the border
|
|
4499
4318
|
*/
|
|
4500
|
-
declare const OakCardWithHandDrawnBorder: ({ $pa, fill, stroke, $width, ...props }: OakCardWithHandDrawnBorderProps) =>
|
|
4319
|
+
declare const OakCardWithHandDrawnBorder: ({ $pa, fill, stroke, $width, ...props }: OakCardWithHandDrawnBorderProps) => React$1.JSX.Element;
|
|
4501
4320
|
|
|
4502
4321
|
type OakCopyLinkButtonProps = {
|
|
4503
4322
|
/**
|
|
@@ -4508,21 +4327,21 @@ type OakCopyLinkButtonProps = {
|
|
|
4508
4327
|
/**
|
|
4509
4328
|
* Display copy link button
|
|
4510
4329
|
*/
|
|
4511
|
-
declare const OakCopyLinkButton: ({ href }: OakCopyLinkButtonProps) =>
|
|
4330
|
+
declare const OakCopyLinkButton: ({ href }: OakCopyLinkButtonProps) => React$1.JSX.Element;
|
|
4512
4331
|
|
|
4513
4332
|
type OakDownloadCardProps = BaseCheckBoxProps & {
|
|
4514
4333
|
/**
|
|
4515
4334
|
* The primary title content for the download.
|
|
4516
4335
|
*/
|
|
4517
|
-
title:
|
|
4336
|
+
title: React$1.ReactNode;
|
|
4518
4337
|
/**
|
|
4519
4338
|
* Optional file size content shown beneath the title.
|
|
4520
4339
|
*/
|
|
4521
|
-
fileSize?:
|
|
4340
|
+
fileSize?: React$1.ReactNode;
|
|
4522
4341
|
/**
|
|
4523
4342
|
* The file format or secondary metadata shown beneath the title.
|
|
4524
4343
|
*/
|
|
4525
|
-
format:
|
|
4344
|
+
format: React$1.ReactNode;
|
|
4526
4345
|
/**
|
|
4527
4346
|
* The icon used to represent the download type.
|
|
4528
4347
|
*/
|
|
@@ -4541,12 +4360,12 @@ type OakDownloadCardProps = BaseCheckBoxProps & {
|
|
|
4541
4360
|
* such as lesson plans, slide decks, or worksheets.
|
|
4542
4361
|
* Design document: <https://www.figma.com/design/YcWQMMhHPVVmc47cHHEEAl/Oak-Design-Kit?node-id=14795-5603>
|
|
4543
4362
|
*/
|
|
4544
|
-
declare const OakDownloadCard: (props: OakDownloadCardProps) =>
|
|
4363
|
+
declare const OakDownloadCard: (props: OakDownloadCardProps) => React$1.JSX.Element;
|
|
4545
4364
|
|
|
4546
4365
|
/**
|
|
4547
4366
|
* Displays instructions for drag and drop functionality
|
|
4548
4367
|
*/
|
|
4549
|
-
declare const OakDragAndDropInstructions: (props: ComponentPropsWithoutRef<typeof OakFlex>) =>
|
|
4368
|
+
declare const OakDragAndDropInstructions: (props: ComponentPropsWithoutRef<typeof OakFlex>) => React$1.JSX.Element;
|
|
4550
4369
|
|
|
4551
4370
|
type OakDraggableProps = {
|
|
4552
4371
|
/**
|
|
@@ -4599,7 +4418,7 @@ type OakDraggableFeedbackProps = ComponentPropsWithoutRef<typeof OakDraggable> &
|
|
|
4599
4418
|
/**
|
|
4600
4419
|
* A draggable element that visually indicates whether or not its state is correct or not
|
|
4601
4420
|
*/
|
|
4602
|
-
declare const OakDraggableFeedback: ({ feedback, ...props }: OakDraggableFeedbackProps) =>
|
|
4421
|
+
declare const OakDraggableFeedback: ({ feedback, ...props }: OakDraggableFeedbackProps) => React$1.JSX.Element;
|
|
4603
4422
|
|
|
4604
4423
|
type OakDroppableProps = {
|
|
4605
4424
|
/**
|
|
@@ -4687,7 +4506,7 @@ type OakFilterDrawerProps = {
|
|
|
4687
4506
|
* clearAllInputs: used to clear filter options
|
|
4688
4507
|
*
|
|
4689
4508
|
*/
|
|
4690
|
-
declare const OakFilterDrawer: ({ isOpen, domContainer, onClose, zIndex, children, clearAllInputs, footerSlot, ...rest }: OakFilterDrawerProps) =>
|
|
4509
|
+
declare const OakFilterDrawer: ({ isOpen, domContainer, onClose, zIndex, children, clearAllInputs, footerSlot, ...rest }: OakFilterDrawerProps) => React$1.ReactPortal | null;
|
|
4691
4510
|
|
|
4692
4511
|
interface OakFormInputWithLabelsProps {
|
|
4693
4512
|
/**
|
|
@@ -4730,17 +4549,17 @@ interface OakFormInputWithLabelsProps {
|
|
|
4730
4549
|
/**
|
|
4731
4550
|
* Callback function that is called when the input value changes.
|
|
4732
4551
|
*/
|
|
4733
|
-
onChange?:
|
|
4552
|
+
onChange?: React$1.ChangeEventHandler<HTMLInputElement>;
|
|
4734
4553
|
/**
|
|
4735
4554
|
* Callback function that is called when the input is focused initially.
|
|
4736
4555
|
*/
|
|
4737
|
-
onInitialFocus?:
|
|
4556
|
+
onInitialFocus?: React$1.FocusEventHandler<HTMLInputElement>;
|
|
4738
4557
|
/**
|
|
4739
4558
|
* Callback function that is called when the input loses focus.
|
|
4740
4559
|
*/
|
|
4741
|
-
onBlur?:
|
|
4560
|
+
onBlur?: React$1.FocusEventHandler<HTMLInputElement>;
|
|
4742
4561
|
}
|
|
4743
|
-
declare const OakFormInputWithLabels: ({ label, helperText, placeholder, invalid, invalidText, value, inputName, disabled, required, defaultValue, onChange, onInitialFocus, onBlur, }: OakFormInputWithLabelsProps) =>
|
|
4562
|
+
declare const OakFormInputWithLabels: ({ label, helperText, placeholder, invalid, invalidText, value, inputName, disabled, required, defaultValue, onChange, onInitialFocus, onBlur, }: OakFormInputWithLabelsProps) => React$1.JSX.Element;
|
|
4744
4563
|
|
|
4745
4564
|
type OakHandDrawnCardProps = Omit<InternalCardWithBackgroundElementProps, "backgroundElement"> & {
|
|
4746
4565
|
fill?: InternalStyledSvgProps["$fill"];
|
|
@@ -4752,7 +4571,7 @@ type OakHandDrawnCardProps = Omit<InternalCardWithBackgroundElementProps, "backg
|
|
|
4752
4571
|
*
|
|
4753
4572
|
* An optional `stroke` and `strokeWidth` can be applied to give the background a border
|
|
4754
4573
|
*/
|
|
4755
|
-
declare const OakHandDrawnCard: ({ $pa, fill, stroke, strokeWidth, $width, ...props }: OakHandDrawnCardProps) =>
|
|
4574
|
+
declare const OakHandDrawnCard: ({ $pa, fill, stroke, strokeWidth, $width, ...props }: OakHandDrawnCardProps) => React$1.JSX.Element;
|
|
4756
4575
|
|
|
4757
4576
|
type OakHandDrawnBoxWithIconProps = Omit<OakHandDrawnCardProps, "children"> & {
|
|
4758
4577
|
iconName: OakIconProps["iconName"];
|
|
@@ -4764,7 +4583,7 @@ type OakHandDrawnBoxWithIconProps = Omit<OakHandDrawnCardProps, "children"> & {
|
|
|
4764
4583
|
/**
|
|
4765
4584
|
* A hand-drawn card with an icon in the center
|
|
4766
4585
|
*/
|
|
4767
|
-
declare const OakHandDrawnCardWithIcon: ({ iconName, iconColor, iconWidth, iconHeight, alt, $width, $height, $alignItems, $justifyContent, ...props }: OakHandDrawnBoxWithIconProps) =>
|
|
4586
|
+
declare const OakHandDrawnCardWithIcon: ({ iconName, iconColor, iconWidth, iconHeight, alt, $width, $height, $alignItems, $justifyContent, ...props }: OakHandDrawnBoxWithIconProps) => React$1.JSX.Element;
|
|
4768
4587
|
|
|
4769
4588
|
type OakHandDrawnHRProps = {
|
|
4770
4589
|
hrColor?: InternalStyledSvgProps["$fill"];
|
|
@@ -4776,7 +4595,7 @@ type OakHandDrawnHRProps = {
|
|
|
4776
4595
|
*
|
|
4777
4596
|
* change the sizeProps of the flex container to change the size and dimentions of the HR
|
|
4778
4597
|
*/
|
|
4779
|
-
declare const OakHandDrawnHR: (props: OakHandDrawnHRProps) =>
|
|
4598
|
+
declare const OakHandDrawnHR: (props: OakHandDrawnHRProps) => React$1.JSX.Element;
|
|
4780
4599
|
|
|
4781
4600
|
type OakInfoButtonProps = {
|
|
4782
4601
|
onClick: MouseEventHandler;
|
|
@@ -4791,24 +4610,24 @@ type OakInfoButtonProps = {
|
|
|
4791
4610
|
* onClick: MouseEventHandler
|
|
4792
4611
|
*
|
|
4793
4612
|
*/
|
|
4794
|
-
declare const OakInfoButton: (props: OakInfoButtonProps) =>
|
|
4613
|
+
declare const OakInfoButton: (props: OakInfoButtonProps) => React$1.JSX.Element;
|
|
4795
4614
|
|
|
4796
4615
|
type OakInfoCardProps = {
|
|
4797
|
-
children:
|
|
4616
|
+
children: React$1.ReactNode;
|
|
4798
4617
|
};
|
|
4799
4618
|
type OakCardHeaderprops = {
|
|
4800
4619
|
iconName: OakIconName;
|
|
4801
4620
|
tag: OakHeadingTag;
|
|
4802
4621
|
children: string;
|
|
4803
4622
|
};
|
|
4804
|
-
declare const OakCardHeader: (props: OakCardHeaderprops) =>
|
|
4623
|
+
declare const OakCardHeader: (props: OakCardHeaderprops) => React$1.JSX.Element;
|
|
4805
4624
|
/**
|
|
4806
4625
|
*
|
|
4807
4626
|
* OakLessonInfoCards are created using the custom card either oakLessoninfoCard or oakStaticMessageCard and the content is added as children. And use the oakCardHeader to create the header of the card.
|
|
4808
4627
|
*
|
|
4809
4628
|
*/
|
|
4810
|
-
declare const OakLessonInfoCard: (props: OakInfoCardProps) =>
|
|
4811
|
-
declare const OakStaticMessageCard: (props: OakInfoCardProps) =>
|
|
4629
|
+
declare const OakLessonInfoCard: (props: OakInfoCardProps) => React$1.JSX.Element;
|
|
4630
|
+
declare const OakStaticMessageCard: (props: OakInfoCardProps) => React$1.JSX.Element;
|
|
4812
4631
|
|
|
4813
4632
|
type OakLinkCardProps = {
|
|
4814
4633
|
/**
|
|
@@ -4864,7 +4683,7 @@ type OakLinkCardProps = {
|
|
|
4864
4683
|
* - **showNew** - Whether to display the "New" promo tag
|
|
4865
4684
|
* - **narrow** - Whether to display the card in a narrow layout
|
|
4866
4685
|
*/
|
|
4867
|
-
declare const OakLinkCard: ({ mainSection, iconName, iconAlt, iconColor, iconFill, href, showNew, hasAnimation, narrow, }: OakLinkCardProps) =>
|
|
4686
|
+
declare const OakLinkCard: ({ mainSection, iconName, iconAlt, iconColor, iconFill, href, showNew, hasAnimation, narrow, }: OakLinkCardProps) => React$1.JSX.Element;
|
|
4868
4687
|
|
|
4869
4688
|
type OakSolidBorderAccordionProps = {
|
|
4870
4689
|
/**
|
|
@@ -4887,7 +4706,7 @@ type OakSolidBorderAccordionProps = {
|
|
|
4887
4706
|
/**
|
|
4888
4707
|
* An accordion component that can be used to show/hide content
|
|
4889
4708
|
*/
|
|
4890
|
-
declare const OakMediaClipListAccordion: ({ header, children, id, initialOpen, ...styleProps }: OakSolidBorderAccordionProps) =>
|
|
4709
|
+
declare const OakMediaClipListAccordion: ({ header, children, id, initialOpen, ...styleProps }: OakSolidBorderAccordionProps) => React$1.JSX.Element;
|
|
4891
4710
|
|
|
4892
4711
|
type OakOutlineAccordionProps = {
|
|
4893
4712
|
/**
|
|
@@ -4910,7 +4729,7 @@ type OakOutlineAccordionProps = {
|
|
|
4910
4729
|
/**
|
|
4911
4730
|
* An accordion component that can be used to show/hide content
|
|
4912
4731
|
*/
|
|
4913
|
-
declare const OakOutlineAccordion: ({ header, children, id, initialOpen, ...styleProps }: OakOutlineAccordionProps) =>
|
|
4732
|
+
declare const OakOutlineAccordion: ({ header, children, id, initialOpen, ...styleProps }: OakOutlineAccordionProps) => React$1.JSX.Element;
|
|
4914
4733
|
|
|
4915
4734
|
type OakPromoTagProps = {
|
|
4916
4735
|
width?: SizeStyleProps["$width"];
|
|
@@ -4919,7 +4738,7 @@ type OakPromoTagProps = {
|
|
|
4919
4738
|
/**
|
|
4920
4739
|
* Renders a tag with the text "New"
|
|
4921
4740
|
*/
|
|
4922
|
-
declare const OakPromoTag: (props: OakPromoTagProps) =>
|
|
4741
|
+
declare const OakPromoTag: (props: OakPromoTagProps) => React$1.JSX.Element;
|
|
4923
4742
|
|
|
4924
4743
|
type TileItem = {
|
|
4925
4744
|
id: string;
|
|
@@ -4932,7 +4751,7 @@ type OakRadioTileProps = {
|
|
|
4932
4751
|
id: string;
|
|
4933
4752
|
onChange: (tileItem: TileItem) => void;
|
|
4934
4753
|
};
|
|
4935
|
-
declare const OakRadioTile:
|
|
4754
|
+
declare const OakRadioTile: any;
|
|
4936
4755
|
|
|
4937
4756
|
type OakSaveButtonProps = {
|
|
4938
4757
|
isSaved: boolean;
|
|
@@ -4942,7 +4761,7 @@ type OakSaveButtonProps = {
|
|
|
4942
4761
|
saveButtonId?: string;
|
|
4943
4762
|
title: string;
|
|
4944
4763
|
};
|
|
4945
|
-
declare const OakSaveButton: (props: OakSaveButtonProps) =>
|
|
4764
|
+
declare const OakSaveButton: (props: OakSaveButtonProps) => React$1.JSX.Element;
|
|
4946
4765
|
|
|
4947
4766
|
type OakSaveCountProps = {
|
|
4948
4767
|
/**
|
|
@@ -4958,10 +4777,10 @@ type OakSaveCountProps = {
|
|
|
4958
4777
|
href: string;
|
|
4959
4778
|
loading: boolean;
|
|
4960
4779
|
};
|
|
4961
|
-
declare const OakSaveCount: ({ count, href, loading, label, }: OakSaveCountProps) =>
|
|
4780
|
+
declare const OakSaveCount: ({ count, href, loading, label, }: OakSaveCountProps) => React$1.JSX.Element;
|
|
4962
4781
|
|
|
4963
4782
|
type OakScaleImageButtonProps = Omit<InternalShadowRectButtonProps, "defaultTextColor" | "hoverTextColor" | "disabledTextColor" | "defaultBackground" | "defaultBorderColor" | "hoverBackground" | "hoverBorderColor" | "disabledBackground" | "disabledBorderColor" | "iconGap" | "pv" | "ph" | "$bblr" | "$btlr" | "width" | "onClick"> & {
|
|
4964
|
-
onImageScaleCallback: (event:
|
|
4783
|
+
onImageScaleCallback: (event: React$1.MouseEvent<HTMLButtonElement>) => void;
|
|
4965
4784
|
isExpanded: boolean;
|
|
4966
4785
|
};
|
|
4967
4786
|
/**
|
|
@@ -4974,24 +4793,24 @@ type OakScaleImageButtonProps = Omit<InternalShadowRectButtonProps, "defaultText
|
|
|
4974
4793
|
* `onImageScaleCallback: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;`
|
|
4975
4794
|
*ą
|
|
4976
4795
|
*/
|
|
4977
|
-
declare const OakScaleImageButton: <C extends ElementType = "button">({ onImageScaleCallback, isExpanded, }: OakScaleImageButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
4796
|
+
declare const OakScaleImageButton: <C extends ElementType = "button">({ onImageScaleCallback, isExpanded, }: OakScaleImageButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
4978
4797
|
|
|
4979
4798
|
type OakSignLanguageButtonProps = {
|
|
4980
4799
|
/**
|
|
4981
4800
|
* On click function
|
|
4982
4801
|
*/
|
|
4983
|
-
onClick: (event:
|
|
4802
|
+
onClick: (event: React$1.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
|
|
4984
4803
|
};
|
|
4985
4804
|
/**
|
|
4986
4805
|
* Display a button to toggle sign language
|
|
4987
4806
|
*/
|
|
4988
|
-
declare const OakSignLanguageButton: ({ onClick, }: OakSignLanguageButtonProps) =>
|
|
4807
|
+
declare const OakSignLanguageButton: ({ onClick, }: OakSignLanguageButtonProps) => React$1.JSX.Element;
|
|
4989
4808
|
|
|
4990
4809
|
type OakTimerProps = {
|
|
4991
4810
|
timeCode: number;
|
|
4992
4811
|
} & Omit<OakBoxProps, "onClick" | "label">;
|
|
4993
4812
|
declare const formatTimeCode: (seconds: number) => string;
|
|
4994
|
-
declare const OakTimer: (props: OakTimerProps) =>
|
|
4813
|
+
declare const OakTimer: (props: OakTimerProps) => React$1.JSX.Element;
|
|
4995
4814
|
|
|
4996
4815
|
interface Tier {
|
|
4997
4816
|
tier: string;
|
|
@@ -5016,12 +4835,12 @@ type OakDownloadsJourneyChildSubjectTierSelectorProps = {
|
|
|
5016
4835
|
* once the Next button is pressed to continue on the Downloads journey.
|
|
5017
4836
|
*
|
|
5018
4837
|
*/
|
|
5019
|
-
declare const OakDownloadsJourneyChildSubjectTierSelector:
|
|
4838
|
+
declare const OakDownloadsJourneyChildSubjectTierSelector: any;
|
|
5020
4839
|
|
|
5021
4840
|
type OakCodeRendererProps = {
|
|
5022
4841
|
string: string;
|
|
5023
4842
|
} & TypographyStyleProps & OakBoxProps;
|
|
5024
|
-
declare const OakCodeRenderer: ({ string, ...rest }: OakCodeRendererProps) => string |
|
|
4843
|
+
declare const OakCodeRenderer: ({ string, ...rest }: OakCodeRendererProps) => string | React$1.JSX.Element;
|
|
5025
4844
|
|
|
5026
4845
|
type OakHeaderHeroProps = {
|
|
5027
4846
|
authorImageSrc?: string;
|
|
@@ -5041,7 +4860,7 @@ type OakHeaderHeroProps = {
|
|
|
5041
4860
|
*
|
|
5042
4861
|
* This Oak component can be passed the OWA breadcrumbs component as a prop. Currently this component does not exist in the component library.
|
|
5043
4862
|
*/
|
|
5044
|
-
declare const OakHeaderHero:
|
|
4863
|
+
declare const OakHeaderHero: any;
|
|
5045
4864
|
|
|
5046
4865
|
type OakHomepageTabButtonProps = InternalButtonProps & {
|
|
5047
4866
|
title: string;
|
|
@@ -5049,7 +4868,7 @@ type OakHomepageTabButtonProps = InternalButtonProps & {
|
|
|
5049
4868
|
isActive?: boolean;
|
|
5050
4869
|
showNewIcon?: boolean;
|
|
5051
4870
|
};
|
|
5052
|
-
declare const OakHomepageTabButton: <C extends ElementType = "button">(props: OakHomepageTabButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
4871
|
+
declare const OakHomepageTabButton: <C extends ElementType = "button">(props: OakHomepageTabButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
5053
4872
|
|
|
5054
4873
|
type OakInfoProps = {
|
|
5055
4874
|
/**
|
|
@@ -5064,22 +4883,22 @@ type OakInfoProps = {
|
|
|
5064
4883
|
/**
|
|
5065
4884
|
* Presents a button which will show a hint when clicked
|
|
5066
4885
|
*/
|
|
5067
|
-
declare const OakInfo: (props: OakInfoProps) =>
|
|
4886
|
+
declare const OakInfo: (props: OakInfoProps) => React$1.JSX.Element;
|
|
5068
4887
|
|
|
5069
4888
|
type OakListItemProps = {
|
|
5070
4889
|
unavailable?: boolean;
|
|
5071
4890
|
index: number;
|
|
5072
4891
|
title: string;
|
|
5073
4892
|
isLegacy: boolean;
|
|
5074
|
-
firstItemRef?:
|
|
5075
|
-
onClick?: (event:
|
|
5076
|
-
middleSlot?:
|
|
5077
|
-
endSlot?:
|
|
4893
|
+
firstItemRef?: React$1.MutableRefObject<HTMLDivElement | null> | null | undefined;
|
|
4894
|
+
onClick?: (event: React$1.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
4895
|
+
middleSlot?: React$1.ReactNode;
|
|
4896
|
+
endSlot?: React$1.ReactNode;
|
|
5078
4897
|
hoverBgColour?: OakUiRoleToken;
|
|
5079
4898
|
indexBgColour?: OakUiRoleToken;
|
|
5080
4899
|
indexHoverBgColour?: OakUiRoleToken;
|
|
5081
4900
|
indexLegacyBgColour?: OakUiRoleToken;
|
|
5082
|
-
expandedContent?:
|
|
4901
|
+
expandedContent?: React$1.ReactNode;
|
|
5083
4902
|
isExpanded?: boolean;
|
|
5084
4903
|
asRadio?: boolean;
|
|
5085
4904
|
radioValue?: string;
|
|
@@ -5088,7 +4907,7 @@ type OakListItemProps = {
|
|
|
5088
4907
|
* * OakListItem component used as links for unit cards
|
|
5089
4908
|
* * adding asRadio and radioValue props to allow OakListItem to be used as radio buttons within OakUnitsContainer if the OakUnitsContainer is passed a radioGroupName prop. This allows for better accessibility when OakListItem is used in OakUnitsContainer, as the user can select a unit by clicking anywhere on the card, rather than having to click on a specific radio button.
|
|
5090
4909
|
*/
|
|
5091
|
-
declare const OakListItem: (props: OakListItemProps) =>
|
|
4910
|
+
declare const OakListItem: (props: OakListItemProps) => React$1.JSX.Element;
|
|
5092
4911
|
|
|
5093
4912
|
type MuxPlayingState = "standard" | "playing" | "played";
|
|
5094
4913
|
type OakMediaClipProps = {
|
|
@@ -5103,50 +4922,8 @@ type OakMediaClipProps = {
|
|
|
5103
4922
|
isAudioClip?: boolean;
|
|
5104
4923
|
element?: "button" | "a";
|
|
5105
4924
|
};
|
|
5106
|
-
declare const StyledMediaClipImage:
|
|
5107
|
-
|
|
5108
|
-
alt: string;
|
|
5109
|
-
width?: number | `${number}`;
|
|
5110
|
-
height?: number | `${number}`;
|
|
5111
|
-
fill?: boolean;
|
|
5112
|
-
loader?: Image.ImageLoader;
|
|
5113
|
-
quality?: number | `${number}`;
|
|
5114
|
-
priority?: boolean;
|
|
5115
|
-
loading?: "eager" | "lazy" | undefined;
|
|
5116
|
-
placeholder?: next_dist_shared_lib_get_img_props.PlaceholderValue;
|
|
5117
|
-
blurDataURL?: string;
|
|
5118
|
-
unoptimized?: boolean;
|
|
5119
|
-
overrideSrc?: string;
|
|
5120
|
-
onLoadingComplete?: next_dist_shared_lib_get_img_props.OnLoadingComplete;
|
|
5121
|
-
layout?: string;
|
|
5122
|
-
objectFit?: string;
|
|
5123
|
-
objectPosition?: string;
|
|
5124
|
-
lazyBoundary?: string;
|
|
5125
|
-
lazyRoot?: string;
|
|
5126
|
-
} & React__default.RefAttributes<HTMLImageElement | null>>>({ ...props }: OakImageProps<C>) => React__default.JSX.Element), styled_components.DefaultTheme, Omit<OakImageProps<React__default.ForwardRefExoticComponent<Omit<React__default.DetailedHTMLProps<React__default.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, "ref" | "height" | "width" | "alt" | "src" | "loading" | "srcSet"> & {
|
|
5127
|
-
src: string | next_dist_shared_lib_get_img_props.StaticImport;
|
|
5128
|
-
alt: string;
|
|
5129
|
-
width?: number | `${number}`;
|
|
5130
|
-
height?: number | `${number}`;
|
|
5131
|
-
fill?: boolean;
|
|
5132
|
-
loader?: Image.ImageLoader;
|
|
5133
|
-
quality?: number | `${number}`;
|
|
5134
|
-
priority?: boolean;
|
|
5135
|
-
loading?: "eager" | "lazy" | undefined;
|
|
5136
|
-
placeholder?: next_dist_shared_lib_get_img_props.PlaceholderValue;
|
|
5137
|
-
blurDataURL?: string;
|
|
5138
|
-
unoptimized?: boolean;
|
|
5139
|
-
overrideSrc?: string;
|
|
5140
|
-
onLoadingComplete?: next_dist_shared_lib_get_img_props.OnLoadingComplete;
|
|
5141
|
-
layout?: string;
|
|
5142
|
-
objectFit?: string;
|
|
5143
|
-
objectPosition?: string;
|
|
5144
|
-
lazyBoundary?: string;
|
|
5145
|
-
lazyRoot?: string;
|
|
5146
|
-
} & React__default.RefAttributes<HTMLImageElement | null>>>, "as"> & {
|
|
5147
|
-
$showOakPlaceholder: boolean;
|
|
5148
|
-
}, never>;
|
|
5149
|
-
declare const OakMediaClip: ({ thumbnailImage, timeCode, clipName, learningCycle, muxPlayingState, onClick, disabled, imageAltText, isAudioClip, element, }: OakMediaClipProps) => React__default.JSX.Element;
|
|
4925
|
+
declare const StyledMediaClipImage: any;
|
|
4926
|
+
declare const OakMediaClip: ({ thumbnailImage, timeCode, clipName, learningCycle, muxPlayingState, onClick, disabled, imageAltText, isAudioClip, element, }: OakMediaClipProps) => React$1.JSX.Element;
|
|
5150
4927
|
|
|
5151
4928
|
type OakMediaClipListProps = {
|
|
5152
4929
|
lessonTitle: string;
|
|
@@ -5159,7 +4936,7 @@ type OakMediaClipListProps = {
|
|
|
5159
4936
|
* OakMediaClipList is a scrollable list of OakMediaClip components with clip counter and the title
|
|
5160
4937
|
*
|
|
5161
4938
|
*/
|
|
5162
|
-
declare const OakMediaClipList: ({ lessonTitle, currentClipCounter, totalClipCounter, children, }: OakMediaClipListProps) =>
|
|
4939
|
+
declare const OakMediaClipList: ({ lessonTitle, currentClipCounter, totalClipCounter, children, }: OakMediaClipListProps) => React$1.JSX.Element;
|
|
5163
4940
|
|
|
5164
4941
|
type OakMediaClipStackListItemProps = {
|
|
5165
4942
|
title: string;
|
|
@@ -5171,7 +4948,7 @@ type OakMediaClipStackListItemProps = {
|
|
|
5171
4948
|
onClick?: () => void;
|
|
5172
4949
|
rel?: string;
|
|
5173
4950
|
};
|
|
5174
|
-
declare const OakMediaClipStackListItem: (props: OakMediaClipStackListItemProps) =>
|
|
4951
|
+
declare const OakMediaClipStackListItem: (props: OakMediaClipStackListItemProps) => React$1.JSX.Element;
|
|
5175
4952
|
|
|
5176
4953
|
type MenuItemProps = {
|
|
5177
4954
|
heading: string;
|
|
@@ -5200,14 +4977,14 @@ type OakSideMenuNavLinkProps = FlexStyleProps & PaddingStyleProps & {
|
|
|
5200
4977
|
* - `isSelected`: A boolean indicating whether the link is currently selected.
|
|
5201
4978
|
* - `onClick`: A callback function that is triggered when the link is clicked.
|
|
5202
4979
|
*/
|
|
5203
|
-
declare const OakSideMenuNavLink:
|
|
4980
|
+
declare const OakSideMenuNavLink: any;
|
|
5204
4981
|
|
|
5205
4982
|
type OakSideMenuNavProps = {
|
|
5206
4983
|
heading: string;
|
|
5207
4984
|
menuItems: MenuItemProps[];
|
|
5208
4985
|
anchorTargetId: string;
|
|
5209
4986
|
};
|
|
5210
|
-
declare const OakSideMenuNav: (props: OakSideMenuNavProps) =>
|
|
4987
|
+
declare const OakSideMenuNav: (props: OakSideMenuNavProps) => React$1.JSX.Element;
|
|
5211
4988
|
|
|
5212
4989
|
type OakSubjectIconProps = Pick<OakHandDrawnBoxWithIconProps, "iconName" | "fill" | "iconColor" | "alt"> & {
|
|
5213
4990
|
iconName: `subject-${string}`;
|
|
@@ -5218,7 +4995,7 @@ type OakSubjectIconProps = Pick<OakHandDrawnBoxWithIconProps, "iconName" | "fill
|
|
|
5218
4995
|
*
|
|
5219
4996
|
* Accepts an optional `showPromoTag` prop to display a "New" tag in the top left corner
|
|
5220
4997
|
*/
|
|
5221
|
-
declare const OakSubjectIcon: ({ showPromoTag, ...rest }: OakSubjectIconProps) =>
|
|
4998
|
+
declare const OakSubjectIcon: ({ showPromoTag, ...rest }: OakSubjectIconProps) => React$1.JSX.Element;
|
|
5222
4999
|
|
|
5223
5000
|
type OakSubjectIconButtonProps = {
|
|
5224
5001
|
phase: "primary" | "secondary" | "non-curriculum";
|
|
@@ -5240,7 +5017,7 @@ type OakSubjectIconButtonProps = {
|
|
|
5240
5017
|
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
5241
5018
|
* called after a mouseEnter and mouseLeave event has happened
|
|
5242
5019
|
*/
|
|
5243
|
-
declare const OakSubjectIconButton: <C extends ElementType = "button">({ phase, element, subjectIconName, variant, selected, ...rest }: OakSubjectIconButtonProps & PolymorphicPropsWithoutRef<C>) =>
|
|
5020
|
+
declare const OakSubjectIconButton: <C extends ElementType = "button">({ phase, element, subjectIconName, variant, selected, ...rest }: OakSubjectIconButtonProps & PolymorphicPropsWithoutRef<C>) => React$1.JSX.Element;
|
|
5244
5021
|
|
|
5245
5022
|
type OakVideoTranscriptProps = {
|
|
5246
5023
|
/**
|
|
@@ -5269,7 +5046,7 @@ type OakVideoTranscriptProps = {
|
|
|
5269
5046
|
/**
|
|
5270
5047
|
* Display a togglable video transcript with a slot to display a sign language control
|
|
5271
5048
|
*/
|
|
5272
|
-
declare const OakVideoTranscript: ({ children, id, signLanguageControl, copyLinkControl, transcriptToggled, }: OakVideoTranscriptProps) =>
|
|
5049
|
+
declare const OakVideoTranscript: ({ children, id, signLanguageControl, copyLinkControl, transcriptToggled, }: OakVideoTranscriptProps) => React$1.JSX.Element;
|
|
5273
5050
|
|
|
5274
5051
|
type OakCloudinaryImageProps = Omit<OakImageProps<typeof CldImage>, "src" | "imageProps"> & {
|
|
5275
5052
|
/**
|
|
@@ -5285,7 +5062,7 @@ type OakCloudinaryImageProps = Omit<OakImageProps<typeof CldImage>, "src" | "ima
|
|
|
5285
5062
|
* See https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters
|
|
5286
5063
|
* for documentation of the config object.
|
|
5287
5064
|
*/
|
|
5288
|
-
declare const OakCloudinaryConfigProvider:
|
|
5065
|
+
declare const OakCloudinaryConfigProvider: React$1.Provider<any>;
|
|
5289
5066
|
/**
|
|
5290
5067
|
* OakCloudinaryImage wraps OakImage providing responsive images from Cloudinary
|
|
5291
5068
|
* based on the `sizes` prop.
|
|
@@ -5296,7 +5073,7 @@ declare const OakCloudinaryConfigProvider: React__default.Provider<_cloudinary_u
|
|
|
5296
5073
|
* ## To be refactored 🔀
|
|
5297
5074
|
* This component will be refactored not to be tight to a service like Cloudinary
|
|
5298
5075
|
*/
|
|
5299
|
-
declare const OakCloudinaryImage: ({ cloudinaryId, unoptimized, ...props }: OakCloudinaryImageProps) =>
|
|
5076
|
+
declare const OakCloudinaryImage: ({ cloudinaryId, unoptimized, ...props }: OakCloudinaryImageProps) => React$1.JSX.Element;
|
|
5300
5077
|
|
|
5301
5078
|
type OakCarouselProps = {
|
|
5302
5079
|
content: ReactNode[];
|
|
@@ -5305,7 +5082,7 @@ type OakCarouselProps = {
|
|
|
5305
5082
|
fwdLabel: string;
|
|
5306
5083
|
containerLabel: string;
|
|
5307
5084
|
};
|
|
5308
|
-
declare const OakCarousel: ({ content, isLooping, backLabel, fwdLabel, containerLabel, }: OakCarouselProps) =>
|
|
5085
|
+
declare const OakCarousel: ({ content, isLooping, backLabel, fwdLabel, containerLabel, }: OakCarouselProps) => React$1.JSX.Element;
|
|
5309
5086
|
|
|
5310
5087
|
type OakQuoteProps = {
|
|
5311
5088
|
quote: string;
|
|
@@ -5314,7 +5091,7 @@ type OakQuoteProps = {
|
|
|
5314
5091
|
authorTitle?: string;
|
|
5315
5092
|
authorImageSrc?: string;
|
|
5316
5093
|
};
|
|
5317
|
-
declare const OakQuote: (props: OakQuoteProps) =>
|
|
5094
|
+
declare const OakQuote: (props: OakQuoteProps) => React$1.JSX.Element;
|
|
5318
5095
|
|
|
5319
5096
|
type ListStyleProps = {
|
|
5320
5097
|
/**
|
|
@@ -5322,7 +5099,7 @@ type ListStyleProps = {
|
|
|
5322
5099
|
*
|
|
5323
5100
|
* Accepts a `list-style` value or a responsive array of `list-style` values.
|
|
5324
5101
|
*/
|
|
5325
|
-
$listStyle?: ResponsiveValues<CSSProperties["listStyle"]>;
|
|
5102
|
+
$listStyle?: ResponsiveValues<CSSProperties$1["listStyle"]>;
|
|
5326
5103
|
};
|
|
5327
5104
|
|
|
5328
5105
|
type OakLIProps = OakFlexProps & TypographyStyleProps & ListStyleProps & DisplayStyleProps;
|
|
@@ -5335,9 +5112,9 @@ type OakLIProps = OakFlexProps & TypographyStyleProps & ListStyleProps & Display
|
|
|
5335
5112
|
*
|
|
5336
5113
|
**/
|
|
5337
5114
|
declare const oakLIDefaults: {
|
|
5338
|
-
$display:
|
|
5115
|
+
$display: string;
|
|
5339
5116
|
};
|
|
5340
|
-
declare const OakLI:
|
|
5117
|
+
declare const OakLI: any;
|
|
5341
5118
|
|
|
5342
5119
|
type OakOLProps = MarginStyleProps & ColorStyleProps & TypographyStyleProps;
|
|
5343
5120
|
/**
|
|
@@ -5348,7 +5125,7 @@ type OakOLProps = MarginStyleProps & ColorStyleProps & TypographyStyleProps;
|
|
|
5348
5125
|
* Use where we have an ordered list to ensure numbers are styled
|
|
5349
5126
|
*
|
|
5350
5127
|
* */
|
|
5351
|
-
declare const OakOL:
|
|
5128
|
+
declare const OakOL: any;
|
|
5352
5129
|
|
|
5353
5130
|
type OakPProps = MarginStyleProps & TypographyStyleProps & ColorStyleProps;
|
|
5354
5131
|
/**
|
|
@@ -5358,7 +5135,7 @@ type OakPProps = MarginStyleProps & TypographyStyleProps & ColorStyleProps;
|
|
|
5358
5135
|
* However, if you want different styles for a particular paragraph,
|
|
5359
5136
|
* you can use this component to apply additional styles.
|
|
5360
5137
|
*/
|
|
5361
|
-
declare const OakP:
|
|
5138
|
+
declare const OakP: any;
|
|
5362
5139
|
|
|
5363
5140
|
type OakTypographyProps = OakBoxProps & TypographyStyleProps;
|
|
5364
5141
|
/**
|
|
@@ -5368,11 +5145,7 @@ type OakTypographyProps = OakBoxProps & TypographyStyleProps;
|
|
|
5368
5145
|
* This should be the primary component to set a typography context.
|
|
5369
5146
|
* Use this component whenever you want to style blocks of 'body' text.
|
|
5370
5147
|
*/
|
|
5371
|
-
declare const OakTypography:
|
|
5372
|
-
children?: React.ReactNode;
|
|
5373
|
-
} & PositionStyleProps & SizeStyleProps & PaddingStyleProps & MarginStyleProps & ColorStyleProps & BorderStyleProps & DisplayStyleProps & DropShadowStyleProps & OpacityStyleProps & TransformStyleProps & TransitionStyleProps & TypographyStyleProps & ZIndexStyleProps & {
|
|
5374
|
-
onClick?: React$1.MouseEventHandler;
|
|
5375
|
-
} & ScrollSnapStyleProps, never>;
|
|
5148
|
+
declare const OakTypography: any;
|
|
5376
5149
|
|
|
5377
5150
|
type OakULProps = OakBoxProps & OakFlexProps & {
|
|
5378
5151
|
$reset?: boolean;
|
|
@@ -5385,7 +5158,7 @@ type OakULProps = OakBoxProps & OakFlexProps & {
|
|
|
5385
5158
|
* Resets browser spacing and other styles, accepts BoxProps' style props.
|
|
5386
5159
|
*
|
|
5387
5160
|
* */
|
|
5388
|
-
declare const OakUL:
|
|
5161
|
+
declare const OakUL: any;
|
|
5389
5162
|
|
|
5390
5163
|
type UnstyledChevronAccordionCommonProps = {
|
|
5391
5164
|
/** The header of the accordion. */
|
|
@@ -5423,7 +5196,7 @@ type UnstyledChevronAccordionProps = UnstyledChevronAccordionCommonProps & (Unst
|
|
|
5423
5196
|
* - Can be used as an uncontrolled component (via `isInitiallyOpen`) or as a
|
|
5424
5197
|
* controlled component (via `isOpen` + `onOpenChange`).
|
|
5425
5198
|
*/
|
|
5426
|
-
declare const UnstyledChevronAccordion: (props: UnstyledChevronAccordionProps) =>
|
|
5199
|
+
declare const UnstyledChevronAccordion: (props: UnstyledChevronAccordionProps) => React$1.JSX.Element;
|
|
5427
5200
|
|
|
5428
5201
|
/**
|
|
5429
5202
|
*
|
|
@@ -5434,14 +5207,14 @@ declare const OakGlobalStyle: styled_components.GlobalStyleComponent<{}, styled_
|
|
|
5434
5207
|
|
|
5435
5208
|
type OakThemeProviderProps = {
|
|
5436
5209
|
theme: OakTheme;
|
|
5437
|
-
children:
|
|
5210
|
+
children: React$1.ReactNode;
|
|
5438
5211
|
};
|
|
5439
5212
|
/**
|
|
5440
5213
|
*
|
|
5441
5214
|
* OakThemeProvider wraps Styled Components ThemeProvider allowing the use of the custom type OakTheme.
|
|
5442
5215
|
*
|
|
5443
5216
|
*/
|
|
5444
|
-
declare const OakThemeProvider: ({ theme, children, }: OakThemeProviderProps) =>
|
|
5217
|
+
declare const OakThemeProvider: ({ theme, children, }: OakThemeProviderProps) => React$1.JSX.Element;
|
|
5445
5218
|
|
|
5446
5219
|
/**
|
|
5447
5220
|
* Installs a mock of IntersectionObserver when it is not present in the environment
|
|
@@ -5465,7 +5238,7 @@ declare const useMounted: () => boolean;
|
|
|
5465
5238
|
|
|
5466
5239
|
declare const useIsScrolled: () => {
|
|
5467
5240
|
isScrolled: boolean;
|
|
5468
|
-
ObserveScroll: ({ children }: PropsWithChildren) =>
|
|
5241
|
+
ObserveScroll: ({ children }: PropsWithChildren) => React$1.JSX.Element;
|
|
5469
5242
|
};
|
|
5470
5243
|
|
|
5471
5244
|
declare const useBreakpoint: () => Device;
|