@lumx/react 4.2.1-alpha.0 → 4.2.1-alpha.10
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 +1 -2
- package/index.d.ts +191 -89
- package/index.js +55 -35
- package/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# LumApps Design System (LumX)
|
|
2
2
|
|
|
3
3
|
The first official LumApps Design System for [React][react] applications.
|
|
4
|
-
_LumX_ will help you design your applications faster and more easily. You will be able to use LumX with
|
|
4
|
+
_LumX_ will help you design your applications faster and more easily. You will be able to use LumX with the LumApps design styleguides.
|
|
5
5
|
|
|
6
6
|
## Quick start
|
|
7
7
|
|
|
@@ -31,6 +31,5 @@ Please refer to our [contributing guidelines](CONTRIBUTING.md).
|
|
|
31
31
|
Code and documentation copyright 2019 LumApps. Code released under the [MIT license](LICENSE.md).
|
|
32
32
|
|
|
33
33
|
[react]: https://react.org/
|
|
34
|
-
[material]: http://www.google.com/design/spec/material-design/introduction.html
|
|
35
34
|
[react-release]: https://www.npmjs.com/package/@lumx/react
|
|
36
35
|
[webpack]: https://webpack.js.org/
|
package/index.d.ts
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
import { Kind as Kind$1, HorizontalAlignment, Size as Size$1, ColorPalette as ColorPalette$1,
|
|
1
|
+
import { Kind as Kind$1, HorizontalAlignment as HorizontalAlignment$1, Size as Size$1, ColorPalette as ColorPalette$1, GenericProps as GenericProps$2, Orientation as Orientation$1, Alignment as Alignment$1, AspectRatio, ColorWithVariants as ColorWithVariants$1, ColorVariant as ColorVariant$1, Typography as Typography$1, Emphasis as Emphasis$1, GlobalSize, TypographyInterface as TypographyInterface$1, Theme as Theme$1 } from '@lumx/core/js/constants';
|
|
2
2
|
export * from '@lumx/core/js/constants';
|
|
3
3
|
import * as _lumx_core_js_types from '@lumx/core/js/types';
|
|
4
4
|
import { GenericProps as GenericProps$1, HasTheme as HasTheme$1, ValueOf, HasAriaDisabled as HasAriaDisabled$1, HasCloseMode, Falsy, HasClassName as HasClassName$1, HeadingElement as HeadingElement$1, HasRequiredLinkHref, HasAriaLabelOrLabelledBy } from '@lumx/core/js/types';
|
|
5
5
|
export * from '@lumx/core/js/types';
|
|
6
6
|
import * as React$1 from 'react';
|
|
7
|
-
import React__default, { Ref, ReactElement, ReactNode, SyntheticEvent, MouseEventHandler, KeyboardEventHandler,
|
|
7
|
+
import React__default, { Ref, ReactElement, ReactNode, SyntheticEvent, MouseEventHandler, KeyboardEventHandler, InputHTMLAttributes, RefObject, CSSProperties, ImgHTMLAttributes, AriaAttributes as AriaAttributes$1, SetStateAction, Key, ElementType, ComponentProps } from 'react';
|
|
8
|
+
import { GenericProps } from '@lumx/core/js/types/GenericProps';
|
|
9
|
+
import { GenericProps as GenericProps$3 } from '@lumx/core/js/utils/disabledState';
|
|
8
10
|
|
|
9
11
|
/** LumX Component Type. */
|
|
10
12
|
type Comp<P, T = HTMLElement> = {
|
|
11
13
|
(props: P & {
|
|
12
14
|
ref?: Ref<T>;
|
|
13
|
-
}): ReactElement | null;
|
|
15
|
+
} & GenericProps): ReactElement | null;
|
|
14
16
|
/** React component type. */
|
|
15
17
|
readonly $$typeof: symbol;
|
|
16
18
|
/** Component default props. */
|
|
@@ -241,7 +243,7 @@ interface AutocompleteMultipleProps extends AutocompleteProps {
|
|
|
241
243
|
/** Selected values. */
|
|
242
244
|
values: any[];
|
|
243
245
|
/** Alignment of the chips in the autocomplete. */
|
|
244
|
-
chipsAlignment?: HorizontalAlignment;
|
|
246
|
+
chipsAlignment?: HorizontalAlignment$1;
|
|
245
247
|
/** Selected value render function. Default: Renders the value inside of a Chip. */
|
|
246
248
|
selectedChipRender(choice: any, index: number, onClear?: (event: React.MouseEvent, val: any) => void, isDisabled?: boolean): ReactNode | string;
|
|
247
249
|
}
|
|
@@ -318,6 +320,24 @@ interface BadgeWrapperProps extends GenericProps$1 {
|
|
|
318
320
|
}
|
|
319
321
|
declare const BadgeWrapper: Comp<BadgeWrapperProps, HTMLDivElement>;
|
|
320
322
|
|
|
323
|
+
/**
|
|
324
|
+
* Alignments.
|
|
325
|
+
*/
|
|
326
|
+
declare const Alignment: {
|
|
327
|
+
readonly bottom: "bottom";
|
|
328
|
+
readonly center: "center";
|
|
329
|
+
readonly end: "end";
|
|
330
|
+
readonly left: "left";
|
|
331
|
+
readonly right: "right";
|
|
332
|
+
readonly spaceAround: "space-around";
|
|
333
|
+
readonly spaceBetween: "space-between";
|
|
334
|
+
readonly spaceEvenly: "space-evenly";
|
|
335
|
+
readonly start: "start";
|
|
336
|
+
readonly top: "top";
|
|
337
|
+
};
|
|
338
|
+
type Alignment = ValueOf<typeof Alignment>;
|
|
339
|
+
type VerticalAlignment = Extract<Alignment, 'top' | 'center' | 'bottom'>;
|
|
340
|
+
type HorizontalAlignment = Extract<Alignment, 'right' | 'center' | 'left'>;
|
|
321
341
|
declare const Theme: {
|
|
322
342
|
readonly light: "light";
|
|
323
343
|
readonly dark: "dark";
|
|
@@ -338,6 +358,11 @@ declare const Size: {
|
|
|
338
358
|
readonly huge: "huge";
|
|
339
359
|
};
|
|
340
360
|
type Size = ValueOf<typeof Size>;
|
|
361
|
+
declare const Orientation: {
|
|
362
|
+
readonly horizontal: "horizontal";
|
|
363
|
+
readonly vertical: "vertical";
|
|
364
|
+
};
|
|
365
|
+
type Orientation = ValueOf<typeof Orientation>;
|
|
341
366
|
declare const Emphasis: {
|
|
342
367
|
readonly low: "low";
|
|
343
368
|
readonly medium: "medium";
|
|
@@ -476,16 +501,12 @@ interface HasTheme {
|
|
|
476
501
|
}
|
|
477
502
|
|
|
478
503
|
/**
|
|
479
|
-
*
|
|
504
|
+
* Framework-agnostic type for renderable content.
|
|
505
|
+
* Vue components should cast VNode[] from slots to this type.
|
|
506
|
+
*
|
|
507
|
+
* Note: Uses type-only import to avoid runtime dependencies.
|
|
480
508
|
*/
|
|
481
|
-
|
|
482
|
-
/**
|
|
483
|
-
* Any prop (particularly any supported prop for a HTML element).
|
|
484
|
-
*/
|
|
485
|
-
[propName: string]: any;
|
|
486
|
-
}
|
|
487
|
-
|
|
488
|
-
type JSXElement = boolean | number | string | React__default.JSX.Element | React__default.ReactNode | Iterable<JSXElement> | undefined | null;
|
|
509
|
+
type JSXElement = React__default.ReactNode;
|
|
489
510
|
|
|
490
511
|
/** Union type of all heading elements */
|
|
491
512
|
type HeadingElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
|
|
@@ -499,6 +520,8 @@ type KebabCase<S> = S extends `${infer C}${infer T}` ? T extends Uncapitalize<T>
|
|
|
499
520
|
/** Transform the component name into the lumx class name. */
|
|
500
521
|
type LumxClassName<TComponentName extends string> = `lumx-${KebabCase<TComponentName>}`;
|
|
501
522
|
|
|
523
|
+
type CommonRef = any;
|
|
524
|
+
|
|
502
525
|
type Booleanish = boolean | 'true' | 'false';
|
|
503
526
|
|
|
504
527
|
interface HasAriaDisabled {
|
|
@@ -506,11 +529,37 @@ interface HasAriaDisabled {
|
|
|
506
529
|
'aria-disabled'?: Booleanish;
|
|
507
530
|
}
|
|
508
531
|
|
|
532
|
+
interface AriaAttributes {
|
|
533
|
+
/** Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. */
|
|
534
|
+
'aria-expanded'?: Booleanish | undefined;
|
|
535
|
+
/** Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. */
|
|
536
|
+
'aria-haspopup'?: boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog' | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* Defines a string value that labels the current element.
|
|
539
|
+
* @see aria-labelledby.
|
|
540
|
+
*/
|
|
541
|
+
'aria-label'?: string | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* Indicates the current "pressed" state of toggle buttons.
|
|
544
|
+
* @see aria-checked @see aria-selected.
|
|
545
|
+
*/
|
|
546
|
+
'aria-pressed'?: boolean | 'false' | 'mixed' | 'true' | undefined;
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
interface BaseClickableProps {
|
|
550
|
+
children?: JSXElement;
|
|
551
|
+
isDisabled?: boolean;
|
|
552
|
+
disabled?: boolean;
|
|
553
|
+
'aria-disabled'?: Booleanish;
|
|
554
|
+
onClick?: (event?: any) => void;
|
|
555
|
+
ref?: CommonRef;
|
|
556
|
+
}
|
|
557
|
+
|
|
509
558
|
/**
|
|
510
559
|
* Button size definition.
|
|
511
560
|
*/
|
|
512
561
|
type ButtonSize = Extract<Size, 's' | 'm'>;
|
|
513
|
-
interface BaseButtonProps extends
|
|
562
|
+
interface BaseButtonProps extends AriaAttributes, HasClassName, HasTheme, HasAriaDisabled, BaseClickableProps {
|
|
514
563
|
/** Color variant. */
|
|
515
564
|
color?: ColorPalette;
|
|
516
565
|
/** Emphasis variant. */
|
|
@@ -533,6 +582,14 @@ interface BaseButtonProps extends GenericProps, Pick<AriaAttributes, 'aria-expan
|
|
|
533
582
|
type?: 'submit' | 'reset' | 'button' | undefined;
|
|
534
583
|
/** Custom component for the link (can be used to inject router Link). */
|
|
535
584
|
linkAs?: 'a' | any;
|
|
585
|
+
/** whether the button is dispalyed in full width or not */
|
|
586
|
+
fullWidth?: boolean;
|
|
587
|
+
/** whether the button is currently active or not */
|
|
588
|
+
isActive?: boolean;
|
|
589
|
+
/** whether the button is currently focused or not */
|
|
590
|
+
isFocused?: boolean;
|
|
591
|
+
/** whether the button is currently focused or not */
|
|
592
|
+
isHovered?: boolean;
|
|
536
593
|
}
|
|
537
594
|
|
|
538
595
|
/**
|
|
@@ -547,7 +604,7 @@ declare const ButtonEmphasis: {
|
|
|
547
604
|
/**
|
|
548
605
|
* Defines the props of the component.
|
|
549
606
|
*/
|
|
550
|
-
interface ButtonProps extends
|
|
607
|
+
interface ButtonProps$1 extends BaseButtonProps {
|
|
551
608
|
/** Left icon (SVG path). */
|
|
552
609
|
leftIcon?: string;
|
|
553
610
|
/** Right icon (SVG path). */
|
|
@@ -568,8 +625,10 @@ declare const CLASSNAME: LumxClassName<typeof COMPONENT_NAME>;
|
|
|
568
625
|
/**
|
|
569
626
|
* Component default props.
|
|
570
627
|
*/
|
|
571
|
-
declare const DEFAULT_PROPS: Partial<ButtonProps>;
|
|
628
|
+
declare const DEFAULT_PROPS: Partial<ButtonProps$1>;
|
|
572
629
|
|
|
630
|
+
interface ButtonProps extends GenericProps$2, ButtonProps$1 {
|
|
631
|
+
}
|
|
573
632
|
/**
|
|
574
633
|
* Button component.
|
|
575
634
|
*
|
|
@@ -579,7 +638,7 @@ declare const DEFAULT_PROPS: Partial<ButtonProps>;
|
|
|
579
638
|
*/
|
|
580
639
|
declare const Button: Comp<ButtonProps, HTMLButtonElement | HTMLAnchorElement>;
|
|
581
640
|
|
|
582
|
-
interface IconButtonProps$1 extends
|
|
641
|
+
interface IconButtonProps$1 extends BaseButtonProps {
|
|
583
642
|
/**
|
|
584
643
|
* Icon (SVG path).
|
|
585
644
|
* If `image` is also set, `image` will be used instead.
|
|
@@ -595,9 +654,13 @@ interface IconButtonProps$1 extends /* @vue-ignore */ BaseButtonProps {
|
|
|
595
654
|
* If you really don't want an aria-label, you can set an empty label (this is not recommended).
|
|
596
655
|
*/
|
|
597
656
|
label: string;
|
|
657
|
+
/**
|
|
658
|
+
* optional text to be displayed as the title of the HTML element
|
|
659
|
+
*/
|
|
660
|
+
title?: string;
|
|
598
661
|
}
|
|
599
662
|
|
|
600
|
-
interface IconButtonProps extends IconButtonProps$1 {
|
|
663
|
+
interface IconButtonProps extends GenericProps$2, IconButtonProps$1 {
|
|
601
664
|
/**
|
|
602
665
|
* Props to pass to the tooltip.
|
|
603
666
|
* If undefined or if tooltipProps.label is undefined, the label prop will be used as tooltip label.
|
|
@@ -618,13 +681,17 @@ declare const IconButton: Comp<IconButtonProps, HTMLButtonElement>;
|
|
|
618
681
|
/**
|
|
619
682
|
* Defines the props of the component
|
|
620
683
|
*/
|
|
621
|
-
interface ButtonGroupProps extends
|
|
684
|
+
interface ButtonGroupProps$1 extends HasClassName {
|
|
622
685
|
/**
|
|
623
686
|
* Children
|
|
624
687
|
*/
|
|
625
688
|
children?: JSXElement;
|
|
689
|
+
/** reference to the root element */
|
|
690
|
+
ref?: CommonRef;
|
|
626
691
|
}
|
|
627
692
|
|
|
693
|
+
interface ButtonGroupProps extends ButtonGroupProps$1, GenericProps$1 {
|
|
694
|
+
}
|
|
628
695
|
/**
|
|
629
696
|
* ButtonGroup component.
|
|
630
697
|
*
|
|
@@ -726,7 +793,7 @@ interface ChipGroupProps extends GenericProps$1 {
|
|
|
726
793
|
* Chip horizontal alignment.
|
|
727
794
|
* @deprecated
|
|
728
795
|
*/
|
|
729
|
-
align?: HorizontalAlignment;
|
|
796
|
+
align?: HorizontalAlignment$1;
|
|
730
797
|
/** List of Chip. */
|
|
731
798
|
children: ReactNode;
|
|
732
799
|
}
|
|
@@ -1179,7 +1246,54 @@ interface ExpansionPanelProps extends GenericProps$1, HasCloseMode, HasTheme$1 {
|
|
|
1179
1246
|
*/
|
|
1180
1247
|
declare const ExpansionPanel: Comp<ExpansionPanelProps, HTMLDivElement>;
|
|
1181
1248
|
|
|
1182
|
-
|
|
1249
|
+
/**
|
|
1250
|
+
* Defines the props of the component.
|
|
1251
|
+
*/
|
|
1252
|
+
interface TextProps$1 extends HasClassName {
|
|
1253
|
+
/**
|
|
1254
|
+
* Color variant.
|
|
1255
|
+
*/
|
|
1256
|
+
color?: ColorWithVariants;
|
|
1257
|
+
/**
|
|
1258
|
+
* Lightened or darkened variant of the selected color.
|
|
1259
|
+
*/
|
|
1260
|
+
colorVariant?: ColorVariant;
|
|
1261
|
+
/**
|
|
1262
|
+
* Typography variant.
|
|
1263
|
+
*/
|
|
1264
|
+
typography?: Typography;
|
|
1265
|
+
/**
|
|
1266
|
+
* Custom component to render the text.
|
|
1267
|
+
*/
|
|
1268
|
+
as: TextElement;
|
|
1269
|
+
/**
|
|
1270
|
+
* Control whether the text should truncate or not.
|
|
1271
|
+
* Setting as `true` will make the text truncate on a single line.
|
|
1272
|
+
* Setting as `{ lines: number }` will make the text truncate on a multiple lines.
|
|
1273
|
+
*/
|
|
1274
|
+
truncate?: boolean | {
|
|
1275
|
+
lines: number;
|
|
1276
|
+
};
|
|
1277
|
+
/**
|
|
1278
|
+
* Prevents text to wrap on multiple lines
|
|
1279
|
+
* (automatically activated when single line text truncate is activated).
|
|
1280
|
+
*/
|
|
1281
|
+
noWrap?: boolean;
|
|
1282
|
+
/**
|
|
1283
|
+
* WhiteSpace variant
|
|
1284
|
+
* Ignored when `noWrap` is set to true
|
|
1285
|
+
* Ignored when `truncate` is set to true or lines: 1
|
|
1286
|
+
* */
|
|
1287
|
+
whiteSpace?: WhiteSpace;
|
|
1288
|
+
/**
|
|
1289
|
+
* Children
|
|
1290
|
+
*/
|
|
1291
|
+
children?: JSXElement;
|
|
1292
|
+
/** list of styles to apply */
|
|
1293
|
+
style?: CSSProperties;
|
|
1294
|
+
}
|
|
1295
|
+
|
|
1296
|
+
interface FlagProps$1 extends HasClassName, HasTheme {
|
|
1183
1297
|
/** Color of the component. */
|
|
1184
1298
|
color?: ColorPalette;
|
|
1185
1299
|
/** Icon to use before the label. */
|
|
@@ -1188,9 +1302,13 @@ interface FlagProps$1 extends GenericProps, HasTheme {
|
|
|
1188
1302
|
children: JSXElement;
|
|
1189
1303
|
/** Enable text truncate on overflow */
|
|
1190
1304
|
truncate?: boolean;
|
|
1305
|
+
/** ref to the root element */
|
|
1306
|
+
ref?: CommonRef;
|
|
1307
|
+
/** Text component to use for rendering the label */
|
|
1308
|
+
Text: (props: TextProps$1) => any;
|
|
1191
1309
|
}
|
|
1192
1310
|
|
|
1193
|
-
interface FlagProps extends Omit<FlagProps$1, 'children'> {
|
|
1311
|
+
interface FlagProps extends GenericProps$2, Omit<FlagProps$1, 'children' | 'Text'> {
|
|
1194
1312
|
label: React.ReactNode;
|
|
1195
1313
|
}
|
|
1196
1314
|
/**
|
|
@@ -1203,18 +1321,17 @@ interface FlagProps extends Omit<FlagProps$1, 'children'> {
|
|
|
1203
1321
|
declare const Flag: Comp<FlagProps, HTMLDivElement>;
|
|
1204
1322
|
|
|
1205
1323
|
type MarginAutoAlignment = Extract<Alignment, 'top' | 'bottom' | 'right' | 'left'>;
|
|
1206
|
-
type GapSize = Extract<Size
|
|
1324
|
+
type GapSize = Extract<Size, 'tiny' | 'regular' | 'medium' | 'big' | 'huge'>;
|
|
1207
1325
|
type SpaceAlignment = Extract<Alignment, 'space-between' | 'space-evenly' | 'space-around'>;
|
|
1208
1326
|
type FlexVerticalAlignment = VerticalAlignment | SpaceAlignment;
|
|
1209
1327
|
type FlexHorizontalAlignment = HorizontalAlignment | SpaceAlignment;
|
|
1328
|
+
|
|
1210
1329
|
/**
|
|
1211
1330
|
* Defines the props of the component.
|
|
1212
1331
|
*/
|
|
1213
|
-
interface FlexBoxProps extends
|
|
1214
|
-
/** Customize the root element. */
|
|
1215
|
-
as?: React.ElementType;
|
|
1332
|
+
interface FlexBoxProps$1 extends HasClassName {
|
|
1216
1333
|
/** Children elements. */
|
|
1217
|
-
children?:
|
|
1334
|
+
children?: JSXElement;
|
|
1218
1335
|
/** Whether the "content filling space" is enabled or not. */
|
|
1219
1336
|
fillSpace?: boolean;
|
|
1220
1337
|
/** Gap space between flexbox items. */
|
|
@@ -1232,6 +1349,14 @@ interface FlexBoxProps extends GenericProps$1 {
|
|
|
1232
1349
|
/** Whether the "flex wrap" is enabled or not. */
|
|
1233
1350
|
wrap?: boolean;
|
|
1234
1351
|
}
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Defines the props of the component.
|
|
1355
|
+
*/
|
|
1356
|
+
interface FlexBoxProps extends FlexBoxProps$1, GenericProps$1 {
|
|
1357
|
+
/** Customize the root element. */
|
|
1358
|
+
as?: React__default.ElementType;
|
|
1359
|
+
}
|
|
1235
1360
|
/**
|
|
1236
1361
|
* FlexBox component.
|
|
1237
1362
|
*
|
|
@@ -1345,58 +1470,15 @@ declare const GenericBlock: GenericBlock;
|
|
|
1345
1470
|
/**
|
|
1346
1471
|
* Defines the props of the component.
|
|
1347
1472
|
*/
|
|
1348
|
-
interface
|
|
1349
|
-
/**
|
|
1350
|
-
* Color variant.
|
|
1351
|
-
*/
|
|
1352
|
-
color?: ColorWithVariants;
|
|
1353
|
-
/**
|
|
1354
|
-
* Lightened or darkened variant of the selected color.
|
|
1355
|
-
*/
|
|
1356
|
-
colorVariant?: ColorVariant;
|
|
1357
|
-
/**
|
|
1358
|
-
* Typography variant.
|
|
1359
|
-
*/
|
|
1360
|
-
typography?: Typography;
|
|
1361
|
-
/**
|
|
1362
|
-
* Custom component to render the text.
|
|
1363
|
-
*/
|
|
1364
|
-
as: TextElement;
|
|
1365
|
-
/**
|
|
1366
|
-
* Control whether the text should truncate or not.
|
|
1367
|
-
* Setting as `true` will make the text truncate on a single line.
|
|
1368
|
-
* Setting as `{ lines: number }` will make the text truncate on a multiple lines.
|
|
1369
|
-
*/
|
|
1370
|
-
truncate?: boolean | {
|
|
1371
|
-
lines: number;
|
|
1372
|
-
};
|
|
1373
|
-
/**
|
|
1374
|
-
* Prevents text to wrap on multiple lines
|
|
1375
|
-
* (automatically activated when single line text truncate is activated).
|
|
1376
|
-
*/
|
|
1377
|
-
noWrap?: boolean;
|
|
1378
|
-
/**
|
|
1379
|
-
* WhiteSpace variant
|
|
1380
|
-
* Ignored when `noWrap` is set to true
|
|
1381
|
-
* Ignored when `truncate` is set to true or lines: 1
|
|
1382
|
-
* */
|
|
1383
|
-
whiteSpace?: WhiteSpace;
|
|
1384
|
-
/**
|
|
1385
|
-
* Children
|
|
1386
|
-
*/
|
|
1387
|
-
children?: JSXElement;
|
|
1388
|
-
}
|
|
1389
|
-
|
|
1390
|
-
/**
|
|
1391
|
-
* Defines the props of the component.
|
|
1392
|
-
*/
|
|
1393
|
-
interface HeadingProps extends Partial<TextProps> {
|
|
1473
|
+
interface HeadingProps$1 extends Partial<TextProps$1> {
|
|
1394
1474
|
/**
|
|
1395
1475
|
* Display a specific heading level instead of the one provided by parent context provider.
|
|
1396
1476
|
*/
|
|
1397
1477
|
as?: HeadingElement;
|
|
1398
1478
|
}
|
|
1399
1479
|
|
|
1480
|
+
interface HeadingProps extends HeadingProps$1, GenericProps$1 {
|
|
1481
|
+
}
|
|
1400
1482
|
/**
|
|
1401
1483
|
* Renders a heading component.
|
|
1402
1484
|
* Extends the `Text` Component with the heading level automatically computed based on
|
|
@@ -1426,13 +1508,13 @@ type GridGutterSize = Extract<Size$1, 'regular' | 'big' | 'huge'>;
|
|
|
1426
1508
|
*/
|
|
1427
1509
|
interface GridProps extends GenericProps$1 {
|
|
1428
1510
|
/** Orientation. */
|
|
1429
|
-
orientation?: Orientation;
|
|
1511
|
+
orientation?: Orientation$1;
|
|
1430
1512
|
/** Whether the children are wrapped or not. */
|
|
1431
1513
|
wrap?: string;
|
|
1432
1514
|
/** Vertical alignment. */
|
|
1433
|
-
vAlign?: Alignment;
|
|
1515
|
+
vAlign?: Alignment$1;
|
|
1434
1516
|
/** Horizontal alignment. */
|
|
1435
|
-
hAlign?: Alignment;
|
|
1517
|
+
hAlign?: Alignment$1;
|
|
1436
1518
|
/** Gutter size. */
|
|
1437
1519
|
gutter?: GridGutterSize;
|
|
1438
1520
|
/** Children */
|
|
@@ -1453,7 +1535,7 @@ type Columns = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11'
|
|
|
1453
1535
|
*/
|
|
1454
1536
|
interface GridItemProps extends GenericProps$1 {
|
|
1455
1537
|
/** Alignment. */
|
|
1456
|
-
align?: Alignment;
|
|
1538
|
+
align?: Alignment$1;
|
|
1457
1539
|
/** Order. */
|
|
1458
1540
|
order?: Columns;
|
|
1459
1541
|
/** Width. */
|
|
@@ -1503,7 +1585,7 @@ type IconSizes = (typeof ICON_SIZES)[number];
|
|
|
1503
1585
|
/**
|
|
1504
1586
|
* Defines the props of the component.
|
|
1505
1587
|
*/
|
|
1506
|
-
interface IconProps extends
|
|
1588
|
+
interface IconProps$1 extends HasClassName, HasTheme {
|
|
1507
1589
|
/** Color variant. */
|
|
1508
1590
|
color?: ColorWithVariants;
|
|
1509
1591
|
/** Lightened or darkened variant of the selected icon color. */
|
|
@@ -1521,8 +1603,12 @@ interface IconProps extends GenericProps, HasTheme {
|
|
|
1521
1603
|
alt?: string;
|
|
1522
1604
|
/** Vertical alignment of the icon (only applies for icons nested in Text/Heading). */
|
|
1523
1605
|
verticalAlign?: null | 'middle';
|
|
1606
|
+
/** reference to the root element */
|
|
1607
|
+
ref?: CommonRef;
|
|
1524
1608
|
}
|
|
1525
1609
|
|
|
1610
|
+
interface IconProps extends IconProps$1, GenericProps$1 {
|
|
1611
|
+
}
|
|
1526
1612
|
/**
|
|
1527
1613
|
* Icon component.
|
|
1528
1614
|
*
|
|
@@ -1581,7 +1667,7 @@ type ImgHTMLProps = ImgHTMLAttributes<HTMLImageElement>;
|
|
|
1581
1667
|
*/
|
|
1582
1668
|
interface ThumbnailProps extends GenericProps$1, HasTheme$1 {
|
|
1583
1669
|
/** Alignment of the thumbnail in it's parent (requires flex parent). */
|
|
1584
|
-
align?: HorizontalAlignment;
|
|
1670
|
+
align?: HorizontalAlignment$1;
|
|
1585
1671
|
/** Image alternative text. */
|
|
1586
1672
|
alt: string;
|
|
1587
1673
|
/** Image aspect ratio. */
|
|
@@ -1669,7 +1755,7 @@ interface ImageBlockProps extends GenericProps$1, HasTheme$1, ImageCaptionMetada
|
|
|
1669
1755
|
/** Action toolbar content. */
|
|
1670
1756
|
actions?: ReactNode;
|
|
1671
1757
|
/** Alignment. */
|
|
1672
|
-
align?: HorizontalAlignment;
|
|
1758
|
+
align?: HorizontalAlignment$1;
|
|
1673
1759
|
/** Image alternative text. */
|
|
1674
1760
|
alt: string;
|
|
1675
1761
|
/** Caption position. */
|
|
@@ -1791,13 +1877,17 @@ declare const InlineList: Comp<InlineListProps, HTMLElement>;
|
|
|
1791
1877
|
/**
|
|
1792
1878
|
* Defines the props of the component.
|
|
1793
1879
|
*/
|
|
1794
|
-
interface InputHelperProps extends
|
|
1880
|
+
interface InputHelperProps$1 extends HasClassName, HasTheme {
|
|
1795
1881
|
/** Helper content. */
|
|
1796
1882
|
children: JSXElement;
|
|
1797
1883
|
/** Helper variant. */
|
|
1798
1884
|
kind?: Kind;
|
|
1885
|
+
/** ref to the root element `p` */
|
|
1886
|
+
ref?: CommonRef;
|
|
1799
1887
|
}
|
|
1800
1888
|
|
|
1889
|
+
interface InputHelperProps extends InputHelperProps$1, GenericProps$3 {
|
|
1890
|
+
}
|
|
1801
1891
|
/**
|
|
1802
1892
|
* InputHelper component.
|
|
1803
1893
|
*
|
|
@@ -1807,7 +1897,7 @@ interface InputHelperProps extends GenericProps, HasTheme {
|
|
|
1807
1897
|
*/
|
|
1808
1898
|
declare const InputHelper: Comp<InputHelperProps, HTMLParagraphElement>;
|
|
1809
1899
|
|
|
1810
|
-
interface InputLabelProps extends
|
|
1900
|
+
interface InputLabelProps$1 extends HasClassName, HasTheme {
|
|
1811
1901
|
/** Typography variant. */
|
|
1812
1902
|
typography?: Typography;
|
|
1813
1903
|
/** Label content. */
|
|
@@ -1816,8 +1906,12 @@ interface InputLabelProps extends GenericProps, HasTheme {
|
|
|
1816
1906
|
htmlFor: string;
|
|
1817
1907
|
/** Whether the component is required or not. */
|
|
1818
1908
|
isRequired?: boolean;
|
|
1909
|
+
/** ref to the root element */
|
|
1910
|
+
ref?: CommonRef;
|
|
1819
1911
|
}
|
|
1820
1912
|
|
|
1913
|
+
interface InputLabelProps extends InputLabelProps$1, GenericProps$2 {
|
|
1914
|
+
}
|
|
1821
1915
|
/**
|
|
1822
1916
|
* InputLabel component.
|
|
1823
1917
|
*
|
|
@@ -1830,7 +1924,7 @@ declare const InputLabel: Comp<InputLabelProps, HTMLLabelElement>;
|
|
|
1830
1924
|
/**
|
|
1831
1925
|
* Defines the props of the component.
|
|
1832
1926
|
*/
|
|
1833
|
-
interface LightboxProps extends GenericProps$1, HasTheme$1, Pick<AriaAttributes, 'aria-label' | 'aria-labelledby'> {
|
|
1927
|
+
interface LightboxProps extends GenericProps$1, HasTheme$1, Pick<AriaAttributes$1, 'aria-label' | 'aria-labelledby'> {
|
|
1834
1928
|
/** Props to pass to the close button (minus those already set by the Lightbox props). */
|
|
1835
1929
|
closeButtonProps?: Pick<IconButtonProps, 'label'> & Omit<IconButtonProps, 'label' | 'onClick' | 'icon' | 'emphasis' | 'color'>;
|
|
1836
1930
|
/** Whether the component is open or not. */
|
|
@@ -2045,7 +2139,7 @@ declare const ListSubheader: Comp<ListSubheaderProps, HTMLLIElement>;
|
|
|
2045
2139
|
/**
|
|
2046
2140
|
* Defines the props of the component.
|
|
2047
2141
|
*/
|
|
2048
|
-
interface MessageProps extends
|
|
2142
|
+
interface MessageProps$1 extends HasClassName {
|
|
2049
2143
|
/** Content. */
|
|
2050
2144
|
children?: JSXElement;
|
|
2051
2145
|
/** Whether the message has a background or not. */
|
|
@@ -2054,6 +2148,8 @@ interface MessageProps extends GenericProps {
|
|
|
2054
2148
|
kind?: Kind;
|
|
2055
2149
|
/** Message custom icon SVG path. */
|
|
2056
2150
|
icon?: string;
|
|
2151
|
+
/** Reference to the message container element. */
|
|
2152
|
+
ref?: CommonRef;
|
|
2057
2153
|
/**
|
|
2058
2154
|
* Displays a close button.
|
|
2059
2155
|
*
|
|
@@ -2067,6 +2163,10 @@ interface MessageProps extends GenericProps {
|
|
|
2067
2163
|
};
|
|
2068
2164
|
}
|
|
2069
2165
|
|
|
2166
|
+
interface MessageProps extends Omit<MessageProps$1, 'children' | 'ref'> {
|
|
2167
|
+
/** Content. */
|
|
2168
|
+
children?: React.ReactNode;
|
|
2169
|
+
}
|
|
2070
2170
|
/**
|
|
2071
2171
|
* Message component.
|
|
2072
2172
|
*
|
|
@@ -2124,7 +2224,7 @@ declare const NavigationItem: (<E extends ElementType = "a">(props: React$1.Prop
|
|
|
2124
2224
|
type NavigationProps = React.ComponentProps<'nav'> & HasClassName$1 & HasTheme$1 & {
|
|
2125
2225
|
/** Content of the navigation. These components should be of type NavigationItem to be rendered */
|
|
2126
2226
|
children?: React.ReactNode;
|
|
2127
|
-
orientation?: Orientation;
|
|
2227
|
+
orientation?: Orientation$1;
|
|
2128
2228
|
} & HasAriaLabelOrLabelledBy;
|
|
2129
2229
|
type SubComponents = {
|
|
2130
2230
|
Section: typeof NavigationSection;
|
|
@@ -2189,7 +2289,7 @@ interface PostBlockProps extends GenericProps$1, HasTheme$1 {
|
|
|
2189
2289
|
/** Metadata content. */
|
|
2190
2290
|
meta?: ReactNode;
|
|
2191
2291
|
/** Orientation. */
|
|
2192
|
-
orientation?: Orientation;
|
|
2292
|
+
orientation?: Orientation$1;
|
|
2193
2293
|
/** Tag content. */
|
|
2194
2294
|
tags?: ReactNode;
|
|
2195
2295
|
/** Content (string, or sanitized html). */
|
|
@@ -2898,7 +2998,7 @@ interface SwitchProps extends GenericProps$1, HasTheme$1, HasAriaDisabled$1 {
|
|
|
2898
2998
|
/** Native input name property. */
|
|
2899
2999
|
name?: string;
|
|
2900
3000
|
/** Position of the switch relative to the label. */
|
|
2901
|
-
position?: Extract<Alignment, 'right' | 'left'>;
|
|
3001
|
+
position?: Extract<Alignment$1, 'right' | 'left'>;
|
|
2902
3002
|
/** Native input value property. */
|
|
2903
3003
|
value?: string;
|
|
2904
3004
|
/** On change callback. */
|
|
@@ -3071,7 +3171,7 @@ interface TabListProps extends GenericProps$1, HasTheme$1 {
|
|
|
3071
3171
|
/** Layout of the tabs in the list. */
|
|
3072
3172
|
layout?: TabListLayout;
|
|
3073
3173
|
/** Position of the tabs in the list (requires 'clustered' layout). */
|
|
3074
|
-
position?: Alignment;
|
|
3174
|
+
position?: Alignment$1;
|
|
3075
3175
|
}
|
|
3076
3176
|
/**
|
|
3077
3177
|
* TabList component.
|
|
@@ -3136,6 +3236,8 @@ interface TabPanelProps extends GenericProps$1 {
|
|
|
3136
3236
|
*/
|
|
3137
3237
|
declare const TabPanel: Comp<TabPanelProps, HTMLDivElement>;
|
|
3138
3238
|
|
|
3239
|
+
interface TextProps extends TextProps$1, GenericProps$1 {
|
|
3240
|
+
}
|
|
3139
3241
|
/**
|
|
3140
3242
|
* Text component.
|
|
3141
3243
|
*
|
|
@@ -3366,7 +3468,7 @@ interface UserBlockProps extends GenericProps$1, HasTheme$1 {
|
|
|
3366
3468
|
/** Props to pass to the name block. */
|
|
3367
3469
|
nameProps?: GenericProps$1;
|
|
3368
3470
|
/** Orientation. */
|
|
3369
|
-
orientation?: Orientation;
|
|
3471
|
+
orientation?: Orientation$1;
|
|
3370
3472
|
/** Simple action toolbar content. */
|
|
3371
3473
|
simpleAction?: ReactNode;
|
|
3372
3474
|
/** Size variant. */
|