@uniformdev/mesh-sdk-react 19.178.2-alpha.25 → 19.179.2-alpha.22
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/dist/index.d.mts +195 -123
- package/dist/index.d.ts +195 -123
- package/dist/index.esm.js +570 -367
- package/dist/index.js +660 -461
- package/dist/index.mjs +570 -367
- package/package.json +9 -10
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime';
|
|
2
2
|
import * as React$1 from 'react';
|
|
3
3
|
import React__default, { SVGProps, ReactNode, MutableRefObject, ComponentType, PropsWithChildren, HTMLAttributes, AnchorHTMLAttributes } from 'react';
|
|
4
4
|
import { TDate } from 'timeago.js';
|
|
@@ -7,39 +7,39 @@ import { Interpolation, Theme, SerializedStyles } from '@emotion/react';
|
|
|
7
7
|
import * as _uniformdev_mesh_sdk from '@uniformdev/mesh-sdk';
|
|
8
8
|
import { DynamicInputs, MeshLocation, SetValueOptions, EditConnectedDataResponseCancellationContext, DataSourceLocationValue, DataTypeLocationValue, BindableTypes } from '@uniformdev/mesh-sdk';
|
|
9
9
|
export * from '@uniformdev/mesh-sdk';
|
|
10
|
-
import { DataVariableDefinition, DataResourceVariables, DataType } from '@uniformdev/canvas';
|
|
10
|
+
import { DataVariableDefinition, DataResourceVariables, DataType, DataSourceVariantsKeys } from '@uniformdev/canvas';
|
|
11
11
|
import { Emitter } from 'mitt';
|
|
12
12
|
import { BadgeThemeProps, InputSelectProps, IconType } from '@uniformdev/design-system';
|
|
13
13
|
export { AddListButton, AddListButtonProps, Button, ButtonProps, Callout, CalloutProps, DrawerContent, Heading, HeadingProps, Input, InputComboBox, InputComboBoxProps, InputKeywordSearch, InputProps, InputSelect, InputToggle, InputToggleProps, Label, LabelProps, LoadingIndicator, LoadingOverlay, Menu, MenuItem, MenuItemProps, MenuProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, useParameterShell, utilityColors } from '@uniformdev/design-system';
|
|
14
14
|
import * as lexical from 'lexical';
|
|
15
|
-
import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState } from 'lexical';
|
|
15
|
+
import { SerializedEditorState, SerializedLexicalNode, Spread, DecoratorNode, NodeKey, LexicalNode, LexicalEditor, EditorState, SerializedRootNode } from 'lexical';
|
|
16
16
|
import { MenuOption } from '@lexical/react/LexicalTypeaheadMenuPlugin';
|
|
17
17
|
|
|
18
|
-
declare const SvgCaution: (props: SVGProps<SVGSVGElement>) =>
|
|
18
|
+
declare const SvgCaution: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
19
19
|
|
|
20
|
-
declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) =>
|
|
20
|
+
declare const SvgCheckmark: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
21
21
|
|
|
22
|
-
declare const SvgChevronDown: (props: SVGProps<SVGSVGElement>) =>
|
|
22
|
+
declare const SvgChevronDown: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
23
23
|
|
|
24
|
-
declare const SvgClose: (props: SVGProps<SVGSVGElement>) =>
|
|
24
|
+
declare const SvgClose: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
25
25
|
|
|
26
|
-
declare const SvgDanger: (props: SVGProps<SVGSVGElement>) =>
|
|
26
|
+
declare const SvgDanger: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
27
27
|
|
|
28
|
-
declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) =>
|
|
28
|
+
declare const SvgExclamationPoint: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
29
29
|
|
|
30
|
-
declare const SvgInfo: (props: SVGProps<SVGSVGElement>) =>
|
|
30
|
+
declare const SvgInfo: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
31
31
|
|
|
32
|
-
declare const SvgLightbulb: (props: SVGProps<SVGSVGElement>) =>
|
|
32
|
+
declare const SvgLightbulb: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
33
33
|
|
|
34
|
-
declare const SvgMagnifyingGlass: (props: SVGProps<SVGSVGElement>) =>
|
|
34
|
+
declare const SvgMagnifyingGlass: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
35
35
|
|
|
36
|
-
declare const SvgMaximizeAlt: (props: SVGProps<SVGSVGElement>) =>
|
|
36
|
+
declare const SvgMaximizeAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
37
37
|
|
|
38
|
-
declare const SvgMinus: (props: SVGProps<SVGSVGElement>) =>
|
|
38
|
+
declare const SvgMinus: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
39
39
|
|
|
40
|
-
declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) =>
|
|
40
|
+
declare const SvgMoreVerticalAlt: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
41
41
|
|
|
42
|
-
declare const SvgPlus: (props: SVGProps<SVGSVGElement>) =>
|
|
42
|
+
declare const SvgPlus: (props: SVGProps<SVGSVGElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
43
43
|
|
|
44
44
|
declare namespace index {
|
|
45
45
|
export { SvgCaution as Caution, SvgCheckmark as Checkmark, SvgChevronDown as ChevronDown, SvgClose as Close, SvgDanger as Danger, SvgExclamationPoint as ExclamationPoint, SvgInfo as Info, SvgLightbulb as Lightbulb, SvgMagnifyingGlass as MagnifyingGlass, SvgMaximizeAlt as MaximizeAlt, SvgMinus as Minus, SvgMoreVerticalAlt as MoreVerticalAlt, SvgPlus as Plus };
|
|
@@ -118,7 +118,7 @@ interface NoResultsProps {
|
|
|
118
118
|
selectedContentType: string | undefined;
|
|
119
119
|
}
|
|
120
120
|
/** @deprecated in favour of ObjectSearchContainer, see https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-container-with-inputs for implementation details */
|
|
121
|
-
declare const EntrySearch: <TResult extends EntrySearchResult>({ search, results, contentTypes, selectedItems, logoIcon, select, multiSelect, multiSelectId, rowComponent, selectedItemComponent, totalResults, cursor, resultsLoading, requireContentType, onAddNew, onEditClosed, onCancel, noResultsComponent, helpComponent, onSort, typeSelectorLabel, typeSelectorAllTypesOptionText, loadingIndicatorDelay, }: EntrySearchProps<TResult>) =>
|
|
121
|
+
declare const EntrySearch: <TResult extends EntrySearchResult>({ search, results, contentTypes, selectedItems, logoIcon, select, multiSelect, multiSelectId, rowComponent, selectedItemComponent, totalResults, cursor, resultsLoading, requireContentType, onAddNew, onEditClosed, onCancel, noResultsComponent, helpComponent, onSort, typeSelectorLabel, typeSelectorAllTypesOptionText, loadingIndicatorDelay, }: EntrySearchProps<TResult>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
122
122
|
|
|
123
123
|
/** @deprecated please use ObjectSearchResultItem - https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-result-item */
|
|
124
124
|
interface EntrySearchRowProps<TResult extends EntrySearchResult = EntrySearchResult> {
|
|
@@ -196,8 +196,8 @@ interface ProductCategory {
|
|
|
196
196
|
|
|
197
197
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
198
198
|
declare const ProductPreviewList: ({ products, }: {
|
|
199
|
-
products: ProductSearchResults[
|
|
200
|
-
}) =>
|
|
199
|
+
products: ProductSearchResults["products"] | undefined;
|
|
200
|
+
}) => _emotion_react_jsx_runtime.JSX.Element;
|
|
201
201
|
|
|
202
202
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
203
203
|
interface ProductDynamicSelectorValue {
|
|
@@ -246,7 +246,7 @@ interface Brand {
|
|
|
246
246
|
name: string;
|
|
247
247
|
}
|
|
248
248
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
249
|
-
declare const ProductQuery: ({ value, setValue, brands, categories, loading, categoriesLoading, brandsLoading, logoIcon, onGetProducts, sortOptions, sortOrderOptions, categoryLabel, brandLabel, disableBrands, restrictToSingleCategory, }: ProductQueryProps) =>
|
|
249
|
+
declare const ProductQuery: ({ value, setValue, brands, categories, loading, categoriesLoading, brandsLoading, logoIcon, onGetProducts, sortOptions, sortOrderOptions, categoryLabel, brandLabel, disableBrands, restrictToSingleCategory, }: ProductQueryProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
250
250
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
251
251
|
interface ProductQueryContextValue {
|
|
252
252
|
categories: ProductQueryProps['categories'];
|
|
@@ -282,7 +282,7 @@ interface GetProductOptions {
|
|
|
282
282
|
cursor?: string;
|
|
283
283
|
}
|
|
284
284
|
/** @deprecated in favour of ObjectSearchContainer, see https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs for implementation details */
|
|
285
|
-
declare function ProductSearch({ selectedProducts, setSelectedProducts, onGetCategories, onSearchProducts, logoIcon, multiSelect, multiSelectId, selectedItemComponent, rowComponent, errorComponent, helpComponent, noResultsComponent, onSort, typeSelectorAllTypesOptionText, typeSelectorLabel, }: ProductSearchProps):
|
|
285
|
+
declare function ProductSearch({ selectedProducts, setSelectedProducts, onGetCategories, onSearchProducts, logoIcon, multiSelect, multiSelectId, selectedItemComponent, rowComponent, errorComponent, helpComponent, noResultsComponent, onSort, typeSelectorAllTypesOptionText, typeSelectorLabel, }: ProductSearchProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
286
286
|
interface ProductSearchContextValue {
|
|
287
287
|
logoIcon: ProductSearchProps['logoIcon'];
|
|
288
288
|
categories: ProductCategory[] | undefined;
|
|
@@ -291,17 +291,17 @@ declare const ProductSearchContext: React__default.Context<ProductSearchContextV
|
|
|
291
291
|
declare const useProductSearchContext: () => ProductSearchContextValue;
|
|
292
292
|
|
|
293
293
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
294
|
-
declare function ProductSearchRow({ result, isSelected, triggerSelection, }: EntrySearchRowProps<ProductSearchResult>):
|
|
294
|
+
declare function ProductSearchRow({ result, isSelected, triggerSelection, }: EntrySearchRowProps<ProductSearchResult>): _emotion_react_jsx_runtime.JSX.Element;
|
|
295
295
|
|
|
296
296
|
/** @deprecated please use ObjectSearchResultItem - https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-result-item*/
|
|
297
|
-
declare function ProductSelectedItem({ selectedItem, onDeselect, }: EntrySearchSelectedItemProps<ProductSearchResult>):
|
|
297
|
+
declare function ProductSelectedItem({ selectedItem, onDeselect, }: EntrySearchSelectedItemProps<ProductSearchResult>): _emotion_react_jsx_runtime.JSX.Element;
|
|
298
298
|
|
|
299
299
|
/** @deprecated please use DataRefreshButtonProps - https://mesh-design-system.netlify.app/?path=/story/object-search--data-refresh-button */
|
|
300
300
|
declare const ResolvableLoadingValue: ({ value, text, loading, }: {
|
|
301
301
|
value: string;
|
|
302
302
|
text: string | undefined;
|
|
303
303
|
loading: boolean;
|
|
304
|
-
}) =>
|
|
304
|
+
}) => _emotion_react_jsx_runtime.JSX.Element;
|
|
305
305
|
|
|
306
306
|
/** @deprecated please use ObjectSearchContainer - https://mesh-design-system.netlify.app/?path=/story/object-search--query-filter-with-inputs*/
|
|
307
307
|
type SelectionFieldValue = {
|
|
@@ -317,7 +317,7 @@ declare const SelectionField: ({ id, label, loading, selectedValues, values, onA
|
|
|
317
317
|
values: SelectionFieldValue[];
|
|
318
318
|
onAdd: (id: string) => void;
|
|
319
319
|
onRemove: (id: string) => void;
|
|
320
|
-
}) =>
|
|
320
|
+
}) => _emotion_react_jsx_runtime.JSX.Element;
|
|
321
321
|
|
|
322
322
|
declare const productSearchRowContainer: _emotion_react.SerializedStyles;
|
|
323
323
|
declare const productSearchRowContent: _emotion_react.SerializedStyles;
|
|
@@ -368,7 +368,7 @@ interface DamSelectedItemProps<TResult extends DamItem = DamItem> {
|
|
|
368
368
|
}>;
|
|
369
369
|
}
|
|
370
370
|
/** @deprecated please use ObjectSearchResultItem - https://mesh-design-system.netlify.app/?path=/story/object-search--object-search-result-item */
|
|
371
|
-
declare function DamSelectedItem({ selectedItem, onDeselect, onEditClosed, logoIcon, itemDetailsRendererComponent, }: DamSelectedItemProps):
|
|
371
|
+
declare function DamSelectedItem({ selectedItem, onDeselect, onEditClosed, logoIcon, itemDetailsRendererComponent, }: DamSelectedItemProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
372
372
|
|
|
373
373
|
declare const damSelectedItemContainer: _emotion_react.SerializedStyles;
|
|
374
374
|
declare const damSelectedItemInner: _emotion_react.SerializedStyles;
|
|
@@ -396,7 +396,7 @@ type DataResourceDynamicInputProviderProps = {
|
|
|
396
396
|
* using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
|
|
397
397
|
* where a data resource variable could be a static value or bound to a dynamic input from the route (project map).
|
|
398
398
|
*/
|
|
399
|
-
declare function DataResourceDynamicInputProvider(props: DataResourceDynamicInputProviderProps):
|
|
399
|
+
declare function DataResourceDynamicInputProvider(props: DataResourceDynamicInputProviderProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
400
400
|
|
|
401
401
|
/**
|
|
402
402
|
* Provides convenient access to the current Uniform Mesh location via React hook.
|
|
@@ -570,7 +570,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
|
|
|
570
570
|
* NOTE: this is effectively an island of React, and you may not call hooks,
|
|
571
571
|
* rely on Context, etc in this renderer.
|
|
572
572
|
*/
|
|
573
|
-
decorate():
|
|
573
|
+
decorate(): _emotion_react_jsx_runtime.JSX.Element;
|
|
574
574
|
}
|
|
575
575
|
declare function $createVariableNode(variableReference: string, state: VariableNodeState): VariableNode;
|
|
576
576
|
declare function $isVariableNode(node: LexicalNode | null | undefined): node is VariableNode;
|
|
@@ -584,7 +584,7 @@ declare function VariableChip({ displayName, referenceIsValid, tooltip, referenc
|
|
|
584
584
|
selected: boolean;
|
|
585
585
|
disabled?: boolean;
|
|
586
586
|
errorMessage?: string;
|
|
587
|
-
}):
|
|
587
|
+
}): _emotion_react_jsx_runtime.JSX.Element;
|
|
588
588
|
|
|
589
589
|
type MeshDataVariableDefinition = Omit<DataVariableDefinition, 'default'> & {
|
|
590
590
|
/** When used in code, variables may have non-string defaults */
|
|
@@ -645,7 +645,7 @@ type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext
|
|
|
645
645
|
disableAutoFocusOnMount?: boolean;
|
|
646
646
|
showDisplayName?: boolean;
|
|
647
647
|
};
|
|
648
|
-
declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>):
|
|
648
|
+
declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
649
649
|
|
|
650
650
|
type SelectVariableMenuProps<TEditorContext = undefined> = {
|
|
651
651
|
/** sets the onClick menu item event. Also called if the menu adds a variable with the newly added variable. */
|
|
@@ -876,12 +876,17 @@ type InputVariablesProps<TEditorContext = unknown> = {
|
|
|
876
876
|
styleVariant?: 'default' | 'compact';
|
|
877
877
|
/** Set the menu dropdown to render in a portal, this helps fix z-indexing issue */
|
|
878
878
|
renderMenuInPortal?: boolean;
|
|
879
|
+
/**
|
|
880
|
+
* Reconfigures the editor to have a single dynamic token value, not allow static text, and replace
|
|
881
|
+
* any existing value on insert a new dynamic token.
|
|
882
|
+
*/
|
|
883
|
+
singleTokenMode?: boolean;
|
|
879
884
|
} & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
|
|
880
885
|
/**
|
|
881
886
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
882
887
|
* into its value.
|
|
883
888
|
*/
|
|
884
|
-
declare function InputVariables<TEditorContext = unknown>(props: InputVariablesProps<TEditorContext>):
|
|
889
|
+
declare function InputVariables<TEditorContext = unknown>(props: InputVariablesProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
885
890
|
|
|
886
891
|
type ParameterConnectionIndicatorProps = {
|
|
887
892
|
/** Disables the menu, hiding it from view entirely */
|
|
@@ -908,7 +913,7 @@ type ParameterConnectionIndicatorProps = {
|
|
|
908
913
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
909
914
|
* into its value. Designed specifically for use in the Canvas Parameter Editor.
|
|
910
915
|
*/
|
|
911
|
-
declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, overrideMenuButtonParentMargin, renderMenuInPortal, }: ParameterConnectionIndicatorProps):
|
|
916
|
+
declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, overrideMenuButtonParentMargin, renderMenuInPortal, }: ParameterConnectionIndicatorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
912
917
|
|
|
913
918
|
type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
|
|
914
919
|
disabled?: boolean;
|
|
@@ -928,7 +933,7 @@ type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
|
|
|
928
933
|
* possibly because they bind to objects or arrays.
|
|
929
934
|
* Designed visually for use in the Canvas Parameter Editor.
|
|
930
935
|
*/
|
|
931
|
-
declare function ParameterOrSingleVariable<TEditorContext = unknown>(props: ParameterOrSingleVariableProps<TEditorContext>):
|
|
936
|
+
declare function ParameterOrSingleVariable<TEditorContext = unknown>(props: ParameterOrSingleVariableProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
932
937
|
|
|
933
938
|
type ParameterVariablesProps<TEditorContext = unknown> = {
|
|
934
939
|
/** sets the input aria-label value. */
|
|
@@ -958,7 +963,7 @@ type ParameterVariablesProps<TEditorContext = unknown> = {
|
|
|
958
963
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
959
964
|
* into its value. Designed visually for use in the Canvas Parameter Editor.
|
|
960
965
|
*/
|
|
961
|
-
declare function ParameterVariables<TEditorContext = unknown>(props: ParameterVariablesProps<TEditorContext>):
|
|
966
|
+
declare function ParameterVariables<TEditorContext = unknown>(props: ParameterVariablesProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
962
967
|
|
|
963
968
|
type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = React.PropsWithChildren<{
|
|
964
969
|
/**
|
|
@@ -1085,7 +1090,7 @@ type VariablesContext<TEditVariableContext, TEditVariableCompletedContext, TEdit
|
|
|
1085
1090
|
*/
|
|
1086
1091
|
isLoading: boolean;
|
|
1087
1092
|
};
|
|
1088
|
-
declare function VariablesProvider<TEditComponentContext = never, TEditVariableCompletedContext = never, TEditVariableCancelledContext = never>({ value, onChange, editVariableComponent, readOnly, isLoading, children, knownUndefinedValues, onChangeKnownUndefinedValue, }: VariablesProviderProps<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>):
|
|
1093
|
+
declare function VariablesProvider<TEditComponentContext = never, TEditVariableCompletedContext = never, TEditVariableCancelledContext = never>({ value, onChange, editVariableComponent, readOnly, isLoading, children, knownUndefinedValues, onChangeKnownUndefinedValue, }: VariablesProviderProps<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1089
1094
|
declare function useVariables<TEditComponentContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(returnEmptyWithoutProvider?: boolean): VariablesContext<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>;
|
|
1090
1095
|
|
|
1091
1096
|
declare function useVariableEditor<TEditorContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(): {
|
|
@@ -1097,6 +1102,7 @@ declare function convertConnectedDataToVariable(bindExpression: string, value: u
|
|
|
1097
1102
|
|
|
1098
1103
|
/**
|
|
1099
1104
|
* Returns true if the string expression has variable references in it
|
|
1105
|
+
* @deprecated use the same named function from @uniformdev/canvas instead
|
|
1100
1106
|
*/
|
|
1101
1107
|
declare function hasReferencedVariables(value: string): boolean;
|
|
1102
1108
|
|
|
@@ -1107,6 +1113,7 @@ declare function prettifyBindExpression(bindExpression: string): string;
|
|
|
1107
1113
|
* Note: if no content is in the editor state, undefined will be returned.
|
|
1108
1114
|
*/
|
|
1109
1115
|
declare function serializeVariablesEditorState(editorState: EditorState): string | undefined;
|
|
1116
|
+
declare function serializeVariablesEditorSerializedState(serializedEditorState: SerializedRootNode<SerializedLexicalNode>): string | undefined;
|
|
1110
1117
|
|
|
1111
1118
|
/**
|
|
1112
1119
|
* Programmatically sets the current value of a variables editor after it has already initialized
|
|
@@ -1132,7 +1139,7 @@ declare const variablePrefix = "${";
|
|
|
1132
1139
|
*/
|
|
1133
1140
|
declare const variableSuffix = "}";
|
|
1134
1141
|
|
|
1135
|
-
declare function VariablesList():
|
|
1142
|
+
declare function VariablesList(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1136
1143
|
|
|
1137
1144
|
type DataResourceVariablesListProps = {
|
|
1138
1145
|
/**
|
|
@@ -1158,7 +1165,7 @@ type DataResourceVariablesListProps = {
|
|
|
1158
1165
|
* Using the optional `type` attribute of variables, one can use custom components to render different
|
|
1159
1166
|
* variables using this component, enabling flexibility for more than just text inputs.
|
|
1160
1167
|
*/
|
|
1161
|
-
declare function DataResourceVariablesList(props: DataResourceVariablesListProps):
|
|
1168
|
+
declare function DataResourceVariablesList(props: DataResourceVariablesListProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1162
1169
|
/**
|
|
1163
1170
|
* Renders a list of Data Type-provided variables that can be set on a Data Resource.
|
|
1164
1171
|
*
|
|
@@ -1169,7 +1176,7 @@ declare function DataResourceVariablesListExplicit({ setVariables, noVariables:
|
|
|
1169
1176
|
value: DataResourceVariables;
|
|
1170
1177
|
dataType: DataType;
|
|
1171
1178
|
dynamicInputs: DynamicInputs;
|
|
1172
|
-
}):
|
|
1179
|
+
}): _emotion_react_jsx_runtime.JSX.Element;
|
|
1173
1180
|
type DataResourceVariableRendererProps = {
|
|
1174
1181
|
/** Current value of the variable on the data resource */
|
|
1175
1182
|
value: string | undefined;
|
|
@@ -1179,7 +1186,7 @@ type DataResourceVariableRendererProps = {
|
|
|
1179
1186
|
definition: DataVariableDefinitionWithName;
|
|
1180
1187
|
};
|
|
1181
1188
|
/** Default data resource variable renderer, uses a text input that supports dynamic input binding */
|
|
1182
|
-
declare function TextVariableRenderer({ definition, value, setValue }: DataResourceVariableRendererProps):
|
|
1189
|
+
declare function TextVariableRenderer({ definition, value, setValue }: DataResourceVariableRendererProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1183
1190
|
|
|
1184
1191
|
type DataSourceEditorProps = PropsWithChildren<{
|
|
1185
1192
|
/**
|
|
@@ -1193,7 +1200,7 @@ type DataSourceEditorProps = PropsWithChildren<{
|
|
|
1193
1200
|
* Wrapper for editing a data source using Uniform Mesh SDK components that rely on `useRequest()`
|
|
1194
1201
|
* or `useVariables()`, or custom components that use the same hooks.
|
|
1195
1202
|
*/
|
|
1196
|
-
declare function DataSourceEditor({ onChange, children, editVariableComponent }: DataSourceEditorProps):
|
|
1203
|
+
declare function DataSourceEditor({ onChange, children, editVariableComponent }: DataSourceEditorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1197
1204
|
|
|
1198
1205
|
type DataTypeEditorProps = PropsWithChildren<{
|
|
1199
1206
|
/**
|
|
@@ -1207,7 +1214,7 @@ type DataTypeEditorProps = PropsWithChildren<{
|
|
|
1207
1214
|
* Wrapper for editing a data type using Uniform Mesh SDK components that rely on `useRequest()`
|
|
1208
1215
|
* or `useVariables()`, or custom components that use the same hooks.
|
|
1209
1216
|
*/
|
|
1210
|
-
declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps):
|
|
1217
|
+
declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1211
1218
|
|
|
1212
1219
|
type MeshAppProps = {
|
|
1213
1220
|
loadingComponent?: React__default.ComponentType;
|
|
@@ -1228,7 +1235,7 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
|
|
|
1228
1235
|
/**
|
|
1229
1236
|
* @description The data refresh button is a UI component to indicate to users a request for data is taking place
|
|
1230
1237
|
* @example <DataRefreshButton buttonText="my button" isLoading /> */
|
|
1231
|
-
declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) =>
|
|
1238
|
+
declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1232
1239
|
|
|
1233
1240
|
type ObjectSearchContainerProps = {
|
|
1234
1241
|
/**
|
|
@@ -1255,7 +1262,7 @@ type ObjectSearchContainerProps = {
|
|
|
1255
1262
|
/**
|
|
1256
1263
|
* @description Object search container is an opinionated layout for search parameters and retrieved results
|
|
1257
1264
|
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
|
|
1258
|
-
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) =>
|
|
1265
|
+
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1259
1266
|
|
|
1260
1267
|
type ObjectSearchFilterProps = {
|
|
1261
1268
|
/** shows or hides the required content type select option */
|
|
@@ -1288,7 +1295,7 @@ type ObjectSearchFilterProps = {
|
|
|
1288
1295
|
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1289
1296
|
* that can be extended with custom functions
|
|
1290
1297
|
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
|
|
1291
|
-
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) =>
|
|
1298
|
+
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1292
1299
|
|
|
1293
1300
|
type ObjectSearchFilterContainerProps = {
|
|
1294
1301
|
/**
|
|
@@ -1303,7 +1310,7 @@ type ObjectSearchFilterContainerProps = {
|
|
|
1303
1310
|
* @description an opinionated layout for search filters
|
|
1304
1311
|
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1305
1312
|
*/
|
|
1306
|
-
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) =>
|
|
1313
|
+
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1307
1314
|
|
|
1308
1315
|
type SearchQueryProps<TExtraFilters = unknown> = {
|
|
1309
1316
|
/** sets the content type in the search context */
|
|
@@ -1391,7 +1398,7 @@ type ObjectSearchProviderProps = {
|
|
|
1391
1398
|
isMulti?: boolean;
|
|
1392
1399
|
defaultQuery?: SearchQueryProps;
|
|
1393
1400
|
};
|
|
1394
|
-
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) =>
|
|
1401
|
+
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1395
1402
|
declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
|
|
1396
1403
|
|
|
1397
1404
|
type ObjectSearchListItemProps = SelectedItemProps & {
|
|
@@ -1431,12 +1438,12 @@ type ObjectSearchListItemProps = SelectedItemProps & {
|
|
|
1431
1438
|
/**
|
|
1432
1439
|
* @description entry search list item is an opinionated UI component best used for initial retrieved results
|
|
1433
1440
|
* @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
|
|
1434
|
-
declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) =>
|
|
1441
|
+
declare const ObjectSearchListItem: ({ id, title, contentType, image, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1435
1442
|
/**
|
|
1436
1443
|
* An opinionated loading skeleton component best used with ObjectSearchListItem
|
|
1437
1444
|
* @example <ObjectSearchListItemLoadingSkeleton />
|
|
1438
1445
|
*/
|
|
1439
|
-
declare const ObjectSearchListItemLoadingSkeleton: () =>
|
|
1446
|
+
declare const ObjectSearchListItemLoadingSkeleton: () => _emotion_react_jsx_runtime.JSX.Element;
|
|
1440
1447
|
|
|
1441
1448
|
type ObjectSearchResultItemProps = SelectedItemProps & {
|
|
1442
1449
|
/** sets additional remove functionality onto of default removal */
|
|
@@ -1456,7 +1463,7 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
|
|
|
1456
1463
|
* @description An opinionated result item, best used for selected results
|
|
1457
1464
|
* @example <ObjectSearchResultItem id="my-result" title="title" />
|
|
1458
1465
|
*/
|
|
1459
|
-
declare const ObjectSearchResultItem: ({ id, title, name, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, }: ObjectSearchResultItemProps) =>
|
|
1466
|
+
declare const ObjectSearchResultItem: ({ id, title, name, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1460
1467
|
|
|
1461
1468
|
type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement> = HTMLAttributes<HTMLButtonElement>> = {
|
|
1462
1469
|
/** sets the button or link text value */
|
|
@@ -1470,13 +1477,13 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
|
|
|
1470
1477
|
* @description An opinionated button component best used within the ObjectSearchResultItem component
|
|
1471
1478
|
* @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
|
|
1472
1479
|
*/
|
|
1473
|
-
declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) =>
|
|
1480
|
+
declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1474
1481
|
/**
|
|
1475
1482
|
* @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
|
|
1476
1483
|
* that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
|
|
1477
1484
|
* @example <LinkButton text="link text" icon="/my-image.png" />
|
|
1478
1485
|
*/
|
|
1479
|
-
declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>,
|
|
1486
|
+
declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1480
1487
|
|
|
1481
1488
|
type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = SelectedItemProps> = {
|
|
1482
1489
|
/** sets the result label value
|
|
@@ -1520,7 +1527,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
|
|
|
1520
1527
|
* maintain drag and drop functionality
|
|
1521
1528
|
* @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
|
|
1522
1529
|
*/
|
|
1523
|
-
declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>):
|
|
1530
|
+
declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1524
1531
|
|
|
1525
1532
|
type QueryFilterSearchProps = {
|
|
1526
1533
|
/** sets the count value */
|
|
@@ -1598,7 +1605,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
|
|
|
1598
1605
|
* @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
|
|
1599
1606
|
* @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
|
|
1600
1607
|
*/
|
|
1601
|
-
declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) =>
|
|
1608
|
+
declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1602
1609
|
|
|
1603
1610
|
type ParamTypeDynamicDataProviderProps = {
|
|
1604
1611
|
/** Child components of the provider. Variables-using components, such as ParameterVariables, can be used here. */
|
|
@@ -1617,20 +1624,20 @@ type ParameterConnectOptions = {
|
|
|
1617
1624
|
* using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
|
|
1618
1625
|
* where a data resource variable could be a static value or bound to a dynamic input from the route (project map).
|
|
1619
1626
|
*/
|
|
1620
|
-
declare function ParamTypeDynamicDataProvider(props: ParamTypeDynamicDataProviderProps):
|
|
1627
|
+
declare function ParamTypeDynamicDataProvider(props: ParamTypeDynamicDataProviderProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1621
1628
|
|
|
1622
1629
|
/** Editor component to let you write a request body for POST requests */
|
|
1623
|
-
declare function RequestBody():
|
|
1630
|
+
declare function RequestBody(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1624
1631
|
|
|
1625
1632
|
/** Editor component to manage HTTP headers on a request */
|
|
1626
|
-
declare function RequestHeaders({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>):
|
|
1633
|
+
declare function RequestHeaders({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1627
1634
|
|
|
1628
1635
|
/** Dropdown to pick a HTTP method for a request */
|
|
1629
|
-
declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>):
|
|
1636
|
+
declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1630
1637
|
|
|
1631
1638
|
type RequestParametersProps = Pick<InputVariablesProps, 'disableVariables'>;
|
|
1632
1639
|
/** Component to manage query parameters on a request */
|
|
1633
|
-
declare function RequestParameters({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>):
|
|
1640
|
+
declare function RequestParameters({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1634
1641
|
|
|
1635
1642
|
type RequestParameter = {
|
|
1636
1643
|
key: string;
|
|
@@ -1679,12 +1686,15 @@ type RequestAction = {
|
|
|
1679
1686
|
body: string;
|
|
1680
1687
|
contentType: string;
|
|
1681
1688
|
};
|
|
1689
|
+
type RequestActionContext = {
|
|
1690
|
+
dataSourceVariant?: DataSourceVariantsKeys;
|
|
1691
|
+
};
|
|
1682
1692
|
type RequestContext = {
|
|
1683
|
-
dispatch: (event: RequestAction) => void;
|
|
1693
|
+
dispatch: (event: RequestAction, ctx?: RequestActionContext) => void;
|
|
1684
1694
|
request: Readonly<RequestData>;
|
|
1685
1695
|
};
|
|
1686
1696
|
/** Provides a mutable HTTP request object context. Components such as RequestBody and RequestUrl use this context to render. */
|
|
1687
|
-
declare function RequestProvider({ value, onChange, children }: RequestProviderProps):
|
|
1697
|
+
declare function RequestProvider({ value, onChange, children }: RequestProviderProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1688
1698
|
declare function useRequest(): RequestContext;
|
|
1689
1699
|
|
|
1690
1700
|
type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
|
|
@@ -1700,18 +1710,18 @@ type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
|
|
|
1700
1710
|
* <label>Name <input type="text" /></label>
|
|
1701
1711
|
* <label>Name <input type="text" /></label>
|
|
1702
1712
|
* </div> */
|
|
1703
|
-
declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) =>
|
|
1713
|
+
declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1704
1714
|
|
|
1705
1715
|
/**
|
|
1706
1716
|
* Displays the current full URL of the request, including the base URL if one is set
|
|
1707
1717
|
*/
|
|
1708
|
-
declare function RequestUrl():
|
|
1718
|
+
declare function RequestUrl(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1709
1719
|
|
|
1710
1720
|
/**
|
|
1711
1721
|
* Editor to modify the current URL of the request
|
|
1712
1722
|
* Note: entering query string parameters automatically converts them and syncs the request state with them
|
|
1713
1723
|
*/
|
|
1714
|
-
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'> & Pick<InputVariablesProps, 'showAddVariableMenuOption' | 'enableEditingVariables'>):
|
|
1724
|
+
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'> & Pick<InputVariablesProps, 'showAddVariableMenuOption' | 'enableEditingVariables'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1715
1725
|
|
|
1716
1726
|
declare function urlEncodeRequestUrl(url: string, varValues?: Record<string, MeshDataVariableDefinition>): string;
|
|
1717
1727
|
declare function urlEncodeRequestParameter(parameter: RequestParameter, varValues?: Record<string, MeshDataVariableDefinition>): RequestParameter;
|
|
@@ -1772,14 +1782,45 @@ type InputOptionValue = {
|
|
|
1772
1782
|
type Operator = {
|
|
1773
1783
|
/** The label for the operator */
|
|
1774
1784
|
label: string;
|
|
1775
|
-
/** The
|
|
1785
|
+
/** The stored value for the operator */
|
|
1776
1786
|
value?: string;
|
|
1777
|
-
/** The symbol for the operator */
|
|
1778
|
-
symbol?: string;
|
|
1779
1787
|
/** The editor type for the operator */
|
|
1780
1788
|
options?: Array<InputOption>;
|
|
1781
1789
|
/** The editor type for the operator */
|
|
1782
1790
|
editorType?: FilterEditor;
|
|
1791
|
+
/**
|
|
1792
|
+
* Controls whether the operator's right-hand-side allows bound dynamic tokens.
|
|
1793
|
+
*
|
|
1794
|
+
* When false or unspecified: dynamic tokens are disallowed at all times.
|
|
1795
|
+
* When true: dynamic tokens are allowed when the `editorType` supports dynamic tokens
|
|
1796
|
+
*
|
|
1797
|
+
* NOTE: Operator-level bindable setting will override FilterOption-level setting, unless the operator bindable is undefined.
|
|
1798
|
+
*
|
|
1799
|
+
* When operators are switched from a bindable operator to a non-bindable operator, and the RH value has bindings, it will be cleared.
|
|
1800
|
+
*/
|
|
1801
|
+
bindable?: boolean;
|
|
1802
|
+
/**
|
|
1803
|
+
* The expected right-hand-side value type for the operator.
|
|
1804
|
+
* If not provided, the value can be any allowed type.
|
|
1805
|
+
*
|
|
1806
|
+
* When provided, tells the editor to expect a specific type. This information is used
|
|
1807
|
+
* to determine what to do when swapping between operators:
|
|
1808
|
+
*
|
|
1809
|
+
* - 'single': single value is expected, array value will be converted to single value, none value will be empty
|
|
1810
|
+
* - 'array': array value is expected, single value will be converted to one-element array value, none value will be empty
|
|
1811
|
+
* - 'between': two-element array value is expected, single value will be converted to first element of a two-element array
|
|
1812
|
+
* - 'none': no value is expected, incoming single and array values will be converted to empty value
|
|
1813
|
+
* - 'any other string': the value is hardcoded to this when switched to. It is cleared when switched away from.
|
|
1814
|
+
* - undefined: either single or array values are allowed. No conversion is done when switching operators, unless switching from none/any other value to this operator.
|
|
1815
|
+
*/
|
|
1816
|
+
expectedValueType: ('single' | 'array' | 'between' | 'none') | {} | undefined;
|
|
1817
|
+
};
|
|
1818
|
+
/** @deprecated beta - Filter option props */
|
|
1819
|
+
type FilterOptionLeftHandComponentProps = {
|
|
1820
|
+
deselectFilterOption: () => void;
|
|
1821
|
+
filterOption: FilterOption;
|
|
1822
|
+
filter: Filter;
|
|
1823
|
+
setFilterDynamicValue: ((dynamicValue: string | undefined) => void) | undefined;
|
|
1783
1824
|
};
|
|
1784
1825
|
/** @deprecated beta - Filter option props */
|
|
1785
1826
|
type FilterOption = {
|
|
@@ -1787,8 +1828,6 @@ type FilterOption = {
|
|
|
1787
1828
|
label: string;
|
|
1788
1829
|
/** The value for the option */
|
|
1789
1830
|
value: string;
|
|
1790
|
-
/** The options for the option */
|
|
1791
|
-
options?: FilterOption[];
|
|
1792
1831
|
/** The operator options for the option */
|
|
1793
1832
|
operatorOptions?: Operator[];
|
|
1794
1833
|
/** The value options for the option */
|
|
@@ -1797,13 +1836,41 @@ type FilterOption = {
|
|
|
1797
1836
|
readOnly?: boolean;
|
|
1798
1837
|
/** Set a disabled state on the input */
|
|
1799
1838
|
disabled?: boolean;
|
|
1800
|
-
/**
|
|
1839
|
+
/**
|
|
1840
|
+
* Controls whether the filter's right-hand-side allows bound dynamic tokens.
|
|
1841
|
+
*
|
|
1842
|
+
* When false or unspecified: dynamic tokens are disallowed by default.
|
|
1843
|
+
* When true: dynamic tokens are allowed when the selected operator's `editorType` supports dynamic tokens
|
|
1844
|
+
*
|
|
1845
|
+
* NOTE: in most cases, one should set bindable on the operator level instead of the filter level.
|
|
1846
|
+
* Operator-level bindable setting will override FilterOption-level setting, unless the operator bindable is undefined.
|
|
1847
|
+
*/
|
|
1801
1848
|
bindable?: boolean;
|
|
1849
|
+
/** If value should be excluded from the sort options */
|
|
1850
|
+
excludeFromSort?: boolean;
|
|
1851
|
+
/**
|
|
1852
|
+
* Custom component that is rendered instead of the filter menu when this filter option is selected
|
|
1853
|
+
* Used to allow dynamic tokens to be set as a filter.
|
|
1854
|
+
*/
|
|
1855
|
+
leftHandSideComponentWhenSelected?: ComponentType<FilterOptionLeftHandComponentProps>;
|
|
1856
|
+
};
|
|
1857
|
+
/** @deprecated beta - Filter option props */
|
|
1858
|
+
type FilterOptionGroup = {
|
|
1859
|
+
/** The label for the option group */
|
|
1860
|
+
label: string;
|
|
1861
|
+
/** Value for the option group. Should be unique, not stored. */
|
|
1862
|
+
value: string;
|
|
1863
|
+
/** The options for the option */
|
|
1864
|
+
options?: FilterOption[];
|
|
1802
1865
|
};
|
|
1803
1866
|
/** @deprecated beta - Filter selected and query value props */
|
|
1804
1867
|
type Filter = {
|
|
1805
1868
|
/** The field value selected */
|
|
1806
1869
|
field: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* If a field allows for dynamic variations of itself, such as bindings, this stores the dynamic value
|
|
1872
|
+
*/
|
|
1873
|
+
dynamicField?: string;
|
|
1807
1874
|
/** The operator value selected */
|
|
1808
1875
|
operator: string;
|
|
1809
1876
|
/** The value selected */
|
|
@@ -1839,7 +1906,7 @@ declare const TEXTBOX_OPERATORS: OperatorType;
|
|
|
1839
1906
|
/** @deprecated beta - uniform user operators */
|
|
1840
1907
|
declare const USER_OPERATORS: OperatorType;
|
|
1841
1908
|
/** @deprecated beta - uniform system date operators */
|
|
1842
|
-
declare const
|
|
1909
|
+
declare const DATE_TIME_OPERATORS: OperatorType;
|
|
1843
1910
|
/** @deprecated beta - uniform rich text operators */
|
|
1844
1911
|
declare const RICHTEXT_OPERATORS: OperatorType;
|
|
1845
1912
|
/** @deprecated beta - uniform checkbox operators */
|
|
@@ -1859,60 +1926,60 @@ declare const MULTI_SELECT_OPERATORS: OperatorType;
|
|
|
1859
1926
|
* @deprecated beta - Renders a date input field for filtering
|
|
1860
1927
|
* @example <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
|
|
1861
1928
|
*/
|
|
1862
|
-
declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1929
|
+
declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1863
1930
|
|
|
1864
1931
|
/**
|
|
1865
1932
|
* @deprecated beta - Renders a date range input field for filtering
|
|
1866
1933
|
* @example <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
|
|
1867
1934
|
*/
|
|
1868
|
-
declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1935
|
+
declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1869
1936
|
|
|
1870
1937
|
/**
|
|
1871
1938
|
* @deprecated beta - Multie select filter component
|
|
1872
1939
|
* @example <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
|
|
1873
1940
|
*/
|
|
1874
|
-
declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) =>
|
|
1941
|
+
declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1875
1942
|
|
|
1876
1943
|
/**
|
|
1877
1944
|
* @deprecated beta - Single select filter component
|
|
1878
1945
|
* @example <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
|
|
1879
1946
|
*/
|
|
1880
|
-
declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1947
|
+
declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1881
1948
|
|
|
1882
1949
|
/**
|
|
1883
1950
|
* @deprecated beta - Renders a number input field for filtering
|
|
1884
1951
|
* @example <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
|
|
1885
1952
|
*/
|
|
1886
|
-
declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1953
|
+
declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1887
1954
|
|
|
1888
1955
|
/**
|
|
1889
1956
|
* @deprecated beta - Renders a number range input field for filtering
|
|
1890
1957
|
* @example <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
|
|
1891
1958
|
*/
|
|
1892
|
-
declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1959
|
+
declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1893
1960
|
|
|
1894
1961
|
/**
|
|
1895
1962
|
* @deprecated beta - Status multi select filter component that renders a custom dropdown menu
|
|
1896
1963
|
* @example <StatusMultiEditor options={options} value={value} onChange={onChange} />
|
|
1897
1964
|
*/
|
|
1898
|
-
declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1965
|
+
declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1899
1966
|
|
|
1900
1967
|
/**
|
|
1901
1968
|
* @deprecated beta - Status single select filter component that renders a custom dropdown menu
|
|
1902
1969
|
* @example <StatusSingleEditor options={options} value={value} onChange={onChange} />
|
|
1903
1970
|
*/
|
|
1904
|
-
declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1971
|
+
declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1905
1972
|
|
|
1906
1973
|
/**
|
|
1907
1974
|
* @deprecated beta - Renders a text input field for filtering
|
|
1908
1975
|
* @example <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
|
|
1909
1976
|
*/
|
|
1910
|
-
declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1977
|
+
declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1911
1978
|
|
|
1912
1979
|
/**
|
|
1913
1980
|
* @deprecated beta - Text value multi select filter component
|
|
1914
1981
|
*/
|
|
1915
|
-
declare const TextMultiChoiceEditor: ({ value, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) =>
|
|
1982
|
+
declare const TextMultiChoiceEditor: ({ value, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1916
1983
|
|
|
1917
1984
|
/** @description beta - filter button type */
|
|
1918
1985
|
type FilterButtonProps = {
|
|
@@ -1935,7 +2002,7 @@ type FilterButtonProps = {
|
|
|
1935
2002
|
* @deprecated beta - A filter button component used to display filter menu options
|
|
1936
2003
|
* @example <FilterButton text="Filters" filterCount={3} />
|
|
1937
2004
|
*/
|
|
1938
|
-
declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, ...props }: FilterButtonProps) =>
|
|
2005
|
+
declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, ...props }: FilterButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1939
2006
|
|
|
1940
2007
|
/**
|
|
1941
2008
|
* @deprecated beta - Default filter controls for search and filter
|
|
@@ -1945,24 +2012,49 @@ declare const FilterControls: ({ children, hideSearchInput, }: {
|
|
|
1945
2012
|
/** optional param to allow you to add your own controls */
|
|
1946
2013
|
children?: ReactNode;
|
|
1947
2014
|
/** optional param to hide the search input */
|
|
1948
|
-
hideSearchInput?: boolean
|
|
1949
|
-
}) =>
|
|
2015
|
+
hideSearchInput?: boolean;
|
|
2016
|
+
}) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1950
2017
|
|
|
1951
2018
|
/**
|
|
1952
2019
|
* @deprecated beta - Renders a filter editor component
|
|
1953
2020
|
* @example <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
|
|
1954
2021
|
*/
|
|
1955
|
-
declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps<never>) =>
|
|
2022
|
+
declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps<never>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1956
2023
|
/** @deprecated beta - A mapper for filter editor components */
|
|
1957
2024
|
declare const filterMapper: Record<FilterEditor, ComponentType<FilterEditorRendererProps<any>> | null>;
|
|
1958
2025
|
declare const bindableFiltersMapper: typeof filterMapper;
|
|
1959
2026
|
|
|
2027
|
+
type FilterItemProps = {
|
|
2028
|
+
/** the index of the filter row */
|
|
2029
|
+
index: number;
|
|
2030
|
+
/** function to trigger filter change events */
|
|
2031
|
+
onFilterOptionChange: (newFilter: string) => void;
|
|
2032
|
+
/** Called when a custom LHS component sets a dynamic filter value */
|
|
2033
|
+
onFilterDynamicChange?: (newFilterDynamic: string | undefined) => void;
|
|
2034
|
+
/** the list of operator options for each filter row */
|
|
2035
|
+
operatorOptions: Operator[];
|
|
2036
|
+
/** function to trigger operator change events */
|
|
2037
|
+
onOperatorChange: (newOperator: string) => void;
|
|
2038
|
+
/** function to trigger value change events */
|
|
2039
|
+
onValueChange: (newValue: string | string[]) => void;
|
|
2040
|
+
/** the list of value options for each filter row */
|
|
2041
|
+
valueOptions: InputOption[];
|
|
2042
|
+
/** Sets the title before the first criteria (i.e. "When", "Where") */
|
|
2043
|
+
initialCriteriaTitle?: string;
|
|
2044
|
+
/** How multiple criteria are joined together */
|
|
2045
|
+
criteriaGroupOperator?: 'and' | 'or';
|
|
2046
|
+
};
|
|
2047
|
+
/** @deprecated beta - A filter item component used to display filter options */
|
|
2048
|
+
declare const FilterItem: ({ index, operatorOptions, valueOptions, onFilterOptionChange, onFilterDynamicChange, onOperatorChange, onValueChange, initialCriteriaTitle, criteriaGroupOperator, }: FilterItemProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2049
|
+
|
|
1960
2050
|
type FilterMapper = Record<string, ComponentType<any> | null>;
|
|
1961
2051
|
type SearchAndFilterProviderProps = {
|
|
1962
2052
|
/** sets the filter values */
|
|
1963
2053
|
filters: Filter[];
|
|
1964
|
-
/** sets the filter visibility */
|
|
2054
|
+
/** sets the initial filter visibility */
|
|
1965
2055
|
filterVisible?: boolean;
|
|
2056
|
+
/** makes the filter UI always visible no matter what (ignores filterVisible, and subsequent internal visibility changes) */
|
|
2057
|
+
alwaysVisible?: boolean;
|
|
1966
2058
|
/** function to trigger search change event */
|
|
1967
2059
|
onSearchChange?: (term: string) => void;
|
|
1968
2060
|
/** function to trigger filter change events */
|
|
@@ -1974,7 +2066,7 @@ type SearchAndFilterProviderProps = {
|
|
|
1974
2066
|
*/
|
|
1975
2067
|
resetFilterValues?: Filter[];
|
|
1976
2068
|
/** sets the list of filter options for each filter row */
|
|
1977
|
-
filterOptions:
|
|
2069
|
+
filterOptions: FilterOptionGroup[];
|
|
1978
2070
|
/** the total number of results */
|
|
1979
2071
|
totalResults?: number;
|
|
1980
2072
|
/** the filter mapper function */
|
|
@@ -2004,7 +2096,7 @@ type SearchAndFilterContextProps = {
|
|
|
2004
2096
|
/** function that deletes a row and it's values visually and from state */
|
|
2005
2097
|
handleDeleteFilter: (index: number) => void;
|
|
2006
2098
|
/** sets the initial list of filter options */
|
|
2007
|
-
filterOptions:
|
|
2099
|
+
filterOptions: FilterOptionGroup[];
|
|
2008
2100
|
/** a valid list of valid filter options */
|
|
2009
2101
|
validFilterQuery: Filter[] | undefined;
|
|
2010
2102
|
/** a component list to map filter options */
|
|
@@ -2019,7 +2111,7 @@ declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProp
|
|
|
2019
2111
|
* @deprecated beta - Search and filter provider
|
|
2020
2112
|
* @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
|
|
2021
2113
|
* */
|
|
2022
|
-
declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) =>
|
|
2114
|
+
declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2023
2115
|
/** @deprecated beta - Search and filter hook
|
|
2024
2116
|
* @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
|
|
2025
2117
|
*/
|
|
@@ -2029,7 +2121,7 @@ declare const useSearchAndFilter: () => {
|
|
|
2029
2121
|
/** sets the search term value */
|
|
2030
2122
|
setSearchTerm: (term: string) => void;
|
|
2031
2123
|
/** current filter visibility */
|
|
2032
|
-
filterVisibility?: boolean
|
|
2124
|
+
filterVisibility?: boolean;
|
|
2033
2125
|
/** sets the filter visibility */
|
|
2034
2126
|
setFilterVisibility: (visible: boolean) => void;
|
|
2035
2127
|
/** sets the initial filters */
|
|
@@ -2043,15 +2135,15 @@ declare const useSearchAndFilter: () => {
|
|
|
2043
2135
|
/** function that deletes a row and it's values visually and from state */
|
|
2044
2136
|
handleDeleteFilter: (index: number) => void;
|
|
2045
2137
|
/** sets the initial list of filter options */
|
|
2046
|
-
filterOptions:
|
|
2138
|
+
filterOptions: FilterOptionGroup[];
|
|
2047
2139
|
/** a valid list of valid filter options */
|
|
2048
2140
|
validFilterQuery: Filter[] | undefined;
|
|
2049
2141
|
/** a component list to map filter options */
|
|
2050
|
-
filterMapper?: FilterMapper
|
|
2142
|
+
filterMapper?: FilterMapper;
|
|
2051
2143
|
/** the total number of results */
|
|
2052
|
-
totalResults?: number
|
|
2144
|
+
totalResults?: number;
|
|
2053
2145
|
/** Allow to bind dynamic inputs to the search term */
|
|
2054
|
-
allowBindingSearchTerm?: boolean
|
|
2146
|
+
allowBindingSearchTerm?: boolean;
|
|
2055
2147
|
};
|
|
2056
2148
|
|
|
2057
2149
|
type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
|
|
@@ -2082,37 +2174,17 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
|
|
|
2082
2174
|
* @deprecated beta - Search and filter component
|
|
2083
2175
|
* @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
|
|
2084
2176
|
* */
|
|
2085
|
-
declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) =>
|
|
2177
|
+
declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2086
2178
|
|
|
2087
|
-
type FilterRowProps = {
|
|
2088
|
-
/** the index of the filter row */
|
|
2089
|
-
index: number;
|
|
2090
|
-
/** the list of filter options for each filter row */
|
|
2091
|
-
paramOptions: FilterOption[];
|
|
2092
|
-
/** function to trigger filter change events */
|
|
2093
|
-
onParamChange: (e: string) => void;
|
|
2094
|
-
/** the list of operator options for each filter row */
|
|
2095
|
-
operatorOptions: Operator[];
|
|
2096
|
-
/** function to trigger operator change events */
|
|
2097
|
-
onOperatorChange: (e: string) => void;
|
|
2098
|
-
/** function to trigger value change events */
|
|
2099
|
-
onValueChange: (e: string | string[]) => void;
|
|
2100
|
-
/** the list of value options for each filter row */
|
|
2101
|
-
valueOptions: InputOption[];
|
|
2102
|
-
initialCriteriaTitle?: string;
|
|
2103
|
-
};
|
|
2104
|
-
/** @deprecated beta - A filter item component used to display filter options */
|
|
2105
|
-
declare const FilterItem: ({ index, paramOptions, operatorOptions, valueOptions, onParamChange, onOperatorChange, onValueChange, initialCriteriaTitle, }: FilterRowProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
2106
2179
|
type FilterItemsProps = {
|
|
2107
2180
|
/** The text for the add button */
|
|
2108
2181
|
addButtonText?: string;
|
|
2109
2182
|
additionalFiltersContainer: SearchAndFilterProps['additionalFiltersContainer'];
|
|
2110
2183
|
filterTitle?: string;
|
|
2111
2184
|
resetButtonText?: string;
|
|
2112
|
-
|
|
2113
|
-
};
|
|
2185
|
+
} & Pick<FilterItemProps, 'initialCriteriaTitle' | 'criteriaGroupOperator'>;
|
|
2114
2186
|
/** @deprecated beta - A filter items component used to display filter options */
|
|
2115
|
-
declare const FilterItems: ({ addButtonText, additionalFiltersContainer, filterTitle, resetButtonText, initialCriteriaTitle, }: FilterItemsProps) =>
|
|
2187
|
+
declare const FilterItems: ({ addButtonText, additionalFiltersContainer, filterTitle, resetButtonText, initialCriteriaTitle, criteriaGroupOperator, }: FilterItemsProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2116
2188
|
|
|
2117
2189
|
type SearchAndFilterOptionsContainerProps = {
|
|
2118
2190
|
/** The button row to be displayed at the bottom of the container */
|
|
@@ -2125,7 +2197,7 @@ type SearchAndFilterOptionsContainerProps = {
|
|
|
2125
2197
|
* @deprecated beta - A container component for search and filter options
|
|
2126
2198
|
* @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
|
|
2127
2199
|
* */
|
|
2128
|
-
declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) =>
|
|
2200
|
+
declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2129
2201
|
type FiltersProps = {
|
|
2130
2202
|
/** The id of the filter menu */
|
|
2131
2203
|
id: string;
|
|
@@ -2147,7 +2219,7 @@ type FiltersProps = {
|
|
|
2147
2219
|
* @deprecated beta - A filter menu component used to display filter options
|
|
2148
2220
|
* @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
|
|
2149
2221
|
* */
|
|
2150
|
-
declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) =>
|
|
2222
|
+
declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2151
2223
|
|
|
2152
2224
|
type SearchAndFilterResultContainerProps = {
|
|
2153
2225
|
/** The label for the clear button
|
|
@@ -2166,7 +2238,7 @@ type SearchAndFilterResultContainerProps = {
|
|
|
2166
2238
|
hideClearButton?: boolean;
|
|
2167
2239
|
};
|
|
2168
2240
|
/** @deprecated beta - Search and filter results container */
|
|
2169
|
-
declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) =>
|
|
2241
|
+
declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) => _emotion_react_jsx_runtime.JSX.Element | null;
|
|
2170
2242
|
|
|
2171
2243
|
declare const SearchOnlyContext: React$1.Context<Pick<SearchAndFilterContextProps, "searchTerm" | "setSearchTerm">>;
|
|
2172
2244
|
type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChange'> & {
|
|
@@ -2175,7 +2247,7 @@ type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChang
|
|
|
2175
2247
|
*/
|
|
2176
2248
|
maxWidth?: string;
|
|
2177
2249
|
};
|
|
2178
|
-
declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) =>
|
|
2250
|
+
declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2179
2251
|
|
|
2180
2252
|
type SortItemsProps = {
|
|
2181
2253
|
/** The label for the sort by field
|
|
@@ -2187,7 +2259,7 @@ type SortItemsProps = {
|
|
|
2187
2259
|
*/
|
|
2188
2260
|
localeLabel?: string;
|
|
2189
2261
|
/** sets the list of sort options */
|
|
2190
|
-
sortOptions:
|
|
2262
|
+
sortOptions: FilterOptionGroup[];
|
|
2191
2263
|
/** the default sort by value */
|
|
2192
2264
|
sortByValue?: string;
|
|
2193
2265
|
/** function to trigger sort change events */
|
|
@@ -2207,7 +2279,7 @@ type SortItemsProps = {
|
|
|
2207
2279
|
/**
|
|
2208
2280
|
Copy of Design System <SortItems > component with ability to bind variables to inputs.
|
|
2209
2281
|
*/
|
|
2210
|
-
declare const SortItems: ({ sortByLabel, localeLabel, sortOptions, sortByValue, onSortChange, localeValue, localeOptions, onLocaleChange, disableSortBinding, }: SortItemsProps) =>
|
|
2282
|
+
declare const SortItems: ({ sortByLabel, localeLabel, sortOptions, sortByValue, onSortChange, localeValue, localeOptions, onLocaleChange, disableSortBinding, }: SortItemsProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2211
2283
|
|
|
2212
2284
|
/** Converts connected data map into VariablesProvider-format variables */
|
|
2213
2285
|
declare function useConnectedDataAsVariables(connectedData: Record<string, unknown> | undefined): Record<string, MeshDataVariableDefinition>;
|
|
@@ -2260,4 +2332,4 @@ type ContentDataResourceLocaleInfoProps = {
|
|
|
2260
2332
|
};
|
|
2261
2333
|
declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
|
|
2262
2334
|
|
|
2263
|
-
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, CHECKBOX_OPERATORS, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledValuePlugin, DATE_OPERATORS, DISCONNECT_VARIABLE_COMMAND, type DamItem, DamSelectedItem, type DamSelectedItemProps, DataRefreshButton, type DataRefreshButtonProps, DataResourceDynamicInputProvider, type DataResourceDynamicInputProviderProps, type DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, type DataResourceVariablesListProps, DataSourceEditor, type DataSourceEditorProps, DataTypeEditor, type DataTypeEditorProps, type DataVariableDefinitionWithName, DateEditor, DateRangeEditor, DefaultSearchRow, DefaultSelectedItem, type DisconnectVariableCommandArguments, type DispatchResult, EDIT_VARIABLE_COMMAND, type EditVariableCommandArguments, EntrySearch, type EntrySearchContentType, type EntrySearchProps, type EntrySearchQueryOptions, type EntrySearchResult, type EntrySearchRowProps, type EntrySearchSelectedItemProps, type Filter, FilterButton, type FilterButtonProps, FilterControls, type FilterEditor, FilterEditorRenderer, type FilterEditorRendererProps, FilterItem, FilterItems, type FilterItemsProps, type FilterMapper, FilterMenu, FilterMultiChoiceEditor, type FilterOption, type
|
|
2335
|
+
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, CHECKBOX_OPERATORS, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledValuePlugin, DATE_OPERATORS, DATE_TIME_OPERATORS, DISCONNECT_VARIABLE_COMMAND, type DamItem, DamSelectedItem, type DamSelectedItemProps, DataRefreshButton, type DataRefreshButtonProps, DataResourceDynamicInputProvider, type DataResourceDynamicInputProviderProps, type DataResourceVariableRendererProps, DataResourceVariablesList, DataResourceVariablesListExplicit, type DataResourceVariablesListProps, DataSourceEditor, type DataSourceEditorProps, DataTypeEditor, type DataTypeEditorProps, type DataVariableDefinitionWithName, DateEditor, DateRangeEditor, DefaultSearchRow, DefaultSelectedItem, type DisconnectVariableCommandArguments, type DispatchResult, EDIT_VARIABLE_COMMAND, type EditVariableCommandArguments, EntrySearch, type EntrySearchContentType, type EntrySearchProps, type EntrySearchQueryOptions, type EntrySearchResult, type EntrySearchRowProps, type EntrySearchSelectedItemProps, type Filter, FilterButton, type FilterButtonProps, FilterControls, type FilterEditor, FilterEditorRenderer, type FilterEditorRendererProps, FilterItem, type FilterItemProps, FilterItems, type FilterItemsProps, type FilterMapper, FilterMenu, FilterMultiChoiceEditor, type FilterOption, type FilterOptionGroup, type FilterOptionLeftHandComponentProps, FilterSingleChoiceEditor, type FiltersProps, type GetProductOptions, type GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, type InputOption, type InputOptionGroup, type InputOptionValue, InputVariables, type InputVariablesProps, type InsertVariableCommandArguments, type ItemListProps, type KnownUndefinedVariableInfo, type KnownUndefinedVariableInfoWithName, LinkButton, MULTI_SELECT_OPERATORS, MeshApp, type MeshAppProps, type MeshDataVariableDefinition, NUMBER_OPERATORS, type NoResultsProps, NumberEditor, NumberRangeEditor, OPEN_INSERT_VARIABLE_COMMAND, OPTIONAL_SYSTEM_FIELD_OPERATORS, ObjectSearchContainer, type ObjectSearchContainerProps, type ObjectSearchContextProps, ObjectSearchFilter, ObjectSearchFilterContainer, type ObjectSearchFilterContainerProps, type ObjectSearchFilterProps, ObjectSearchListItem, ObjectSearchListItemLoadingSkeleton, type ObjectSearchListItemProps, ObjectSearchProvider, type ObjectSearchProviderProps, ObjectSearchResultItem, ObjectSearchResultItemButton, type ObjectSearchResultItemButtonProps, type ObjectSearchResultItemProps, ObjectSearchResultList, type ObjectSearchResultListProps, type Operator, type OperatorType, type OperatorValue, type OperatorValueType, PUBLISH_STATUS_FIELD_OPERATORS, ParamTypeDynamicDataProvider, type ParamTypeDynamicDataProviderProps, type ParameterConnectOptions, ParameterConnectionIndicator, type ParameterConnectionIndicatorProps, ParameterOrSingleVariable, type ParameterOrSingleVariableProps, ParameterVariables, type ParameterVariablesProps, type ProductCategory, type ProductDynamicSelectorValue, ProductPreviewList, ProductQuery, type ProductQueryCategory, ProductQueryContext, type ProductQueryContextValue, type ProductQueryProps, ProductSearch, ProductSearchContext, type ProductSearchContextValue, type ProductSearchProps, type ProductSearchResult, type ProductSearchResults, ProductSearchRow, ProductSelectedItem, QueryFilter, type QueryFilterProps, type QueryFilterSearchProps, RICHTEXT_OPERATORS, type RequestAction, type RequestActionContext, RequestBody, type RequestContext, type RequestData, RequestHeaders, RequestMethodSelect, type RequestParameter, RequestParameters, type RequestParametersProps, RequestProvider, type RequestProviderProps, RequestTypeContainer, type RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, SELECT_OPERATORS, SYSTEM_FIELD_OPERATORS, SearchAndFilter, SearchAndFilterContext, type SearchAndFilterContextProps, SearchAndFilterOptionsContainer, type SearchAndFilterOptionsContainerProps, type SearchAndFilterProps, SearchAndFilterProvider, type SearchAndFilterProviderProps, SearchAndFilterResultContainer, type SearchAndFilterResultContainerProps, SearchOnlyContext, SearchOnlyFilter, type SearchOnlyProviderProps, type SearchQueryProps, type SelectedItemProps, SelectionField, type SelectionFieldValue, type SerializedVariableNode, type SetLocationValueDispatch, type SetLocationValueFunction, SortItems, type SortItemsProps, StatusMultiEditor, StatusSingleEditor, TEXTBOX_OPERATORS, TextEditor, TextMultiChoiceEditor, TextVariableRenderer, USER_OPERATORS, type UseVariablesMenu, type UseVariablesMenuInput, VariableChip, VariableEditor, type VariableEditorCompleteEvent, type VariableEditorProps, VariableNode, type VariableNodeState, type VariableSourceGroup, type VariablesAction, type VariablesContext, type VariablesEvents, VariablesList, VariablesPlugin, type VariablesPluginProps, VariablesProvider, type VariablesProviderProps, badgeIcon, bindableFiltersMapper, convertConnectedDataToVariable, createLocationValidator, damSelectItemImage, damSelectedItemContainer, damSelectedItemCopy, damSelectedItemDetails, damSelectedItemIcon, damSelectedItemInfoBtn, damSelectedItemInner, damSelectedItemLinkBtn, damSelectedItemLinkContainer, damSelectedItemMediaContainer, damSelectedItemPopover, damSelectedItemPopoverLabel, damSelectedItemSmallText, damSelectedItemTitle, draggableContainer, draggableIcon, draggableIconOffset, draggableIconWrapper, entrySearchBtn, entrySearchConfig, entrySearchConfigHidden, entrySearchLoadMoreBtn, entrySearchResultList, entrySearchSelectIcon, entrySearchSelectImg, entrySearchSelectInput, entrySearchSelectOption, entrySearchWrapper, filterMapper, hasReferencedVariables, prettifyBindExpression, productSearchRowActiveIcon, productSearchRowCategory, productSearchRowContainer, productSearchRowContent, productSearchRowContentActive, productSearchRowDetails, productSearchRowTitle, productSelectedItemContainer, productSelectedItemContent, productSelectedItemDetails, productSelectedItemIcon, productSelectedItemImage, productSelectedItemLinkContainer, productedSelectedItemLinkBtn, productedSelectedItemSmallText, searchRowBtn, searchRowContainer, searchRowContainerActive, searchRowContainerWithPopover, searchRowPopover, searchRowText, searchRowTextSmall, selectItemLinkBtn, selectItemLinkContainer, selectItemPopover, selectItemPopoverLabel, selectItemSmallText, selectedItemContainer, selectedItemCopy, selectedItemDetails, selectedItemIcon, selectedItemInner, selectedItemTitle, serializeVariablesEditorSerializedState, serializeVariablesEditorState, setVariablesEditorValue, urlEncodeRequestParameter, urlEncodeRequestUrl, useConnectedDataAsVariables, useContentDataResourceLocaleInfo, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useSearchAndFilter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
|