@lumx/react 4.3.2-alpha.6 → 4.3.2-alpha.7
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/_internal/BcRzrT9Y.js +1480 -0
- package/_internal/BcRzrT9Y.js.map +1 -0
- package/index.d.ts +523 -21
- package/index.js +2027 -329
- package/index.js.map +1 -1
- package/package.json +3 -3
- package/utils/index.js +3 -1322
- package/utils/index.js.map +1 -1
- package/_internal/DpdvhbTO.js +0 -159
- package/_internal/DpdvhbTO.js.map +0 -1
package/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { Kind as Kind$1, HorizontalAlignment as HorizontalAlignment$1, Size as Size$1, ColorPalette as ColorPalette$1, Theme as Theme$1, Orientation as Orientation$1, Alignment as Alignment$1, AspectRatio as AspectRatio$1, ColorWithVariants as ColorWithVariants$1, ColorVariant as ColorVariant$1, Typography as Typography$1, Emphasis as Emphasis$1 } from '@lumx/core/js/constants';
|
|
1
|
+
import { Kind as Kind$1, HorizontalAlignment as HorizontalAlignment$1, Size as Size$1, ColorPalette as ColorPalette$1, Theme as Theme$1, GenericProps as GenericProps$1, Orientation as Orientation$1, Alignment as Alignment$1, AspectRatio as AspectRatio$1, ColorWithVariants as ColorWithVariants$1, ColorVariant as ColorVariant$1, Typography as Typography$1, Emphasis as Emphasis$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
|
-
import { GenericProps, HasTheme as HasTheme$1, ValueOf as ValueOf$1, HasAriaDisabled as HasAriaDisabled$1, HasCloseMode, HasClassName as HasClassName$1, JSXElement as JSXElement$1, CommonRef as CommonRef$1, Falsy, HeadingElement as HeadingElement$1, HasRequiredLinkHref, HasAriaLabelOrLabelledBy } from '@lumx/core/js/types';
|
|
4
|
+
import { GenericProps, HasTheme as HasTheme$1, ValueOf as ValueOf$1, HasAriaDisabled as HasAriaDisabled$1, PartialBy, HasCloseMode, HasClassName as HasClassName$1, JSXElement as JSXElement$1, CommonRef as CommonRef$1, Falsy, 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, AriaAttributes, RefObject, CSSProperties, ImgHTMLAttributes, SetStateAction, Key, ElementType, ComponentProps } from 'react';
|
|
7
|
+
import React__default, { Ref, ReactElement, ReactNode, SyntheticEvent, MouseEventHandler, KeyboardEventHandler, AriaAttributes, ReactText, RefObject, CSSProperties, ImgHTMLAttributes, SetStateAction, Key, ElementType, ComponentProps } from 'react';
|
|
8
8
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
9
9
|
import { Selector } from '@lumx/core/js/types/Selector';
|
|
10
10
|
|
|
@@ -512,12 +512,6 @@ type TextElement = 'span' | 'p' | HeadingElement;
|
|
|
512
512
|
/** Get types of the values of a record. */
|
|
513
513
|
type ValueOf<T extends Record<any, any>> = T[keyof T];
|
|
514
514
|
|
|
515
|
-
/** Transform a string literal into kebab case */
|
|
516
|
-
type KebabCase<S> = S extends `${infer C}${infer T}` ? T extends Uncapitalize<T> ? `${Uncapitalize<C>}${KebabCase<T>}` : `${Uncapitalize<C>}-${KebabCase<T>}` : S;
|
|
517
|
-
|
|
518
|
-
/** Transform the component name into the lumx class name. */
|
|
519
|
-
type LumxClassName<TComponentName extends string> = `lumx-${KebabCase<TComponentName>}`;
|
|
520
|
-
|
|
521
515
|
type CommonRef = any;
|
|
522
516
|
|
|
523
517
|
type Booleanish = boolean | 'true' | 'false';
|
|
@@ -655,10 +649,6 @@ interface ButtonProps$1 extends BaseButtonProps {
|
|
|
655
649
|
* Component display name.
|
|
656
650
|
*/
|
|
657
651
|
declare const COMPONENT_NAME = "Button";
|
|
658
|
-
/**
|
|
659
|
-
* Component default class name and class prefix.
|
|
660
|
-
*/
|
|
661
|
-
declare const CLASSNAME: LumxClassName<typeof COMPONENT_NAME>;
|
|
662
652
|
/**
|
|
663
653
|
* Component default props.
|
|
664
654
|
*/
|
|
@@ -673,7 +663,7 @@ interface ButtonProps extends GenericProps, ButtonProps$1 {
|
|
|
673
663
|
* @param ref Component ref.
|
|
674
664
|
* @return React element.
|
|
675
665
|
*/
|
|
676
|
-
declare const Button: Comp<ButtonProps,
|
|
666
|
+
declare const Button: Comp<ButtonProps, HTMLButtonElement | HTMLAnchorElement>;
|
|
677
667
|
|
|
678
668
|
interface IconButtonProps$1 extends BaseButtonProps {
|
|
679
669
|
/**
|
|
@@ -898,6 +888,503 @@ interface SelectionChipGroupProps<O> extends GenericProps {
|
|
|
898
888
|
*/
|
|
899
889
|
declare const SelectionChipGroup: <O>({ onChange, value, getOptionId, getOptionName, inputRef, inputLabel, renderChip, theme, isDisabled, chipTooltipLabel, label, ...forwardedProps }: SelectionChipGroupProps<O>) => react_jsx_runtime.JSX.Element;
|
|
900
890
|
|
|
891
|
+
interface ComboboxButtonProps extends GenericProps {
|
|
892
|
+
/**
|
|
893
|
+
* Label of the combobox button trigger.
|
|
894
|
+
*/
|
|
895
|
+
label: string;
|
|
896
|
+
/**
|
|
897
|
+
* Controls how the `label` is displayed:
|
|
898
|
+
* - `show-selection` (default): Displays the current selection as the label, or falls back to the provided `label`
|
|
899
|
+
* if there is no selection. The `label` will still appear as a tooltip in this mode.
|
|
900
|
+
* - `show-label`: Always displays the provided `label` as the visual label.
|
|
901
|
+
* - `show-tooltip`: Always displays the provided `label` as the visual a tooltip.
|
|
902
|
+
* (useful for IconButton combobox)
|
|
903
|
+
* In all cases, the given `label` is the ARIA label in use
|
|
904
|
+
*/
|
|
905
|
+
labelDisplayMode?: 'show-selection' | 'show-label' | 'show-tooltip';
|
|
906
|
+
/**
|
|
907
|
+
* Focus event handler
|
|
908
|
+
*/
|
|
909
|
+
onFocus?: React__default.FocusEventHandler;
|
|
910
|
+
/**
|
|
911
|
+
* Blur event handler
|
|
912
|
+
*/
|
|
913
|
+
onBlur?: React__default.FocusEventHandler;
|
|
914
|
+
/** Customize the root element. */
|
|
915
|
+
as?: React__default.ElementType;
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* Combobox button trigger.
|
|
919
|
+
*
|
|
920
|
+
* @family Combobox
|
|
921
|
+
*/
|
|
922
|
+
declare const ComboboxButton: Comp<ComboboxButtonProps, HTMLElement>;
|
|
923
|
+
|
|
924
|
+
/** Combobox option divider */
|
|
925
|
+
declare function ComboboxDivider(): react_jsx_runtime.JSX.Element;
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* All TextField props that are extended.
|
|
929
|
+
* We can't use "Omit" here as it is not compatible with the "GenericProps" type from the DS,
|
|
930
|
+
* meaning we would loose all props.
|
|
931
|
+
*
|
|
932
|
+
*/
|
|
933
|
+
type ExtendedTextFieldProps = PartialBy<Pick<TextFieldProps, 'ariaLabel' | 'chips' | 'error' | 'forceFocusStyle' | 'hasError' | 'afterElement' | 'helper' | 'icon' | 'inputRef' | 'textFieldRef' | 'isDisabled' | 'className' | 'isRequired' | 'isValid' | 'label' | 'maxLength' | 'minimumRows' | 'multiline' | 'id' | 'name' | 'placeholder' | 'onBlur' | 'onClear' | 'onKeyDown' | 'onFocus' | 'theme'>, 'ariaLabel' | 'onKeyDown'>;
|
|
934
|
+
type ComboboxInputProps = ExtendedTextFieldProps & {
|
|
935
|
+
/** Whether the toggle button should be hidden */
|
|
936
|
+
hideToggle?: boolean;
|
|
937
|
+
/** Activate the clear button */
|
|
938
|
+
hasClearButton?: boolean;
|
|
939
|
+
/** Clear button forwarded props */
|
|
940
|
+
clearButtonProps?: Omit<TextFieldProps['clearButtonProps'], 'label'>;
|
|
941
|
+
/** Make input read only */
|
|
942
|
+
readOnly?: boolean;
|
|
943
|
+
};
|
|
944
|
+
/**
|
|
945
|
+
* Combobox input trigger.
|
|
946
|
+
*
|
|
947
|
+
* @family Combobox
|
|
948
|
+
*/
|
|
949
|
+
declare const ComboboxInput: ({ hideToggle, inputRef, textFieldRef, afterElement, onFocus, onBlur, onKeyDown, clearButtonProps, hasClearButton, theme, ...textFieldProps }: ComboboxInputProps) => react_jsx_runtime.JSX.Element;
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* The source of the combobox option selection
|
|
953
|
+
* It could either be on click / touch or keyboard selection
|
|
954
|
+
*/
|
|
955
|
+
type ComboboxOptionSelectEventSource = 'keyboard' | 'click';
|
|
956
|
+
type ComboboxSelectionType = 'single' | 'multiple';
|
|
957
|
+
type BaseLoadingStatus = 'loading' | 'loadingMore' | 'idle' | 'error' | 'debouncing' | 'filtering' | 'empty';
|
|
958
|
+
/**
|
|
959
|
+
* Options related types
|
|
960
|
+
*/
|
|
961
|
+
/** All possible values a combobox option can have */
|
|
962
|
+
type BaseComboboxOptionProps<O = any> = {
|
|
963
|
+
/**
|
|
964
|
+
* A unique id to track the option
|
|
965
|
+
*/
|
|
966
|
+
id: string;
|
|
967
|
+
/**
|
|
968
|
+
* Whether the current input value should filter this option.
|
|
969
|
+
*/
|
|
970
|
+
filterFromInput?: boolean;
|
|
971
|
+
/**
|
|
972
|
+
* Callback to call when the option is selected.
|
|
973
|
+
* This should only be used to add custom actions on options.
|
|
974
|
+
* For most cases, the "onSelect" on the Combobox root component should be enough.
|
|
975
|
+
*/
|
|
976
|
+
onSelect?: (option: O, eventSource?: ComboboxOptionSelectEventSource) => void;
|
|
977
|
+
/**
|
|
978
|
+
* Additional data to link to the option. This can be useful to retrieve with `onSelect`.
|
|
979
|
+
*/
|
|
980
|
+
data?: O;
|
|
981
|
+
/**
|
|
982
|
+
* Whether the option is disabled
|
|
983
|
+
*/
|
|
984
|
+
isDisabled?: boolean;
|
|
985
|
+
/**
|
|
986
|
+
* The components to use to visually customize options.
|
|
987
|
+
* ! Options must not have interactive elements.
|
|
988
|
+
* ! If you need additional actions, you might need to create custom options and search how to
|
|
989
|
+
* ! make them accessible.
|
|
990
|
+
*/
|
|
991
|
+
children?: ReactNode;
|
|
992
|
+
/**
|
|
993
|
+
* The text value the option has.
|
|
994
|
+
* This is the value used to filter the options by when manual filtering is disabled
|
|
995
|
+
* and that will be used as input value when an option is selected
|
|
996
|
+
*/
|
|
997
|
+
textValue?: string;
|
|
998
|
+
/**
|
|
999
|
+
* Element to display before the content of the option.
|
|
1000
|
+
* ! Options must not have interactive elements.
|
|
1001
|
+
* ! If you need additional actions, you might need to create custom options and search how to
|
|
1002
|
+
* ! make them accessible.
|
|
1003
|
+
*/
|
|
1004
|
+
before?: ReactNode;
|
|
1005
|
+
/**
|
|
1006
|
+
* Element to display after the content of the option.
|
|
1007
|
+
* ! Options must not have interactive elements.
|
|
1008
|
+
* ! If you need additional actions, you might need to create custom options and search how to
|
|
1009
|
+
* ! make them accessible.
|
|
1010
|
+
*/
|
|
1011
|
+
after?: ReactNode;
|
|
1012
|
+
/**
|
|
1013
|
+
* Size of the list item.
|
|
1014
|
+
* Default to tiny
|
|
1015
|
+
*/
|
|
1016
|
+
size?: ListItemSize;
|
|
1017
|
+
/**
|
|
1018
|
+
* Fill to activate a tooltip on mouse over
|
|
1019
|
+
*/
|
|
1020
|
+
tooltipProps?: Partial<TooltipProps>;
|
|
1021
|
+
};
|
|
1022
|
+
/**
|
|
1023
|
+
* Props for when an option has no children.
|
|
1024
|
+
* In these case, we need at least the text value to know what to display
|
|
1025
|
+
* */
|
|
1026
|
+
type TextValueOnly<O = any> = BaseComboboxOptionProps<O> & {
|
|
1027
|
+
children?: never;
|
|
1028
|
+
textValue: string;
|
|
1029
|
+
};
|
|
1030
|
+
/**
|
|
1031
|
+
* Props for when an option has a react element as string
|
|
1032
|
+
* In that case, we can use the children as the textValue without having
|
|
1033
|
+
* to set a manual props.
|
|
1034
|
+
* The props is still available to have a text value different than the displayed value.
|
|
1035
|
+
*/
|
|
1036
|
+
type StringOption<O = any> = BaseComboboxOptionProps<O> & {
|
|
1037
|
+
children: ReactText;
|
|
1038
|
+
textValue?: string;
|
|
1039
|
+
};
|
|
1040
|
+
/**
|
|
1041
|
+
* Props for when an option has a react element as children
|
|
1042
|
+
* In that case, we cannot know what the actual value of the
|
|
1043
|
+
* option is, so the `textValue` prop has to be set.
|
|
1044
|
+
*/
|
|
1045
|
+
type NodeOption<O = any> = BaseComboboxOptionProps<O> & {
|
|
1046
|
+
children: Exclude<ReactNode, ReactText>;
|
|
1047
|
+
textValue: string;
|
|
1048
|
+
};
|
|
1049
|
+
/** Props for the ComboboxOption component */
|
|
1050
|
+
type ComboboxOptionProps<O = any> = TextValueOnly<O> | StringOption<O> | NodeOption<O>;
|
|
1051
|
+
/** Shared data between all combobox option types. */
|
|
1052
|
+
interface BaseRegisteredComboboxOption {
|
|
1053
|
+
id: string;
|
|
1054
|
+
/** The id that was generated for this option */
|
|
1055
|
+
generatedId: string;
|
|
1056
|
+
/** Whether the "option" is an action */
|
|
1057
|
+
isAction?: boolean;
|
|
1058
|
+
/** Whether the "option" is disabled */
|
|
1059
|
+
isDisabled?: boolean;
|
|
1060
|
+
}
|
|
1061
|
+
/** Combobox value */
|
|
1062
|
+
interface RegisteredComboboxOptionValue<O = any> extends BaseRegisteredComboboxOption, Pick<ComboboxOptionProps<O>, 'data' | 'filterFromInput' | 'textValue' | 'onSelect'> {
|
|
1063
|
+
/** The section the option is a child of. */
|
|
1064
|
+
sectionId?: string;
|
|
1065
|
+
/** Whether the "option" is an action */
|
|
1066
|
+
isAction?: never;
|
|
1067
|
+
}
|
|
1068
|
+
type OnComboboxSelect<O = any> = (option: RegisteredComboboxOptionValue<O>) => void;
|
|
1069
|
+
type OnComboboxInputChange = TextFieldProps['onChange'];
|
|
1070
|
+
type ComboboxTranslations = {
|
|
1071
|
+
clearLabel: string;
|
|
1072
|
+
showSuggestionsLabel: string;
|
|
1073
|
+
loadingLabel: string;
|
|
1074
|
+
noResultsForInputLabel: (input?: string) => string;
|
|
1075
|
+
serviceUnavailableLabel: string;
|
|
1076
|
+
tryReloadLabel: string;
|
|
1077
|
+
nbOptionsLabel: (options: number) => string;
|
|
1078
|
+
};
|
|
1079
|
+
/** Props for the main combobox component. */
|
|
1080
|
+
type ComboboxProps<O = any> = {
|
|
1081
|
+
/**
|
|
1082
|
+
* HTML id
|
|
1083
|
+
*/
|
|
1084
|
+
id?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* The current option id to set as selected.
|
|
1087
|
+
* If omitted, the local state will be used instead;
|
|
1088
|
+
*/
|
|
1089
|
+
selectedIds?: Array<string | number>;
|
|
1090
|
+
/**
|
|
1091
|
+
* The current value for the combobox input.
|
|
1092
|
+
* If omitted, the input is controlled locally */
|
|
1093
|
+
inputValue?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* The default value to set on the input.
|
|
1096
|
+
* Use this if you want to initialize the input with a value and not control it
|
|
1097
|
+
*/
|
|
1098
|
+
defaultInputValue?: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* Whether the options should be automatically filtered or not.
|
|
1101
|
+
* By default, the combobox will try to filter the options from the current input value
|
|
1102
|
+
* using a "contains" strategy.
|
|
1103
|
+
* If this is `false`, the option will not be automatically filtered and must be manually filtered by the parent.
|
|
1104
|
+
* Useful for asynchronous comboboxes.
|
|
1105
|
+
*/
|
|
1106
|
+
autoFilter: boolean;
|
|
1107
|
+
/**
|
|
1108
|
+
* Whether the combobox should open on focus
|
|
1109
|
+
*/
|
|
1110
|
+
openOnFocus?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* Whether the combobox should open on click
|
|
1113
|
+
*/
|
|
1114
|
+
openOnClick?: boolean;
|
|
1115
|
+
/**
|
|
1116
|
+
* Status of the combobox
|
|
1117
|
+
*/
|
|
1118
|
+
status?: BaseLoadingStatus;
|
|
1119
|
+
/**
|
|
1120
|
+
* Callback when the input changes.
|
|
1121
|
+
*/
|
|
1122
|
+
onInputChange?: OnComboboxInputChange;
|
|
1123
|
+
/**
|
|
1124
|
+
* Callback for when an option is selected
|
|
1125
|
+
*/
|
|
1126
|
+
onSelect?: OnComboboxSelect<O>;
|
|
1127
|
+
/**
|
|
1128
|
+
* Callback called when the combobox opens
|
|
1129
|
+
*/
|
|
1130
|
+
onOpen?: (options: {
|
|
1131
|
+
currentValue?: string;
|
|
1132
|
+
manual: boolean;
|
|
1133
|
+
}) => void;
|
|
1134
|
+
/**
|
|
1135
|
+
* The combobox components to render.
|
|
1136
|
+
* Must be one of the exposed components (Combobox.Input, Combobox.ListBox etc...)
|
|
1137
|
+
*/
|
|
1138
|
+
children: ReactNode;
|
|
1139
|
+
/**
|
|
1140
|
+
* The combobox can have a specific selection type:
|
|
1141
|
+
* - Single: only one item is selected
|
|
1142
|
+
* - Multiple: several items can be selected (this impacts the combobox list, which will now not close when selectiong an option)
|
|
1143
|
+
*/
|
|
1144
|
+
selectionType?: ComboboxSelectionType;
|
|
1145
|
+
/**
|
|
1146
|
+
* Whether the error state should be displayed when the status is in error.
|
|
1147
|
+
* @default `true` if `status` is defined
|
|
1148
|
+
*/
|
|
1149
|
+
showErrorState?: boolean;
|
|
1150
|
+
/**
|
|
1151
|
+
* Whether the empty state should be displayed when there is no results.
|
|
1152
|
+
* @default `true` if `autoFilter=false`
|
|
1153
|
+
*/
|
|
1154
|
+
showEmptyState?: boolean;
|
|
1155
|
+
/** custom className */
|
|
1156
|
+
className?: string;
|
|
1157
|
+
/** translations to be used across the combobox */
|
|
1158
|
+
translations: ComboboxTranslations;
|
|
1159
|
+
};
|
|
1160
|
+
|
|
1161
|
+
interface ComboboxOptionSkeletonProps {
|
|
1162
|
+
className?: string;
|
|
1163
|
+
index?: number;
|
|
1164
|
+
children?: ReactNode | ((options: {
|
|
1165
|
+
index?: number;
|
|
1166
|
+
}) => ReactNode);
|
|
1167
|
+
before?: ComboboxOptionProps['before'];
|
|
1168
|
+
after?: ComboboxOptionProps['after'];
|
|
1169
|
+
size?: ComboboxOptionProps['size'];
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Skeleton for a combobox option.
|
|
1173
|
+
* A typography skeleton is rendered by default but can be overridden by passing children.
|
|
1174
|
+
*/
|
|
1175
|
+
declare const ComboboxOptionSkeleton: ({ className, index, before, after, size, children, }: ComboboxOptionSkeletonProps) => react_jsx_runtime.JSX.Element;
|
|
1176
|
+
|
|
1177
|
+
interface ComboboxListSkeletonProps {
|
|
1178
|
+
isLoadingMore?: boolean;
|
|
1179
|
+
children?: ComboboxOptionSkeletonProps['children'];
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
interface ComboboxListBoxProps extends GenericProps$1, React__default.ComponentProps<'ul'> {
|
|
1183
|
+
/** Options display in the combobox */
|
|
1184
|
+
children?: ReactNode;
|
|
1185
|
+
/**
|
|
1186
|
+
* Component to use as skeleton for each option instead of the default one.
|
|
1187
|
+
* Can either be a react node or a component that receives the index as prop
|
|
1188
|
+
*/
|
|
1189
|
+
renderItemSkeleton?: ComboboxListSkeletonProps['children'];
|
|
1190
|
+
/** Label for the list */
|
|
1191
|
+
label?: string;
|
|
1192
|
+
/** Props of the popover element. */
|
|
1193
|
+
popoverProps?: Partial<PopoverProps>;
|
|
1194
|
+
/**
|
|
1195
|
+
* An element to display at the bottom of the listbox.
|
|
1196
|
+
* No interactive element must be set here as they will not be accessible.
|
|
1197
|
+
*/
|
|
1198
|
+
footer?: ReactNode;
|
|
1199
|
+
/** List ref */
|
|
1200
|
+
listRef?: React__default.Ref<HTMLElement>;
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* The listbox containing the combobox's options.
|
|
1204
|
+
*
|
|
1205
|
+
* @family Combobox
|
|
1206
|
+
* @param ComboboxListBoxProps
|
|
1207
|
+
* @returns ComboboxListBox
|
|
1208
|
+
*/
|
|
1209
|
+
declare const ComboboxListBox: ({ children, renderItemSkeleton, label, popoverProps, footer, listRef, ...forwardedProps }: ComboboxListBoxProps) => react_jsx_runtime.JSX.Element;
|
|
1210
|
+
|
|
1211
|
+
declare const LUMX_CLASSNAME = "lumx-list-item";
|
|
1212
|
+
/**
|
|
1213
|
+
* Props for ComboboxOption with additional generic properties.
|
|
1214
|
+
*/
|
|
1215
|
+
interface ComboboxOptionComponentProps<O extends object = any> extends GenericProps, Omit<ComboboxOptionProps<O>, 'as'> {
|
|
1216
|
+
/** Customize the root element. */
|
|
1217
|
+
as?: React__default.ElementType;
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* Option to set within a combobox list.
|
|
1221
|
+
*
|
|
1222
|
+
* @family Combobox
|
|
1223
|
+
* @param ComboboxOptionProps
|
|
1224
|
+
* @returns ComboboxOption
|
|
1225
|
+
*/
|
|
1226
|
+
declare const ComboboxOption: Comp<ComboboxOptionComponentProps<any>, HTMLElement>;
|
|
1227
|
+
|
|
1228
|
+
interface ComboboxOptionActionProps extends GenericProps {
|
|
1229
|
+
/** Should the action be set as disabled */
|
|
1230
|
+
isDisabled?: boolean;
|
|
1231
|
+
/** Action to trigger when the action is selected */
|
|
1232
|
+
onClick: () => void;
|
|
1233
|
+
/** Customize the root element. */
|
|
1234
|
+
as?: React__default.ElementType;
|
|
1235
|
+
}
|
|
1236
|
+
/**
|
|
1237
|
+
* Action to set on a Combobox Option.
|
|
1238
|
+
* Allows to add an interactive element that
|
|
1239
|
+
* can be navigated to and triggered using the keyboard.
|
|
1240
|
+
*
|
|
1241
|
+
* Defaults as "button"
|
|
1242
|
+
*
|
|
1243
|
+
* @family Combobox
|
|
1244
|
+
* @param ComboboxOptionActionProps
|
|
1245
|
+
* @returns ComboboxOptionAction
|
|
1246
|
+
*/
|
|
1247
|
+
declare const ComboboxOptionAction: (props: ComboboxOptionActionProps) => react_jsx_runtime.JSX.Element;
|
|
1248
|
+
|
|
1249
|
+
interface ComboboxOptionMoreInfoProps {
|
|
1250
|
+
buttonProps?: Partial<IconButtonProps>;
|
|
1251
|
+
popoverProps?: PopoverProps;
|
|
1252
|
+
onToggle?: (isOpen: boolean) => void;
|
|
1253
|
+
children?: React__default.ReactNode;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* Display more info on the option as a popover opening on mouse hover or keyboard nav
|
|
1257
|
+
* Please consider using a simpler option description instead for better UX and a11y.
|
|
1258
|
+
*
|
|
1259
|
+
* @family Combobox
|
|
1260
|
+
*/
|
|
1261
|
+
declare const ComboboxOptionMoreInfo: React__default.FC<ComboboxOptionMoreInfoProps>;
|
|
1262
|
+
|
|
1263
|
+
interface ComboboxSectionProps {
|
|
1264
|
+
/** Forwarded class name */
|
|
1265
|
+
className?: string;
|
|
1266
|
+
/** The title of the section */
|
|
1267
|
+
title?: string;
|
|
1268
|
+
/** Whether the section should be displayed as loading */
|
|
1269
|
+
isLoading?: boolean;
|
|
1270
|
+
/** Custom skeletons to use for loading state */
|
|
1271
|
+
renderItemSkeleton?: ComboboxListSkeletonProps['children'];
|
|
1272
|
+
/** Options to display */
|
|
1273
|
+
children: ReactNode;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Section for options of a Combobox.
|
|
1277
|
+
*
|
|
1278
|
+
* @family Combobox
|
|
1279
|
+
* @param ComboboxSectionProps
|
|
1280
|
+
* @returns ComboboxSection
|
|
1281
|
+
*/
|
|
1282
|
+
declare const ComboboxSection: ({ children, ...props }: ComboboxSectionProps) => react_jsx_runtime.JSX.Element;
|
|
1283
|
+
|
|
1284
|
+
declare const SUB_COMPONENTS: {
|
|
1285
|
+
/**
|
|
1286
|
+
* Option to set within a combobox list.
|
|
1287
|
+
*
|
|
1288
|
+
* @family Combobox
|
|
1289
|
+
* @param ComboboxOptionProps
|
|
1290
|
+
* @returns ComboboxOption
|
|
1291
|
+
*/
|
|
1292
|
+
readonly Option: Comp<ComboboxOptionComponentProps<any>, HTMLElement>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Skeleton for a combobox option.
|
|
1295
|
+
* A typography skeleton is rendered by default but can be overridden by passing children.
|
|
1296
|
+
*/
|
|
1297
|
+
readonly OptionSkeleton: ({ className, index, before, after, size, children, }: ComboboxOptionSkeletonProps) => react_jsx_runtime.JSX.Element;
|
|
1298
|
+
/**
|
|
1299
|
+
* Section for options of a Combobox.
|
|
1300
|
+
*
|
|
1301
|
+
* @family Combobox
|
|
1302
|
+
* @param ComboboxSectionProps
|
|
1303
|
+
* @returns ComboboxSection
|
|
1304
|
+
*/
|
|
1305
|
+
readonly Section: ({ children, ...props }: ComboboxSectionProps) => react_jsx_runtime.JSX.Element;
|
|
1306
|
+
/**
|
|
1307
|
+
* Combobox input trigger.
|
|
1308
|
+
*
|
|
1309
|
+
* @family Combobox
|
|
1310
|
+
*/
|
|
1311
|
+
readonly Input: ({ hideToggle, inputRef, textFieldRef, afterElement, onFocus, onBlur, onKeyDown, clearButtonProps, hasClearButton, theme, ...textFieldProps }: ComboboxInputProps) => react_jsx_runtime.JSX.Element;
|
|
1312
|
+
/**
|
|
1313
|
+
* The listbox containing the combobox's options.
|
|
1314
|
+
*
|
|
1315
|
+
* @family Combobox
|
|
1316
|
+
* @param ComboboxListBoxProps
|
|
1317
|
+
* @returns ComboboxListBox
|
|
1318
|
+
*/
|
|
1319
|
+
readonly List: ({ children, renderItemSkeleton, label, popoverProps, footer, listRef, ...forwardedProps }: ComboboxListBoxProps) => react_jsx_runtime.JSX.Element;
|
|
1320
|
+
/**
|
|
1321
|
+
* Combobox button trigger.
|
|
1322
|
+
*
|
|
1323
|
+
* @family Combobox
|
|
1324
|
+
*/
|
|
1325
|
+
readonly Button: Comp<ComboboxButtonProps, HTMLElement>;
|
|
1326
|
+
};
|
|
1327
|
+
/**
|
|
1328
|
+
*
|
|
1329
|
+
* A Combobox is a combination of two components:
|
|
1330
|
+
* * An input to enter the user's value
|
|
1331
|
+
* * A popover with a list of suggestions to fill the value.
|
|
1332
|
+
*
|
|
1333
|
+
* These two components are included via the Combobox.Input and Combobox.ListBox components.
|
|
1334
|
+
*
|
|
1335
|
+
* In its simplest implementation the component will automatically filter the given options
|
|
1336
|
+
* from the value of the input and fill the input with the textValue of the selected option.
|
|
1337
|
+
*
|
|
1338
|
+
* Props are available for more complex implementations.
|
|
1339
|
+
*
|
|
1340
|
+
* @family Combobox
|
|
1341
|
+
* @param ComboboxProps
|
|
1342
|
+
* @returns Combobox
|
|
1343
|
+
*/
|
|
1344
|
+
declare const Combobox: (<O>({ id: htmlId, inputValue, defaultInputValue, autoFilter, openOnClick, openOnFocus, status, showEmptyState, showErrorState, selectedIds, onInputChange, onSelect, onOpen, children, selectionType, translations, }: ComboboxProps<O>) => react_jsx_runtime.JSX.Element) & {
|
|
1345
|
+
/**
|
|
1346
|
+
* Option to set within a combobox list.
|
|
1347
|
+
*
|
|
1348
|
+
* @family Combobox
|
|
1349
|
+
* @param ComboboxOptionProps
|
|
1350
|
+
* @returns ComboboxOption
|
|
1351
|
+
*/
|
|
1352
|
+
readonly Option: Comp<ComboboxOptionComponentProps<any>, HTMLElement>;
|
|
1353
|
+
/**
|
|
1354
|
+
* Skeleton for a combobox option.
|
|
1355
|
+
* A typography skeleton is rendered by default but can be overridden by passing children.
|
|
1356
|
+
*/
|
|
1357
|
+
readonly OptionSkeleton: ({ className, index, before, after, size, children, }: ComboboxOptionSkeletonProps) => react_jsx_runtime.JSX.Element;
|
|
1358
|
+
/**
|
|
1359
|
+
* Section for options of a Combobox.
|
|
1360
|
+
*
|
|
1361
|
+
* @family Combobox
|
|
1362
|
+
* @param ComboboxSectionProps
|
|
1363
|
+
* @returns ComboboxSection
|
|
1364
|
+
*/
|
|
1365
|
+
readonly Section: ({ children, ...props }: ComboboxSectionProps) => react_jsx_runtime.JSX.Element;
|
|
1366
|
+
/**
|
|
1367
|
+
* Combobox input trigger.
|
|
1368
|
+
*
|
|
1369
|
+
* @family Combobox
|
|
1370
|
+
*/
|
|
1371
|
+
readonly Input: ({ hideToggle, inputRef, textFieldRef, afterElement, onFocus, onBlur, onKeyDown, clearButtonProps, hasClearButton, theme, ...textFieldProps }: ComboboxInputProps) => react_jsx_runtime.JSX.Element;
|
|
1372
|
+
/**
|
|
1373
|
+
* The listbox containing the combobox's options.
|
|
1374
|
+
*
|
|
1375
|
+
* @family Combobox
|
|
1376
|
+
* @param ComboboxListBoxProps
|
|
1377
|
+
* @returns ComboboxListBox
|
|
1378
|
+
*/
|
|
1379
|
+
readonly List: ({ children, renderItemSkeleton, label, popoverProps, footer, listRef, ...forwardedProps }: ComboboxListBoxProps) => react_jsx_runtime.JSX.Element;
|
|
1380
|
+
/**
|
|
1381
|
+
* Combobox button trigger.
|
|
1382
|
+
*
|
|
1383
|
+
* @family Combobox
|
|
1384
|
+
*/
|
|
1385
|
+
readonly Button: Comp<ComboboxButtonProps, HTMLElement>;
|
|
1386
|
+
};
|
|
1387
|
+
|
|
901
1388
|
/**
|
|
902
1389
|
* Comment block variants.
|
|
903
1390
|
*/
|
|
@@ -1658,22 +2145,37 @@ interface GridItemProps extends GenericProps {
|
|
|
1658
2145
|
*/
|
|
1659
2146
|
declare const GridItem: Comp<GridItemProps, HTMLDivElement>;
|
|
1660
2147
|
|
|
1661
|
-
type GridColumnGapSize = Extract<Size
|
|
2148
|
+
type GridColumnGapSize = Extract<Size, 'tiny' | 'regular' | 'big' | 'huge'>;
|
|
1662
2149
|
/**
|
|
1663
2150
|
* Defines the props of the component.
|
|
1664
2151
|
*/
|
|
1665
|
-
interface GridColumnProps extends
|
|
2152
|
+
interface GridColumnProps$1 extends HasClassName {
|
|
1666
2153
|
/** Customize the root element. */
|
|
1667
|
-
as?:
|
|
2154
|
+
as?: any;
|
|
1668
2155
|
/** Children elements. */
|
|
1669
|
-
children?:
|
|
2156
|
+
children?: JSXElement;
|
|
1670
2157
|
/** Space between columns and rows. */
|
|
1671
2158
|
gap?: GridColumnGapSize;
|
|
1672
2159
|
/** Ideal number of columns. */
|
|
1673
2160
|
maxColumns?: number;
|
|
1674
2161
|
/** Minimum width for each item, reduce the number of column if there is not enough space. */
|
|
1675
2162
|
itemMinWidth?: number;
|
|
2163
|
+
/** Custom styles. */
|
|
2164
|
+
style?: any;
|
|
2165
|
+
/** reference to the root element */
|
|
2166
|
+
ref?: CommonRef;
|
|
1676
2167
|
}
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
* Defines the props of the component.
|
|
2171
|
+
*/
|
|
2172
|
+
interface GridColumnProps extends GenericProps, GridColumnProps$1 {
|
|
2173
|
+
/** Customize the root element. */
|
|
2174
|
+
as?: React.ElementType;
|
|
2175
|
+
/** Children elements. */
|
|
2176
|
+
children?: React.ReactNode;
|
|
2177
|
+
}
|
|
2178
|
+
|
|
1677
2179
|
/**
|
|
1678
2180
|
* The GridColumn is a layout component that can display children in a grid
|
|
1679
2181
|
* with custom display properties. It also comes with a responsive design,
|
|
@@ -2161,7 +2663,7 @@ interface LinkProps extends GenericProps, Omit<LinkProps$1, 'label'> {
|
|
|
2161
2663
|
* @param ref Component ref.
|
|
2162
2664
|
* @return React element.
|
|
2163
2665
|
*/
|
|
2164
|
-
declare const Link: Comp<LinkProps,
|
|
2666
|
+
declare const Link: Comp<LinkProps, HTMLButtonElement | HTMLAnchorElement>;
|
|
2165
2667
|
|
|
2166
2668
|
/**
|
|
2167
2669
|
* Defines the props of the component.
|
|
@@ -3769,5 +4271,5 @@ declare const ThemeProvider: React__default.FC<{
|
|
|
3769
4271
|
/** Get the theme in the current context. */
|
|
3770
4272
|
declare function useTheme(): ThemeContextValue;
|
|
3771
4273
|
|
|
3772
|
-
export { AlertDialog, Autocomplete, AutocompleteMultiple, Avatar, Badge, BadgeWrapper, Button, ButtonEmphasis, ButtonGroup,
|
|
3773
|
-
export type { AlertDialogProps, AutocompleteMultipleProps, AutocompleteProps, AvatarProps, AvatarSize, BadgeProps, BadgeWrapperProps, BaseButtonProps, ButtonGroupProps, ButtonProps, ButtonSize, CheckboxProps, ChipGroupProps, ChipProps, CommentBlockProps, DatePickerControlledProps, DatePickerFieldProps, DatePickerProps, DialogProps, DialogSizes, DividerProps, DragHandleProps, DropdownProps, Elevation, ExpansionPanelProps, FlagProps, FlexBoxProps, FlexHorizontalAlignment, FlexVerticalAlignment, FocusPoint, GapSize, GenericBlockProps, GridColumnGapSize, GridColumnProps, GridItemProps, GridProps, HeadingLevelProviderProps, HeadingProps, IconButtonProps, IconProps, IconSizes, ImageBlockProps, ImageBlockSize, ImageLightboxProps, InlineListProps, InputHelperProps, InputLabelProps, LightboxProps, LinkPreviewProps, LinkProps, ListDividerProps, ListItemProps, ListItemSize, ListProps, ListSubheaderProps, MarginAutoAlignment, MessageProps, MosaicProps, NavigationProps, NotificationProps, Offset, PopoverDialogProps, PopoverProps, PostBlockProps, ProgressCircularProps, ProgressCircularSize, ProgressLinearProps, ProgressProps, ProgressTrackerProps, ProgressTrackerProviderProps, ProgressTrackerStepPanelProps, ProgressTrackerStepProps, RadioButtonProps, RadioGroupProps, RawInputTextProps, RawInputTextareaProps, SelectMultipleProps, SelectProps, SelectionChipGroupProps, SideNavigationItemProps, SideNavigationProps, SkeletonCircleProps, SkeletonRectangleProps, SkeletonTypographyProps, SliderProps, SlidesProps, SlideshowControlsProps, SlideshowItemProps, SlideshowProps, SwitchProps, TabListProps, TabPanelProps, TabProps, TabProviderProps, TableBodyProps, TableCellProps, TableHeaderProps, TableProps, TableRowProps, TextFieldProps, TextProps, ThumbnailProps, ThumbnailSize, ToolbarProps, TooltipPlacement, TooltipProps, UploaderProps, UploaderSize, UserBlockProps, UserBlockSize };
|
|
4274
|
+
export { AlertDialog, Autocomplete, AutocompleteMultiple, Avatar, Badge, BadgeWrapper, Button, ButtonEmphasis, ButtonGroup, COMPONENT_NAME, Checkbox, Chip, ChipGroup, Combobox, ComboboxButton, ComboboxDivider, ComboboxInput, ComboboxListBox, ComboboxOption, ComboboxOptionAction, ComboboxOptionMoreInfo, ComboboxOptionSkeleton, ComboboxSection, CommentBlock, CommentBlockVariant, DEFAULT_PROPS, DatePicker, DatePickerControlled, DatePickerField, Dialog, Divider, DragHandle, Dropdown, ExpansionPanel, Flag, FlexBox, GenericBlock, GenericBlockGapSize, Grid, GridColumn, GridItem, Heading, HeadingLevelProvider, Icon, IconButton, ImageBlock, ImageBlockCaptionPosition, ImageLightbox, InlineList, InputHelper, InputLabel, LUMX_CLASSNAME, Lightbox, Link, LinkPreview, List, ListDivider, ListItem, ListSubheader, Message, Mosaic, Navigation, Notification, Placement, Popover, PopoverDialog, PostBlock, Progress, ProgressCircular, ProgressLinear, ProgressTracker, ProgressTrackerProvider, ProgressTrackerStep, ProgressTrackerStepPanel, ProgressVariant, RadioButton, RadioGroup, RawInputText, RawInputTextarea, SUB_COMPONENTS, Select, SelectMultiple, SelectMultipleField, SelectVariant, SelectionChipGroup, SideNavigation, SideNavigationItem, SkeletonCircle, SkeletonRectangle, SkeletonRectangleVariant, SkeletonTypography, Slider, Slides, Slideshow, SlideshowControls, SlideshowItem, Switch, Tab, TabList, TabListLayout, TabPanel, TabProvider, Table, TableBody, TableCell, TableCellVariant, TableCellVariant as TableCellVariantType, TableHeader, TableRow, Text, TextField, ThOrder, ThOrder as ThOrderType, ThemeProvider, Thumbnail, ThumbnailAspectRatio, ThumbnailObjectFit, ThumbnailVariant, Toolbar, Tooltip, Uploader, UploaderVariant, UserBlock, clamp, isClickable, useFocusPointStyle, useHeadingLevel, useTheme };
|
|
4275
|
+
export type { AlertDialogProps, AutocompleteMultipleProps, AutocompleteProps, AvatarProps, AvatarSize, BadgeProps, BadgeWrapperProps, BaseButtonProps, ButtonGroupProps, ButtonProps, ButtonSize, CheckboxProps, ChipGroupProps, ChipProps, ComboboxButtonProps, ComboboxInputProps, ComboboxListBoxProps, ComboboxOptionComponentProps, ComboboxOptionMoreInfoProps, ComboboxOptionSkeletonProps, ComboboxSectionProps, CommentBlockProps, DatePickerControlledProps, DatePickerFieldProps, DatePickerProps, DialogProps, DialogSizes, DividerProps, DragHandleProps, DropdownProps, Elevation, ExpansionPanelProps, FlagProps, FlexBoxProps, FlexHorizontalAlignment, FlexVerticalAlignment, FocusPoint, GapSize, GenericBlockProps, GridColumnGapSize, GridColumnProps, GridItemProps, GridProps, HeadingLevelProviderProps, HeadingProps, IconButtonProps, IconProps, IconSizes, ImageBlockProps, ImageBlockSize, ImageLightboxProps, InlineListProps, InputHelperProps, InputLabelProps, LightboxProps, LinkPreviewProps, LinkProps, ListDividerProps, ListItemProps, ListItemSize, ListProps, ListSubheaderProps, MarginAutoAlignment, MessageProps, MosaicProps, NavigationProps, NotificationProps, Offset, PopoverDialogProps, PopoverProps, PostBlockProps, ProgressCircularProps, ProgressCircularSize, ProgressLinearProps, ProgressProps, ProgressTrackerProps, ProgressTrackerProviderProps, ProgressTrackerStepPanelProps, ProgressTrackerStepProps, RadioButtonProps, RadioGroupProps, RawInputTextProps, RawInputTextareaProps, SelectMultipleProps, SelectProps, SelectionChipGroupProps, SideNavigationItemProps, SideNavigationProps, SkeletonCircleProps, SkeletonRectangleProps, SkeletonTypographyProps, SliderProps, SlidesProps, SlideshowControlsProps, SlideshowItemProps, SlideshowProps, SwitchProps, TabListProps, TabPanelProps, TabProps, TabProviderProps, TableBodyProps, TableCellProps, TableHeaderProps, TableProps, TableRowProps, TextFieldProps, TextProps, ThumbnailProps, ThumbnailSize, ToolbarProps, TooltipPlacement, TooltipProps, UploaderProps, UploaderSize, UserBlockProps, UserBlockSize };
|