@lumx/react 4.9.0-next.9 → 4.10.0-alpha.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/index.d.ts +157 -57
- package/index.js +1180 -951
- package/index.js.map +1 -1
- package/package.json +6 -6
package/index.d.ts
CHANGED
|
@@ -1579,6 +1579,12 @@ interface ComboboxOptionSkeletonProps$1 extends HasClassName {
|
|
|
1579
1579
|
children?: JSXElement;
|
|
1580
1580
|
/** ref to the root <li> element. */
|
|
1581
1581
|
ref?: CommonRef;
|
|
1582
|
+
/**
|
|
1583
|
+
* Number of skeleton `<li>` elements to render.
|
|
1584
|
+
* Each is an independent element with `:nth-child` width cycling applied by SCSS.
|
|
1585
|
+
* @default 1
|
|
1586
|
+
*/
|
|
1587
|
+
count?: number;
|
|
1582
1588
|
}
|
|
1583
1589
|
/**
|
|
1584
1590
|
* Props that React/Vue wrappers need to re-declare with framework-specific types.
|
|
@@ -1596,12 +1602,6 @@ interface ComboboxOptionSkeletonProps extends GenericProps$1, ReactToJSX<Combobo
|
|
|
1596
1602
|
after?: ReactNode;
|
|
1597
1603
|
/** Override the default SkeletonTypography content entirely. */
|
|
1598
1604
|
children?: ReactNode;
|
|
1599
|
-
/**
|
|
1600
|
-
* Number of skeleton `<li>` elements to render.
|
|
1601
|
-
* Each is an independent element with `:nth-child` width cycling applied by SCSS.
|
|
1602
|
-
* @default 1
|
|
1603
|
-
*/
|
|
1604
|
-
count?: number;
|
|
1605
1605
|
}
|
|
1606
1606
|
|
|
1607
1607
|
/**
|
|
@@ -1889,6 +1889,7 @@ interface RawInputTextProps$1 extends HasTheme, HasClassName {
|
|
|
1889
1889
|
name?: string | undefined;
|
|
1890
1890
|
ref?: CommonRef;
|
|
1891
1891
|
handleChange?: (value: string, name?: string, event?: any) => void;
|
|
1892
|
+
handleInput?: (value: string, name?: string, event?: any) => void;
|
|
1892
1893
|
}
|
|
1893
1894
|
|
|
1894
1895
|
type NativeInputProps = Omit<ComponentProps<'input'>, 'value' | 'onChange'>;
|
|
@@ -1914,6 +1915,7 @@ interface RawInputTextareaProps$1 extends HasTheme, HasClassName {
|
|
|
1914
1915
|
name?: string | undefined;
|
|
1915
1916
|
ref?: CommonRef;
|
|
1916
1917
|
handleChange?: (value: string, name?: string, event?: any) => void;
|
|
1918
|
+
handleInput?: (value: string, name?: string, event?: any) => void;
|
|
1917
1919
|
}
|
|
1918
1920
|
|
|
1919
1921
|
type NativeTextareaProps = Omit<ComponentProps<'textarea'>, 'value' | 'onChange'>;
|
|
@@ -2107,7 +2109,7 @@ declare const Combobox: {
|
|
|
2107
2109
|
};
|
|
2108
2110
|
/** Loading placeholder skeleton(s) that auto-register loading state with the combobox handle. */
|
|
2109
2111
|
OptionSkeleton: {
|
|
2110
|
-
(props: ComboboxOptionSkeletonProps): react_jsx_runtime.JSX.Element
|
|
2112
|
+
(props: ComboboxOptionSkeletonProps): react_jsx_runtime.JSX.Element;
|
|
2111
2113
|
displayName: string;
|
|
2112
2114
|
className: "lumx-combobox-option-skeleton";
|
|
2113
2115
|
};
|
|
@@ -2458,7 +2460,7 @@ declare const Dropdown: Comp<DropdownProps, HTMLDivElement>;
|
|
|
2458
2460
|
/**
|
|
2459
2461
|
* Defines the props of the component.
|
|
2460
2462
|
*/
|
|
2461
|
-
interface ExpansionPanelProps extends
|
|
2463
|
+
interface ExpansionPanelProps$1 extends HasClassName, HasCloseMode, HasTheme {
|
|
2462
2464
|
/** Whether the expansion panel has a background. */
|
|
2463
2465
|
hasBackground?: boolean;
|
|
2464
2466
|
/** Whether the header has a divider. */
|
|
@@ -2467,6 +2469,41 @@ interface ExpansionPanelProps extends GenericProps$1, HasCloseMode$1, HasTheme$1
|
|
|
2467
2469
|
isOpen?: boolean;
|
|
2468
2470
|
/** Label text (overwritten if a `<header>` is provided in the children). */
|
|
2469
2471
|
label?: string;
|
|
2472
|
+
/** On open callback. */
|
|
2473
|
+
handleOpen?: (event: any) => void;
|
|
2474
|
+
/** On close callback. */
|
|
2475
|
+
handleClose?: (event: any) => void;
|
|
2476
|
+
/** Props to pass to the toggle button (minus those already set by the ExpansionPanel props). */
|
|
2477
|
+
toggleButtonProps: any;
|
|
2478
|
+
/** On toggle open or close callback. */
|
|
2479
|
+
handleToggleOpen?(shouldOpen: boolean, event: any): void;
|
|
2480
|
+
/** Children */
|
|
2481
|
+
children?: JSXElement;
|
|
2482
|
+
/** Ref forwarded to the root `<section>` element. */
|
|
2483
|
+
ref?: CommonRef;
|
|
2484
|
+
/** Ref forwarded to the collapsible wrapper `<div>`. */
|
|
2485
|
+
wrapperRef?: CommonRef;
|
|
2486
|
+
/** Props spread onto the header content `<div>` (e.g. `aria-*`, `data-*`). */
|
|
2487
|
+
headerProps: GenericProps;
|
|
2488
|
+
/** Content rendered inside the header content area. */
|
|
2489
|
+
headerContent?: JSXElement;
|
|
2490
|
+
/** Optional drag handle element rendered at the start of the header. */
|
|
2491
|
+
dragHandle?: JSXElement;
|
|
2492
|
+
/** Content rendered inside the collapsible content area. */
|
|
2493
|
+
content?: JSXElement;
|
|
2494
|
+
/** Optional footer element rendered below the content. */
|
|
2495
|
+
footer?: JSXElement;
|
|
2496
|
+
/** IconButton component injected by the framework wrapper (React or Vue). */
|
|
2497
|
+
IconButton: any;
|
|
2498
|
+
/** Whether the children should remain mounted (visible in the DOM) while the panel is closed. */
|
|
2499
|
+
isChildrenVisible?: boolean;
|
|
2500
|
+
}
|
|
2501
|
+
type ExpansionPanelPropsToOverride = 'handleOpen' | 'handleClose' | 'toggleButtonProps' | 'handleToggleOpen' | 'wrapperRef' | 'headerProps' | 'headerContent' | 'dragHandle' | 'content' | 'IconButton' | 'isChildrenVisible' | 'footer';
|
|
2502
|
+
|
|
2503
|
+
/**
|
|
2504
|
+
* Defines the props of the component.
|
|
2505
|
+
*/
|
|
2506
|
+
interface ExpansionPanelProps extends GenericProps$1, ReactToJSX<ExpansionPanelProps$1, ExpansionPanelPropsToOverride> {
|
|
2470
2507
|
/** On open callback. */
|
|
2471
2508
|
onOpen?: (event: React__default.MouseEvent) => void;
|
|
2472
2509
|
/** On close callback. */
|
|
@@ -2475,8 +2512,6 @@ interface ExpansionPanelProps extends GenericProps$1, HasCloseMode$1, HasTheme$1
|
|
|
2475
2512
|
toggleButtonProps: Pick<IconButtonProps, 'label'> & Omit<IconButtonProps, 'label' | 'onClick' | 'icon' | 'emphasis' | 'color'>;
|
|
2476
2513
|
/** On toggle open or close callback. */
|
|
2477
2514
|
onToggleOpen?(shouldOpen: boolean, event: React__default.MouseEvent): void;
|
|
2478
|
-
/** Children */
|
|
2479
|
-
children?: React__default.ReactNode;
|
|
2480
2515
|
}
|
|
2481
2516
|
/**
|
|
2482
2517
|
* ExpansionPanel component.
|
|
@@ -2848,6 +2883,71 @@ interface IconProps extends ReactToJSX<IconProps$1>, GenericProps$1 {
|
|
|
2848
2883
|
*/
|
|
2849
2884
|
declare const Icon: Comp<IconProps, HTMLElement>;
|
|
2850
2885
|
|
|
2886
|
+
type ImageCaptionMetadata$1 = {
|
|
2887
|
+
/** Image title to display in the caption. */
|
|
2888
|
+
title?: string;
|
|
2889
|
+
/** Props to pass to the title. */
|
|
2890
|
+
titleProps?: GenericProps;
|
|
2891
|
+
/** Image description. Can be either a string, ReactNode, or sanitized html object. */
|
|
2892
|
+
description?: JSXElement | {
|
|
2893
|
+
__html: string;
|
|
2894
|
+
};
|
|
2895
|
+
/** Props to pass to the description. */
|
|
2896
|
+
descriptionProps?: GenericProps;
|
|
2897
|
+
/** Tag content. */
|
|
2898
|
+
tags?: JSXElement;
|
|
2899
|
+
/** Caption custom CSS style. */
|
|
2900
|
+
captionStyle?: GenericProps;
|
|
2901
|
+
/** Props to pass to the wrapper FlexBox element. */
|
|
2902
|
+
wrapperProps?: GenericProps;
|
|
2903
|
+
/** FlexBox component injected by the framework wrapper (React or Vue). */
|
|
2904
|
+
FlexBox: any;
|
|
2905
|
+
/** Text component injected by the framework wrapper (React or Vue). */
|
|
2906
|
+
Text: any;
|
|
2907
|
+
};
|
|
2908
|
+
type ImageCaptionPropsToOverride = 'FlexBox' | 'Text' | 'wrapperProps';
|
|
2909
|
+
|
|
2910
|
+
/**
|
|
2911
|
+
* Image block variants.
|
|
2912
|
+
*/
|
|
2913
|
+
declare const ImageBlockCaptionPosition: {
|
|
2914
|
+
readonly below: "below";
|
|
2915
|
+
readonly over: "over";
|
|
2916
|
+
};
|
|
2917
|
+
type ImageBlockCaptionPosition = ValueOf<typeof ImageBlockCaptionPosition>;
|
|
2918
|
+
/**
|
|
2919
|
+
* Image block sizes.
|
|
2920
|
+
*/
|
|
2921
|
+
type ImageBlockSize$1 = Extract<Size, 'xl' | 'xxl'>;
|
|
2922
|
+
/**
|
|
2923
|
+
* Defines the props of the component.
|
|
2924
|
+
*/
|
|
2925
|
+
interface ImageBlockProps$1 extends HasClassName, HasTheme, Omit<ImageCaptionMetadata$1, ImageCaptionPropsToOverride> {
|
|
2926
|
+
/** Action toolbar content. */
|
|
2927
|
+
actions?: JSXElement;
|
|
2928
|
+
/** Alignment. */
|
|
2929
|
+
align?: HorizontalAlignment;
|
|
2930
|
+
/** Image alternative text. */
|
|
2931
|
+
alt: string;
|
|
2932
|
+
/** Caption position. */
|
|
2933
|
+
captionPosition?: ImageBlockCaptionPosition;
|
|
2934
|
+
/** Whether the image has to fill its container height or not. */
|
|
2935
|
+
fillHeight?: boolean;
|
|
2936
|
+
/** Image URL. */
|
|
2937
|
+
image: string;
|
|
2938
|
+
/** Size variant. */
|
|
2939
|
+
size?: ImageBlockSize$1;
|
|
2940
|
+
/** Props to pass to the thumbnail (minus those already set by the ImageBlock props). */
|
|
2941
|
+
thumbnailProps?: GenericProps;
|
|
2942
|
+
/** reference to the root element */
|
|
2943
|
+
ref?: CommonRef;
|
|
2944
|
+
/** component for rendering the thumbnail */
|
|
2945
|
+
Thumbnail: any;
|
|
2946
|
+
/** component for rendering the image caption */
|
|
2947
|
+
ImageCaption: any;
|
|
2948
|
+
}
|
|
2949
|
+
type ImageBlockPropsToOverride = 'Thumbnail' | 'ImageCaption' | 'thumbnailProps';
|
|
2950
|
+
|
|
2851
2951
|
/**
|
|
2852
2952
|
* Loading attribute is not yet supported in typescript, so we need
|
|
2853
2953
|
* to add it in order to avoid a ts error.
|
|
@@ -2997,32 +3097,6 @@ interface ThumbnailProps extends GenericProps$1, ReactToJSX<ThumbnailProps$1, 'l
|
|
|
2997
3097
|
*/
|
|
2998
3098
|
declare const Thumbnail: Comp<ThumbnailProps, HTMLElement>;
|
|
2999
3099
|
|
|
3000
|
-
type ForwardedTextProps = Omit<TextProps, 'as' | 'typography' | 'color' | 'colorVariant'>;
|
|
3001
|
-
type ImageCaptionMetadata = {
|
|
3002
|
-
/** Image title to display in the caption. */
|
|
3003
|
-
title?: string;
|
|
3004
|
-
/** Props to pass to the title. */
|
|
3005
|
-
titleProps?: ForwardedTextProps;
|
|
3006
|
-
/** Image description. Can be either a string, or sanitized html. */
|
|
3007
|
-
description?: string | {
|
|
3008
|
-
__html: string;
|
|
3009
|
-
};
|
|
3010
|
-
/** Props to pass to the title. */
|
|
3011
|
-
descriptionProps?: ForwardedTextProps;
|
|
3012
|
-
/** Tag content. */
|
|
3013
|
-
tags?: ReactNode;
|
|
3014
|
-
/** Caption custom CSS style. */
|
|
3015
|
-
captionStyle?: CSSProperties;
|
|
3016
|
-
};
|
|
3017
|
-
|
|
3018
|
-
/**
|
|
3019
|
-
* Image block variants.
|
|
3020
|
-
*/
|
|
3021
|
-
declare const ImageBlockCaptionPosition: {
|
|
3022
|
-
readonly below: "below";
|
|
3023
|
-
readonly over: "over";
|
|
3024
|
-
};
|
|
3025
|
-
type ImageBlockCaptionPosition = ValueOf$1<typeof ImageBlockCaptionPosition>;
|
|
3026
3100
|
/**
|
|
3027
3101
|
* Image block sizes.
|
|
3028
3102
|
*/
|
|
@@ -3030,21 +3104,7 @@ type ImageBlockSize = Extract<Size$1, 'xl' | 'xxl'>;
|
|
|
3030
3104
|
/**
|
|
3031
3105
|
* Defines the props of the component.
|
|
3032
3106
|
*/
|
|
3033
|
-
interface ImageBlockProps extends GenericProps$1,
|
|
3034
|
-
/** Action toolbar content. */
|
|
3035
|
-
actions?: ReactNode;
|
|
3036
|
-
/** Alignment. */
|
|
3037
|
-
align?: HorizontalAlignment$1;
|
|
3038
|
-
/** Image alternative text. */
|
|
3039
|
-
alt: string;
|
|
3040
|
-
/** Caption position. */
|
|
3041
|
-
captionPosition?: ImageBlockCaptionPosition;
|
|
3042
|
-
/** Whether the image has to fill its container height or not. */
|
|
3043
|
-
fillHeight?: boolean;
|
|
3044
|
-
/** Image URL. */
|
|
3045
|
-
image: string;
|
|
3046
|
-
/** Size variant. */
|
|
3047
|
-
size?: ImageBlockSize;
|
|
3107
|
+
interface ImageBlockProps extends GenericProps$1, ReactToJSX<ImageBlockProps$1, ImageBlockPropsToOverride> {
|
|
3048
3108
|
/** Props to pass to the thumbnail (minus those already set by the ImageBlock props). */
|
|
3049
3109
|
thumbnailProps?: Omit<ThumbnailProps, 'image' | 'size' | 'theme' | 'align' | 'fillHeight'>;
|
|
3050
3110
|
}
|
|
@@ -3057,6 +3117,16 @@ interface ImageBlockProps extends GenericProps$1, HasTheme$1, ImageCaptionMetada
|
|
|
3057
3117
|
*/
|
|
3058
3118
|
declare const ImageBlock: Comp<ImageBlockProps, HTMLDivElement>;
|
|
3059
3119
|
|
|
3120
|
+
type ForwardedTextProps = Omit<TextProps, 'as' | 'typography' | 'color' | 'colorVariant'>;
|
|
3121
|
+
type ImageCaptionMetadata = Omit<ImageCaptionMetadata$1, ImageCaptionPropsToOverride> & {
|
|
3122
|
+
/** Props to pass to the title. */
|
|
3123
|
+
titleProps?: ForwardedTextProps;
|
|
3124
|
+
/** Props to pass to the title. */
|
|
3125
|
+
descriptionProps?: ForwardedTextProps;
|
|
3126
|
+
/** Caption custom CSS style. */
|
|
3127
|
+
captionStyle?: CSSProperties;
|
|
3128
|
+
};
|
|
3129
|
+
|
|
3060
3130
|
type InheritedSlideShowProps = Pick<SlideshowProps, 'slideshowControlsProps' | 'slideGroupLabel'>;
|
|
3061
3131
|
interface ZoomButtonProps {
|
|
3062
3132
|
/** Zoom in button props */
|
|
@@ -3288,21 +3358,38 @@ declare const Link: Comp<LinkProps, HTMLButtonElement | HTMLAnchorElement>;
|
|
|
3288
3358
|
/**
|
|
3289
3359
|
* Defines the props of the component.
|
|
3290
3360
|
*/
|
|
3291
|
-
interface LinkPreviewProps extends
|
|
3361
|
+
interface LinkPreviewProps$1 extends HasClassName, HasTheme {
|
|
3292
3362
|
/** Description. */
|
|
3293
3363
|
description?: string;
|
|
3294
3364
|
/** Link URL. */
|
|
3295
3365
|
link: string;
|
|
3296
|
-
/** Custom
|
|
3366
|
+
/** Custom component for the link (can be used to inject a router Link). */
|
|
3297
3367
|
linkAs?: 'a' | any;
|
|
3298
3368
|
/** Props to pass to the link (minus those already set by the LinkPreview props). */
|
|
3299
|
-
linkProps?:
|
|
3369
|
+
linkProps?: GenericProps;
|
|
3300
3370
|
/** Size variant. */
|
|
3301
|
-
size?: Extract<Size
|
|
3371
|
+
size?: Extract<Size, 'regular' | 'big'>;
|
|
3302
3372
|
/** Thumbnail for the link preview. */
|
|
3303
|
-
thumbnailProps?:
|
|
3373
|
+
thumbnailProps?: GenericProps;
|
|
3304
3374
|
/** Title. */
|
|
3305
3375
|
title?: string;
|
|
3376
|
+
/** Ref forwarded to the root article element. */
|
|
3377
|
+
ref?: CommonRef;
|
|
3378
|
+
/** Heading element used to wrap the title. */
|
|
3379
|
+
TitleHeading: any;
|
|
3380
|
+
/** Link component injected by the framework wrapper. */
|
|
3381
|
+
Link: any;
|
|
3382
|
+
/** Thumbnail component injected by the framework wrapper. */
|
|
3383
|
+
Thumbnail: any;
|
|
3384
|
+
}
|
|
3385
|
+
type LinkPreviewPropsToOverride = 'linkProps' | 'TitleHeading' | 'Link' | 'Thumbnail' | 'thumbnailProps';
|
|
3386
|
+
|
|
3387
|
+
/**
|
|
3388
|
+
* Defines the props of the component.
|
|
3389
|
+
*/
|
|
3390
|
+
interface LinkPreviewProps extends GenericProps$1, ReactToJSX<LinkPreviewProps$1, LinkPreviewPropsToOverride> {
|
|
3391
|
+
/** Props to pass to the link (minus those already set by the LinkPreview props). */
|
|
3392
|
+
linkProps?: Omit<LinkProps, 'color' | 'colorVariant' | 'href' | 'target'>;
|
|
3306
3393
|
/** Customize the title heading tag. */
|
|
3307
3394
|
titleHeading?: HeadingElement$1;
|
|
3308
3395
|
}
|
|
@@ -3356,7 +3443,20 @@ declare const Message: Comp<MessageProps, HTMLDivElement>;
|
|
|
3356
3443
|
/**
|
|
3357
3444
|
* Defines the props of the component.
|
|
3358
3445
|
*/
|
|
3359
|
-
interface MosaicProps extends
|
|
3446
|
+
interface MosaicProps$1 extends HasClassName, HasTheme {
|
|
3447
|
+
/** Thumbnails. */
|
|
3448
|
+
thumbnails: any[];
|
|
3449
|
+
/** On image click callback. */
|
|
3450
|
+
handleClick?(index: number): void;
|
|
3451
|
+
Thumbnail: any;
|
|
3452
|
+
ref?: CommonRef;
|
|
3453
|
+
}
|
|
3454
|
+
type MosaicPropsToOverride = 'Thumbnail' | 'thumbnails';
|
|
3455
|
+
|
|
3456
|
+
/**
|
|
3457
|
+
* Defines the props of the component.
|
|
3458
|
+
*/
|
|
3459
|
+
interface MosaicProps extends GenericProps$1, ReactToJSX<MosaicProps$1, MosaicPropsToOverride> {
|
|
3360
3460
|
/** Thumbnails. */
|
|
3361
3461
|
thumbnails: ThumbnailProps[];
|
|
3362
3462
|
/** On image click callback. */
|