@uniformdev/mesh-sdk-react 19.173.1-alpha.17 → 19.173.2-alpha.258
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 +206 -126
- package/dist/index.d.ts +206 -126
- package/dist/index.esm.js +595 -399
- package/dist/index.js +682 -490
- package/dist/index.mjs +595 -399
- package/package.json +15 -14
package/dist/index.d.mts
CHANGED
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime';
|
|
2
2
|
import * as React$1 from 'react';
|
|
3
|
-
import React__default, { SVGProps, ReactNode, MutableRefObject, ComponentType, PropsWithChildren, HTMLAttributes, AnchorHTMLAttributes } from 'react';
|
|
3
|
+
import React__default, { SVGProps, ReactNode, MutableRefObject, ComponentType, PropsWithChildren, HTMLAttributes, AnchorHTMLAttributes, ButtonHTMLAttributes } from 'react';
|
|
4
4
|
import { TDate } from 'timeago.js';
|
|
5
5
|
import * as _emotion_react from '@emotion/react';
|
|
6
6
|
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.
|
|
@@ -425,6 +425,8 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
|
|
|
425
425
|
type: TLocationType;
|
|
426
426
|
}> | Extract<_uniformdev_mesh_sdk.CanvasEditorToolsLocation, {
|
|
427
427
|
type: TLocationType;
|
|
428
|
+
}> | Extract<_uniformdev_mesh_sdk.ContextualEditingLocation, {
|
|
429
|
+
type: TLocationType;
|
|
428
430
|
}> | Extract<_uniformdev_mesh_sdk.AIPromptMetadataLocation, {
|
|
429
431
|
type: TLocationType;
|
|
430
432
|
}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
|
|
@@ -448,6 +450,8 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
|
|
|
448
450
|
type: TLocationType;
|
|
449
451
|
}> | Extract<_uniformdev_mesh_sdk.CanvasEditorToolsLocation, {
|
|
450
452
|
type: TLocationType;
|
|
453
|
+
}> | Extract<_uniformdev_mesh_sdk.ContextualEditingLocation, {
|
|
454
|
+
type: TLocationType;
|
|
451
455
|
}> | Extract<_uniformdev_mesh_sdk.AIPromptMetadataLocation, {
|
|
452
456
|
type: TLocationType;
|
|
453
457
|
}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
|
|
@@ -470,6 +474,8 @@ declare function useMeshLocation<TLocationType extends MeshLocation['type'], TLo
|
|
|
470
474
|
type: TLocationType;
|
|
471
475
|
}> | Extract<_uniformdev_mesh_sdk.CanvasEditorToolsLocation, {
|
|
472
476
|
type: TLocationType;
|
|
477
|
+
}> | Extract<_uniformdev_mesh_sdk.ContextualEditingLocation, {
|
|
478
|
+
type: TLocationType;
|
|
473
479
|
}> | Extract<_uniformdev_mesh_sdk.AIPromptMetadataLocation, {
|
|
474
480
|
type: TLocationType;
|
|
475
481
|
}> | Extract<_uniformdev_mesh_sdk.ParamTypeLocation<TLocationValue, unknown, TLocationSetValue, unknown>, {
|
|
@@ -570,7 +576,7 @@ declare class VariableNode extends DecoratorNode<JSX.Element> {
|
|
|
570
576
|
* NOTE: this is effectively an island of React, and you may not call hooks,
|
|
571
577
|
* rely on Context, etc in this renderer.
|
|
572
578
|
*/
|
|
573
|
-
decorate():
|
|
579
|
+
decorate(): _emotion_react_jsx_runtime.JSX.Element;
|
|
574
580
|
}
|
|
575
581
|
declare function $createVariableNode(variableReference: string, state: VariableNodeState): VariableNode;
|
|
576
582
|
declare function $isVariableNode(node: LexicalNode | null | undefined): node is VariableNode;
|
|
@@ -584,7 +590,7 @@ declare function VariableChip({ displayName, referenceIsValid, tooltip, referenc
|
|
|
584
590
|
selected: boolean;
|
|
585
591
|
disabled?: boolean;
|
|
586
592
|
errorMessage?: string;
|
|
587
|
-
}):
|
|
593
|
+
}): _emotion_react_jsx_runtime.JSX.Element;
|
|
588
594
|
|
|
589
595
|
type MeshDataVariableDefinition = Omit<DataVariableDefinition, 'default'> & {
|
|
590
596
|
/** When used in code, variables may have non-string defaults */
|
|
@@ -645,7 +651,7 @@ type VariableEditorProps<TEditorContext = unknown, TEditVariableCompletedContext
|
|
|
645
651
|
disableAutoFocusOnMount?: boolean;
|
|
646
652
|
showDisplayName?: boolean;
|
|
647
653
|
};
|
|
648
|
-
declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>):
|
|
654
|
+
declare function VariableEditor({ variable, onSubmit, onCancel, showDisplayName, disableMeshTip, }: VariableEditorProps<any, unknown, EditConnectedDataResponseCancellationContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
649
655
|
|
|
650
656
|
type SelectVariableMenuProps<TEditorContext = undefined> = {
|
|
651
657
|
/** sets the onClick menu item event. Also called if the menu adds a variable with the newly added variable. */
|
|
@@ -876,12 +882,17 @@ type InputVariablesProps<TEditorContext = unknown> = {
|
|
|
876
882
|
styleVariant?: 'default' | 'compact';
|
|
877
883
|
/** Set the menu dropdown to render in a portal, this helps fix z-indexing issue */
|
|
878
884
|
renderMenuInPortal?: boolean;
|
|
885
|
+
/**
|
|
886
|
+
* Reconfigures the editor to have a single dynamic token value, not allow static text, and replace
|
|
887
|
+
* any existing value on insert a new dynamic token.
|
|
888
|
+
*/
|
|
889
|
+
singleTokenMode?: boolean;
|
|
879
890
|
} & PasteTransformerPluginProps & UseInputVariablesStateProps<TEditorContext>;
|
|
880
891
|
/**
|
|
881
892
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
882
893
|
* into its value.
|
|
883
894
|
*/
|
|
884
|
-
declare function InputVariables<TEditorContext = unknown>(props: InputVariablesProps<TEditorContext>):
|
|
895
|
+
declare function InputVariables<TEditorContext = unknown>(props: InputVariablesProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
885
896
|
|
|
886
897
|
type ParameterConnectionIndicatorProps = {
|
|
887
898
|
/** Disables the menu, hiding it from view entirely */
|
|
@@ -908,7 +919,7 @@ type ParameterConnectionIndicatorProps = {
|
|
|
908
919
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
909
920
|
* into its value. Designed specifically for use in the Canvas Parameter Editor.
|
|
910
921
|
*/
|
|
911
|
-
declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, overrideMenuButtonParentMargin, renderMenuInPortal, }: ParameterConnectionIndicatorProps):
|
|
922
|
+
declare function ParameterConnectionIndicator({ children, value, menuOptions, disabled, menuTooltip, overrideMenuButtonParentMargin, renderMenuInPortal, }: ParameterConnectionIndicatorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
912
923
|
|
|
913
924
|
type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
|
|
914
925
|
disabled?: boolean;
|
|
@@ -928,7 +939,7 @@ type ParameterOrSingleVariableProps<TEditorContext = unknown> = {
|
|
|
928
939
|
* possibly because they bind to objects or arrays.
|
|
929
940
|
* Designed visually for use in the Canvas Parameter Editor.
|
|
930
941
|
*/
|
|
931
|
-
declare function ParameterOrSingleVariable<TEditorContext = unknown>(props: ParameterOrSingleVariableProps<TEditorContext>):
|
|
942
|
+
declare function ParameterOrSingleVariable<TEditorContext = unknown>(props: ParameterOrSingleVariableProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
932
943
|
|
|
933
944
|
type ParameterVariablesProps<TEditorContext = unknown> = {
|
|
934
945
|
/** sets the input aria-label value. */
|
|
@@ -958,7 +969,7 @@ type ParameterVariablesProps<TEditorContext = unknown> = {
|
|
|
958
969
|
* An input box that enables insertion of 'variables', provided by VariablesProvider,
|
|
959
970
|
* into its value. Designed visually for use in the Canvas Parameter Editor.
|
|
960
971
|
*/
|
|
961
|
-
declare function ParameterVariables<TEditorContext = unknown>(props: ParameterVariablesProps<TEditorContext>):
|
|
972
|
+
declare function ParameterVariables<TEditorContext = unknown>(props: ParameterVariablesProps<TEditorContext>): _emotion_react_jsx_runtime.JSX.Element;
|
|
962
973
|
|
|
963
974
|
type VariablesProviderProps<TEditVariableContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown> = React.PropsWithChildren<{
|
|
964
975
|
/**
|
|
@@ -1085,7 +1096,7 @@ type VariablesContext<TEditVariableContext, TEditVariableCompletedContext, TEdit
|
|
|
1085
1096
|
*/
|
|
1086
1097
|
isLoading: boolean;
|
|
1087
1098
|
};
|
|
1088
|
-
declare function VariablesProvider<TEditComponentContext = never, TEditVariableCompletedContext = never, TEditVariableCancelledContext = never>({ value, onChange, editVariableComponent, readOnly, isLoading, children, knownUndefinedValues, onChangeKnownUndefinedValue, }: VariablesProviderProps<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>):
|
|
1099
|
+
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
1100
|
declare function useVariables<TEditComponentContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(returnEmptyWithoutProvider?: boolean): VariablesContext<TEditComponentContext, TEditVariableCompletedContext, TEditVariableCancelledContext>;
|
|
1090
1101
|
|
|
1091
1102
|
declare function useVariableEditor<TEditorContext = unknown, TEditVariableCompletedContext = unknown, TEditVariableCancelledContext = unknown>(): {
|
|
@@ -1097,6 +1108,7 @@ declare function convertConnectedDataToVariable(bindExpression: string, value: u
|
|
|
1097
1108
|
|
|
1098
1109
|
/**
|
|
1099
1110
|
* Returns true if the string expression has variable references in it
|
|
1111
|
+
* @deprecated use the same named function from @uniformdev/canvas instead
|
|
1100
1112
|
*/
|
|
1101
1113
|
declare function hasReferencedVariables(value: string): boolean;
|
|
1102
1114
|
|
|
@@ -1107,6 +1119,7 @@ declare function prettifyBindExpression(bindExpression: string): string;
|
|
|
1107
1119
|
* Note: if no content is in the editor state, undefined will be returned.
|
|
1108
1120
|
*/
|
|
1109
1121
|
declare function serializeVariablesEditorState(editorState: EditorState): string | undefined;
|
|
1122
|
+
declare function serializeVariablesEditorSerializedState(serializedEditorState: SerializedRootNode<SerializedLexicalNode>): string | undefined;
|
|
1110
1123
|
|
|
1111
1124
|
/**
|
|
1112
1125
|
* Programmatically sets the current value of a variables editor after it has already initialized
|
|
@@ -1117,7 +1130,7 @@ declare function serializeVariablesEditorState(editorState: EditorState): string
|
|
|
1117
1130
|
* If newValue is a string, it will be treated as a variable-reference-containing string, and parsed to a Lexical AST
|
|
1118
1131
|
* If newValue is a serialized Lexical AST, it will be used as-is. If the AST is invalid, the editor will be set to an empty state.
|
|
1119
1132
|
*/
|
|
1120
|
-
declare function setVariablesEditorValue(editor: LexicalEditor, newValue: string | undefined | SerializedEditorState<SerializedLexicalNode
|
|
1133
|
+
declare function setVariablesEditorValue(editor: LexicalEditor, newValue: string | undefined | SerializedEditorState<SerializedLexicalNode>, tag?: string): void;
|
|
1121
1134
|
|
|
1122
1135
|
declare function variableDefaultTextValue(defaultValue: unknown): string;
|
|
1123
1136
|
|
|
@@ -1132,7 +1145,7 @@ declare const variablePrefix = "${";
|
|
|
1132
1145
|
*/
|
|
1133
1146
|
declare const variableSuffix = "}";
|
|
1134
1147
|
|
|
1135
|
-
declare function VariablesList():
|
|
1148
|
+
declare function VariablesList(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1136
1149
|
|
|
1137
1150
|
type DataResourceVariablesListProps = {
|
|
1138
1151
|
/**
|
|
@@ -1158,7 +1171,7 @@ type DataResourceVariablesListProps = {
|
|
|
1158
1171
|
* Using the optional `type` attribute of variables, one can use custom components to render different
|
|
1159
1172
|
* variables using this component, enabling flexibility for more than just text inputs.
|
|
1160
1173
|
*/
|
|
1161
|
-
declare function DataResourceVariablesList(props: DataResourceVariablesListProps):
|
|
1174
|
+
declare function DataResourceVariablesList(props: DataResourceVariablesListProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1162
1175
|
/**
|
|
1163
1176
|
* Renders a list of Data Type-provided variables that can be set on a Data Resource.
|
|
1164
1177
|
*
|
|
@@ -1169,7 +1182,7 @@ declare function DataResourceVariablesListExplicit({ setVariables, noVariables:
|
|
|
1169
1182
|
value: DataResourceVariables;
|
|
1170
1183
|
dataType: DataType;
|
|
1171
1184
|
dynamicInputs: DynamicInputs;
|
|
1172
|
-
}):
|
|
1185
|
+
}): _emotion_react_jsx_runtime.JSX.Element;
|
|
1173
1186
|
type DataResourceVariableRendererProps = {
|
|
1174
1187
|
/** Current value of the variable on the data resource */
|
|
1175
1188
|
value: string | undefined;
|
|
@@ -1179,7 +1192,7 @@ type DataResourceVariableRendererProps = {
|
|
|
1179
1192
|
definition: DataVariableDefinitionWithName;
|
|
1180
1193
|
};
|
|
1181
1194
|
/** Default data resource variable renderer, uses a text input that supports dynamic input binding */
|
|
1182
|
-
declare function TextVariableRenderer({ definition, value, setValue }: DataResourceVariableRendererProps):
|
|
1195
|
+
declare function TextVariableRenderer({ definition, value, setValue }: DataResourceVariableRendererProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1183
1196
|
|
|
1184
1197
|
type DataSourceEditorProps = PropsWithChildren<{
|
|
1185
1198
|
/**
|
|
@@ -1193,7 +1206,7 @@ type DataSourceEditorProps = PropsWithChildren<{
|
|
|
1193
1206
|
* Wrapper for editing a data source using Uniform Mesh SDK components that rely on `useRequest()`
|
|
1194
1207
|
* or `useVariables()`, or custom components that use the same hooks.
|
|
1195
1208
|
*/
|
|
1196
|
-
declare function DataSourceEditor({ onChange, children, editVariableComponent }: DataSourceEditorProps):
|
|
1209
|
+
declare function DataSourceEditor({ onChange, children, editVariableComponent }: DataSourceEditorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1197
1210
|
|
|
1198
1211
|
type DataTypeEditorProps = PropsWithChildren<{
|
|
1199
1212
|
/**
|
|
@@ -1207,7 +1220,7 @@ type DataTypeEditorProps = PropsWithChildren<{
|
|
|
1207
1220
|
* Wrapper for editing a data type using Uniform Mesh SDK components that rely on `useRequest()`
|
|
1208
1221
|
* or `useVariables()`, or custom components that use the same hooks.
|
|
1209
1222
|
*/
|
|
1210
|
-
declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps):
|
|
1223
|
+
declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1211
1224
|
|
|
1212
1225
|
type MeshAppProps = {
|
|
1213
1226
|
loadingComponent?: React__default.ComponentType;
|
|
@@ -1228,7 +1241,7 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
|
|
|
1228
1241
|
/**
|
|
1229
1242
|
* @description The data refresh button is a UI component to indicate to users a request for data is taking place
|
|
1230
1243
|
* @example <DataRefreshButton buttonText="my button" isLoading /> */
|
|
1231
|
-
declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) =>
|
|
1244
|
+
declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1232
1245
|
|
|
1233
1246
|
type ObjectSearchContainerProps = {
|
|
1234
1247
|
/**
|
|
@@ -1255,7 +1268,7 @@ type ObjectSearchContainerProps = {
|
|
|
1255
1268
|
/**
|
|
1256
1269
|
* @description Object search container is an opinionated layout for search parameters and retrieved results
|
|
1257
1270
|
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
|
|
1258
|
-
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) =>
|
|
1271
|
+
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1259
1272
|
|
|
1260
1273
|
type ObjectSearchFilterProps = {
|
|
1261
1274
|
/** shows or hides the required content type select option */
|
|
@@ -1288,7 +1301,7 @@ type ObjectSearchFilterProps = {
|
|
|
1288
1301
|
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1289
1302
|
* that can be extended with custom functions
|
|
1290
1303
|
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
|
|
1291
|
-
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) =>
|
|
1304
|
+
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1292
1305
|
|
|
1293
1306
|
type ObjectSearchFilterContainerProps = {
|
|
1294
1307
|
/**
|
|
@@ -1303,7 +1316,7 @@ type ObjectSearchFilterContainerProps = {
|
|
|
1303
1316
|
* @description an opinionated layout for search filters
|
|
1304
1317
|
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1305
1318
|
*/
|
|
1306
|
-
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) =>
|
|
1319
|
+
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1307
1320
|
|
|
1308
1321
|
type SearchQueryProps<TExtraFilters = unknown> = {
|
|
1309
1322
|
/** sets the content type in the search context */
|
|
@@ -1391,7 +1404,7 @@ type ObjectSearchProviderProps = {
|
|
|
1391
1404
|
isMulti?: boolean;
|
|
1392
1405
|
defaultQuery?: SearchQueryProps;
|
|
1393
1406
|
};
|
|
1394
|
-
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) =>
|
|
1407
|
+
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1395
1408
|
declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
|
|
1396
1409
|
|
|
1397
1410
|
type ObjectSearchListItemProps = SelectedItemProps & {
|
|
@@ -1431,12 +1444,12 @@ type ObjectSearchListItemProps = SelectedItemProps & {
|
|
|
1431
1444
|
/**
|
|
1432
1445
|
* @description entry search list item is an opinionated UI component best used for initial retrieved results
|
|
1433
1446
|
* @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>) =>
|
|
1447
|
+
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
1448
|
/**
|
|
1436
1449
|
* An opinionated loading skeleton component best used with ObjectSearchListItem
|
|
1437
1450
|
* @example <ObjectSearchListItemLoadingSkeleton />
|
|
1438
1451
|
*/
|
|
1439
|
-
declare const ObjectSearchListItemLoadingSkeleton: () =>
|
|
1452
|
+
declare const ObjectSearchListItemLoadingSkeleton: () => _emotion_react_jsx_runtime.JSX.Element;
|
|
1440
1453
|
|
|
1441
1454
|
type ObjectSearchResultItemProps = SelectedItemProps & {
|
|
1442
1455
|
/** sets additional remove functionality onto of default removal */
|
|
@@ -1456,7 +1469,7 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
|
|
|
1456
1469
|
* @description An opinionated result item, best used for selected results
|
|
1457
1470
|
* @example <ObjectSearchResultItem id="my-result" title="title" />
|
|
1458
1471
|
*/
|
|
1459
|
-
declare const ObjectSearchResultItem: ({ id, title, name, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, }: ObjectSearchResultItemProps) =>
|
|
1472
|
+
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
1473
|
|
|
1461
1474
|
type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement> = HTMLAttributes<HTMLButtonElement>> = {
|
|
1462
1475
|
/** sets the button or link text value */
|
|
@@ -1470,13 +1483,13 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
|
|
|
1470
1483
|
* @description An opinionated button component best used within the ObjectSearchResultItem component
|
|
1471
1484
|
* @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
|
|
1472
1485
|
*/
|
|
1473
|
-
declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) =>
|
|
1486
|
+
declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1474
1487
|
/**
|
|
1475
1488
|
* @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
|
|
1476
1489
|
* that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
|
|
1477
1490
|
* @example <LinkButton text="link text" icon="/my-image.png" />
|
|
1478
1491
|
*/
|
|
1479
|
-
declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>,
|
|
1492
|
+
declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1480
1493
|
|
|
1481
1494
|
type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = SelectedItemProps> = {
|
|
1482
1495
|
/** sets the result label value
|
|
@@ -1520,7 +1533,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
|
|
|
1520
1533
|
* maintain drag and drop functionality
|
|
1521
1534
|
* @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
|
|
1522
1535
|
*/
|
|
1523
|
-
declare function ObjectSearchResultList<TRenderComponent extends SelectedItemProps = SelectedItemProps>({ resultLabelText, removeButtonText, onRemoveAllSelected, hideRemoveButton, resultLabelOverride, additionalButtons, renderResultComponent, multiSelectId, disableDnD, getContainerForDnDReparenting, whenNothingSelected, }: ObjectSearchResultListProps<TRenderComponent>):
|
|
1536
|
+
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
1537
|
|
|
1525
1538
|
type QueryFilterSearchProps = {
|
|
1526
1539
|
/** sets the count value */
|
|
@@ -1598,7 +1611,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
|
|
|
1598
1611
|
* @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
|
|
1599
1612
|
* @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
|
|
1600
1613
|
*/
|
|
1601
|
-
declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) =>
|
|
1614
|
+
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
1615
|
|
|
1603
1616
|
type ParamTypeDynamicDataProviderProps = {
|
|
1604
1617
|
/** Child components of the provider. Variables-using components, such as ParameterVariables, can be used here. */
|
|
@@ -1617,20 +1630,20 @@ type ParameterConnectOptions = {
|
|
|
1617
1630
|
* using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
|
|
1618
1631
|
* where a data resource variable could be a static value or bound to a dynamic input from the route (project map).
|
|
1619
1632
|
*/
|
|
1620
|
-
declare function ParamTypeDynamicDataProvider(props: ParamTypeDynamicDataProviderProps):
|
|
1633
|
+
declare function ParamTypeDynamicDataProvider(props: ParamTypeDynamicDataProviderProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1621
1634
|
|
|
1622
1635
|
/** Editor component to let you write a request body for POST requests */
|
|
1623
|
-
declare function RequestBody():
|
|
1636
|
+
declare function RequestBody(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1624
1637
|
|
|
1625
1638
|
/** Editor component to manage HTTP headers on a request */
|
|
1626
|
-
declare function RequestHeaders({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>):
|
|
1639
|
+
declare function RequestHeaders({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1627
1640
|
|
|
1628
1641
|
/** Dropdown to pick a HTTP method for a request */
|
|
1629
|
-
declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>):
|
|
1642
|
+
declare function RequestMethodSelect(props: Omit<InputSelectProps, 'value' | 'onChange' | 'options'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1630
1643
|
|
|
1631
1644
|
type RequestParametersProps = Pick<InputVariablesProps, 'disableVariables'>;
|
|
1632
1645
|
/** Component to manage query parameters on a request */
|
|
1633
|
-
declare function RequestParameters({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>):
|
|
1646
|
+
declare function RequestParameters({ disableVariables, addOmitIfEmpty, }: Pick<InputVariablesProps, 'disableVariables' | 'addOmitIfEmpty'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1634
1647
|
|
|
1635
1648
|
type RequestParameter = {
|
|
1636
1649
|
key: string;
|
|
@@ -1679,12 +1692,15 @@ type RequestAction = {
|
|
|
1679
1692
|
body: string;
|
|
1680
1693
|
contentType: string;
|
|
1681
1694
|
};
|
|
1695
|
+
type RequestActionContext = {
|
|
1696
|
+
dataSourceVariant?: DataSourceVariantsKeys;
|
|
1697
|
+
};
|
|
1682
1698
|
type RequestContext = {
|
|
1683
|
-
dispatch: (event: RequestAction) => void;
|
|
1699
|
+
dispatch: (event: RequestAction, ctx?: RequestActionContext) => void;
|
|
1684
1700
|
request: Readonly<RequestData>;
|
|
1685
1701
|
};
|
|
1686
1702
|
/** 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):
|
|
1703
|
+
declare function RequestProvider({ value, onChange, children }: RequestProviderProps): _emotion_react_jsx_runtime.JSX.Element;
|
|
1688
1704
|
declare function useRequest(): RequestContext;
|
|
1689
1705
|
|
|
1690
1706
|
type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
|
|
@@ -1700,18 +1716,18 @@ type RequestTypeContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
|
|
|
1700
1716
|
* <label>Name <input type="text" /></label>
|
|
1701
1717
|
* <label>Name <input type="text" /></label>
|
|
1702
1718
|
* </div> */
|
|
1703
|
-
declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) =>
|
|
1719
|
+
declare const RequestTypeContainer: ({ bgColor, children, ...props }: RequestTypeContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1704
1720
|
|
|
1705
1721
|
/**
|
|
1706
1722
|
* Displays the current full URL of the request, including the base URL if one is set
|
|
1707
1723
|
*/
|
|
1708
|
-
declare function RequestUrl():
|
|
1724
|
+
declare function RequestUrl(): _emotion_react_jsx_runtime.JSX.Element;
|
|
1709
1725
|
|
|
1710
1726
|
/**
|
|
1711
1727
|
* Editor to modify the current URL of the request
|
|
1712
1728
|
* Note: entering query string parameters automatically converts them and syncs the request state with them
|
|
1713
1729
|
*/
|
|
1714
|
-
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'> & Pick<InputVariablesProps, 'showAddVariableMenuOption' | 'enableEditingVariables'>):
|
|
1730
|
+
declare function RequestUrlInput(props: Omit<InputVariablesProps, 'value' | 'onChange'> & Pick<InputVariablesProps, 'showAddVariableMenuOption' | 'enableEditingVariables'>): _emotion_react_jsx_runtime.JSX.Element;
|
|
1715
1731
|
|
|
1716
1732
|
declare function urlEncodeRequestUrl(url: string, varValues?: Record<string, MeshDataVariableDefinition>): string;
|
|
1717
1733
|
declare function urlEncodeRequestParameter(parameter: RequestParameter, varValues?: Record<string, MeshDataVariableDefinition>): RequestParameter;
|
|
@@ -1772,14 +1788,45 @@ type InputOptionValue = {
|
|
|
1772
1788
|
type Operator = {
|
|
1773
1789
|
/** The label for the operator */
|
|
1774
1790
|
label: string;
|
|
1775
|
-
/** The
|
|
1791
|
+
/** The stored value for the operator */
|
|
1776
1792
|
value?: string;
|
|
1777
|
-
/** The symbol for the operator */
|
|
1778
|
-
symbol?: string;
|
|
1779
1793
|
/** The editor type for the operator */
|
|
1780
1794
|
options?: Array<InputOption>;
|
|
1781
1795
|
/** The editor type for the operator */
|
|
1782
1796
|
editorType?: FilterEditor;
|
|
1797
|
+
/**
|
|
1798
|
+
* Controls whether the operator's right-hand-side allows bound dynamic tokens.
|
|
1799
|
+
*
|
|
1800
|
+
* When false or unspecified: dynamic tokens are disallowed at all times.
|
|
1801
|
+
* When true: dynamic tokens are allowed when the `editorType` supports dynamic tokens
|
|
1802
|
+
*
|
|
1803
|
+
* NOTE: Operator-level bindable setting will override FilterOption-level setting, unless the operator bindable is undefined.
|
|
1804
|
+
*
|
|
1805
|
+
* When operators are switched from a bindable operator to a non-bindable operator, and the RH value has bindings, it will be cleared.
|
|
1806
|
+
*/
|
|
1807
|
+
bindable?: boolean;
|
|
1808
|
+
/**
|
|
1809
|
+
* The expected right-hand-side value type for the operator.
|
|
1810
|
+
* If not provided, the value can be any allowed type.
|
|
1811
|
+
*
|
|
1812
|
+
* When provided, tells the editor to expect a specific type. This information is used
|
|
1813
|
+
* to determine what to do when swapping between operators:
|
|
1814
|
+
*
|
|
1815
|
+
* - 'single': single value is expected, array value will be converted to single value, none value will be empty
|
|
1816
|
+
* - 'array': array value is expected, single value will be converted to one-element array value, none value will be empty
|
|
1817
|
+
* - 'between': two-element array value is expected, single value will be converted to first element of a two-element array
|
|
1818
|
+
* - 'none': no value is expected, incoming single and array values will be converted to empty value
|
|
1819
|
+
* - 'any other string': the value is hardcoded to this when switched to. It is cleared when switched away from.
|
|
1820
|
+
* - 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.
|
|
1821
|
+
*/
|
|
1822
|
+
expectedValueType: ('single' | 'array' | 'between' | 'none') | {} | undefined;
|
|
1823
|
+
};
|
|
1824
|
+
/** @deprecated beta - Filter option props */
|
|
1825
|
+
type FilterOptionLeftHandComponentProps = {
|
|
1826
|
+
deselectFilterOption: () => void;
|
|
1827
|
+
filterOption: FilterOption;
|
|
1828
|
+
filter: Filter;
|
|
1829
|
+
setFilterDynamicValue: ((dynamicValue: string | undefined) => void) | undefined;
|
|
1783
1830
|
};
|
|
1784
1831
|
/** @deprecated beta - Filter option props */
|
|
1785
1832
|
type FilterOption = {
|
|
@@ -1787,8 +1834,6 @@ type FilterOption = {
|
|
|
1787
1834
|
label: string;
|
|
1788
1835
|
/** The value for the option */
|
|
1789
1836
|
value: string;
|
|
1790
|
-
/** The options for the option */
|
|
1791
|
-
options?: FilterOption[];
|
|
1792
1837
|
/** The operator options for the option */
|
|
1793
1838
|
operatorOptions?: Operator[];
|
|
1794
1839
|
/** The value options for the option */
|
|
@@ -1797,13 +1842,41 @@ type FilterOption = {
|
|
|
1797
1842
|
readOnly?: boolean;
|
|
1798
1843
|
/** Set a disabled state on the input */
|
|
1799
1844
|
disabled?: boolean;
|
|
1800
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* Controls whether the filter's right-hand-side allows bound dynamic tokens.
|
|
1847
|
+
*
|
|
1848
|
+
* When false or unspecified: dynamic tokens are disallowed by default.
|
|
1849
|
+
* When true: dynamic tokens are allowed when the selected operator's `editorType` supports dynamic tokens
|
|
1850
|
+
*
|
|
1851
|
+
* NOTE: in most cases, one should set bindable on the operator level instead of the filter level.
|
|
1852
|
+
* Operator-level bindable setting will override FilterOption-level setting, unless the operator bindable is undefined.
|
|
1853
|
+
*/
|
|
1801
1854
|
bindable?: boolean;
|
|
1855
|
+
/** If value should be excluded from the sort options */
|
|
1856
|
+
excludeFromSort?: boolean;
|
|
1857
|
+
/**
|
|
1858
|
+
* Custom component that is rendered instead of the filter menu when this filter option is selected
|
|
1859
|
+
* Used to allow dynamic tokens to be set as a filter.
|
|
1860
|
+
*/
|
|
1861
|
+
leftHandSideComponentWhenSelected?: ComponentType<FilterOptionLeftHandComponentProps>;
|
|
1862
|
+
};
|
|
1863
|
+
/** @deprecated beta - Filter option props */
|
|
1864
|
+
type FilterOptionGroup = {
|
|
1865
|
+
/** The label for the option group */
|
|
1866
|
+
label: string;
|
|
1867
|
+
/** Value for the option group. Should be unique, not stored. */
|
|
1868
|
+
value: string;
|
|
1869
|
+
/** The options for the option */
|
|
1870
|
+
options?: FilterOption[];
|
|
1802
1871
|
};
|
|
1803
1872
|
/** @deprecated beta - Filter selected and query value props */
|
|
1804
1873
|
type Filter = {
|
|
1805
1874
|
/** The field value selected */
|
|
1806
1875
|
field: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* If a field allows for dynamic variations of itself, such as bindings, this stores the dynamic value
|
|
1878
|
+
*/
|
|
1879
|
+
dynamicField?: string;
|
|
1807
1880
|
/** The operator value selected */
|
|
1808
1881
|
operator: string;
|
|
1809
1882
|
/** The value selected */
|
|
@@ -1839,7 +1912,7 @@ declare const TEXTBOX_OPERATORS: OperatorType;
|
|
|
1839
1912
|
/** @deprecated beta - uniform user operators */
|
|
1840
1913
|
declare const USER_OPERATORS: OperatorType;
|
|
1841
1914
|
/** @deprecated beta - uniform system date operators */
|
|
1842
|
-
declare const
|
|
1915
|
+
declare const DATE_TIME_OPERATORS: OperatorType;
|
|
1843
1916
|
/** @deprecated beta - uniform rich text operators */
|
|
1844
1917
|
declare const RICHTEXT_OPERATORS: OperatorType;
|
|
1845
1918
|
/** @deprecated beta - uniform checkbox operators */
|
|
@@ -1859,60 +1932,60 @@ declare const MULTI_SELECT_OPERATORS: OperatorType;
|
|
|
1859
1932
|
* @deprecated beta - Renders a date input field for filtering
|
|
1860
1933
|
* @example <DateEditor ariaLabel="Date" value={value} onChange={onChange} />
|
|
1861
1934
|
*/
|
|
1862
|
-
declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1935
|
+
declare const DateEditor: ({ onChange, ariaLabel, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1863
1936
|
|
|
1864
1937
|
/**
|
|
1865
1938
|
* @deprecated beta - Renders a date range input field for filtering
|
|
1866
1939
|
* @example <DateRangeEditor ariaLabel="Date Range" value={value} onChange={onChange} />
|
|
1867
1940
|
*/
|
|
1868
|
-
declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1941
|
+
declare const DateRangeEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1869
1942
|
|
|
1870
1943
|
/**
|
|
1871
1944
|
* @deprecated beta - Multie select filter component
|
|
1872
1945
|
* @example <FilterMultiChoiceEditor options={options} value={options.filter((option) => values.includes(option.value)} onChange={(e) => onChange(e.map((option) => option.value))} />
|
|
1873
1946
|
*/
|
|
1874
|
-
declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) =>
|
|
1947
|
+
declare const FilterMultiChoiceEditor: ({ value, options, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1875
1948
|
|
|
1876
1949
|
/**
|
|
1877
1950
|
* @deprecated beta - Single select filter component
|
|
1878
1951
|
* @example <FilterSingleChoiceEditor options={options} value={options.find((option) => values.includes(option.value)} onChange={(e) => onChange(e.value)} />
|
|
1879
1952
|
*/
|
|
1880
|
-
declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1953
|
+
declare const FilterSingleChoiceEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1881
1954
|
|
|
1882
1955
|
/**
|
|
1883
1956
|
* @deprecated beta - Renders a number input field for filtering
|
|
1884
1957
|
* @example <NumberEditor ariaLabel="Number" value={value} onChange={onChange} />
|
|
1885
1958
|
*/
|
|
1886
|
-
declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1959
|
+
declare const NumberEditor: ({ ariaLabel, onChange, disabled, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1887
1960
|
|
|
1888
1961
|
/**
|
|
1889
1962
|
* @deprecated beta - Renders a number range input field for filtering
|
|
1890
1963
|
* @example <NumberRangeEditor ariaLabel="Number Range" value={value} onChange={onChange} />
|
|
1891
1964
|
*/
|
|
1892
|
-
declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1965
|
+
declare const NumberRangeEditor: ({ onChange, disabled, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1893
1966
|
|
|
1894
1967
|
/**
|
|
1895
1968
|
* @deprecated beta - Status multi select filter component that renders a custom dropdown menu
|
|
1896
1969
|
* @example <StatusMultiEditor options={options} value={value} onChange={onChange} />
|
|
1897
1970
|
*/
|
|
1898
|
-
declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string[]>) =>
|
|
1971
|
+
declare const StatusMultiEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1899
1972
|
|
|
1900
1973
|
/**
|
|
1901
1974
|
* @deprecated beta - Status single select filter component that renders a custom dropdown menu
|
|
1902
1975
|
* @example <StatusSingleEditor options={options} value={value} onChange={onChange} />
|
|
1903
1976
|
*/
|
|
1904
|
-
declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1977
|
+
declare const StatusSingleEditor: ({ options, value, disabled, readOnly, onChange, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1905
1978
|
|
|
1906
1979
|
/**
|
|
1907
1980
|
* @deprecated beta - Renders a text input field for filtering
|
|
1908
1981
|
* @example <TextEditor ariaLabel="Search" value={value} onChange={onChange} />
|
|
1909
1982
|
*/
|
|
1910
|
-
declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) =>
|
|
1983
|
+
declare const TextEditor: ({ onChange, ariaLabel, value, readOnly, valueTestId, }: FilterEditorRendererProps<string>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1911
1984
|
|
|
1912
1985
|
/**
|
|
1913
1986
|
* @deprecated beta - Text value multi select filter component
|
|
1914
1987
|
*/
|
|
1915
|
-
declare const TextMultiChoiceEditor: ({ value, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) =>
|
|
1988
|
+
declare const TextMultiChoiceEditor: ({ value, disabled, readOnly, valueTestId, ...props }: FilterEditorRendererProps<string[]>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1916
1989
|
|
|
1917
1990
|
/** @description beta - filter button type */
|
|
1918
1991
|
type FilterButtonProps = {
|
|
@@ -1930,12 +2003,14 @@ type FilterButtonProps = {
|
|
|
1930
2003
|
hasSelectedValue?: boolean;
|
|
1931
2004
|
/** sets the data-testid attribute on the button */
|
|
1932
2005
|
dataTestId?: string;
|
|
1933
|
-
|
|
2006
|
+
/** sets whether to show the dropdown icon, we do not recommend using this option when filterCount is enabled */
|
|
2007
|
+
showDropdownIcon?: boolean;
|
|
2008
|
+
} & ButtonHTMLAttributes<HTMLButtonElement>;
|
|
1934
2009
|
/**
|
|
1935
2010
|
* @deprecated beta - A filter button component used to display filter menu options
|
|
1936
2011
|
* @example <FilterButton text="Filters" filterCount={3} />
|
|
1937
2012
|
*/
|
|
1938
|
-
declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, ...props }: FilterButtonProps) =>
|
|
2013
|
+
declare const FilterButton: ({ text, icon, filterCount, hasSelectedValue, dataTestId, showDropdownIcon, ...props }: FilterButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1939
2014
|
|
|
1940
2015
|
/**
|
|
1941
2016
|
* @deprecated beta - Default filter controls for search and filter
|
|
@@ -1945,24 +2020,49 @@ declare const FilterControls: ({ children, hideSearchInput, }: {
|
|
|
1945
2020
|
/** optional param to allow you to add your own controls */
|
|
1946
2021
|
children?: ReactNode;
|
|
1947
2022
|
/** optional param to hide the search input */
|
|
1948
|
-
hideSearchInput?: boolean
|
|
1949
|
-
}) =>
|
|
2023
|
+
hideSearchInput?: boolean;
|
|
2024
|
+
}) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1950
2025
|
|
|
1951
2026
|
/**
|
|
1952
2027
|
* @deprecated beta - Renders a filter editor component
|
|
1953
2028
|
* @example <FilterEditorRenderer editorType="multiChoice" options={options} value={value} onChange={onChange} />
|
|
1954
2029
|
*/
|
|
1955
|
-
declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps<never>) =>
|
|
2030
|
+
declare const FilterEditorRenderer: ({ editorType, ...props }: FilterEditorRendererProps<never>) => _emotion_react_jsx_runtime.JSX.Element;
|
|
1956
2031
|
/** @deprecated beta - A mapper for filter editor components */
|
|
1957
2032
|
declare const filterMapper: Record<FilterEditor, ComponentType<FilterEditorRendererProps<any>> | null>;
|
|
1958
2033
|
declare const bindableFiltersMapper: typeof filterMapper;
|
|
1959
2034
|
|
|
2035
|
+
type FilterItemProps = {
|
|
2036
|
+
/** the index of the filter row */
|
|
2037
|
+
index: number;
|
|
2038
|
+
/** function to trigger filter change events */
|
|
2039
|
+
onFilterOptionChange: (newFilter: string) => void;
|
|
2040
|
+
/** Called when a custom LHS component sets a dynamic filter value */
|
|
2041
|
+
onFilterDynamicChange?: (newFilterDynamic: string | undefined) => void;
|
|
2042
|
+
/** the list of operator options for each filter row */
|
|
2043
|
+
operatorOptions: Operator[];
|
|
2044
|
+
/** function to trigger operator change events */
|
|
2045
|
+
onOperatorChange: (newOperator: string) => void;
|
|
2046
|
+
/** function to trigger value change events */
|
|
2047
|
+
onValueChange: (newValue: string | string[]) => void;
|
|
2048
|
+
/** the list of value options for each filter row */
|
|
2049
|
+
valueOptions: InputOption[];
|
|
2050
|
+
/** Sets the title before the first criteria (i.e. "When", "Where") */
|
|
2051
|
+
initialCriteriaTitle?: string;
|
|
2052
|
+
/** How multiple criteria are joined together */
|
|
2053
|
+
criteriaGroupOperator?: 'and' | 'or';
|
|
2054
|
+
};
|
|
2055
|
+
/** @deprecated beta - A filter item component used to display filter options */
|
|
2056
|
+
declare const FilterItem: ({ index, operatorOptions, valueOptions, onFilterOptionChange, onFilterDynamicChange, onOperatorChange, onValueChange, initialCriteriaTitle, criteriaGroupOperator, }: FilterItemProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2057
|
+
|
|
1960
2058
|
type FilterMapper = Record<string, ComponentType<any> | null>;
|
|
1961
2059
|
type SearchAndFilterProviderProps = {
|
|
1962
2060
|
/** sets the filter values */
|
|
1963
2061
|
filters: Filter[];
|
|
1964
|
-
/** sets the filter visibility */
|
|
2062
|
+
/** sets the initial filter visibility */
|
|
1965
2063
|
filterVisible?: boolean;
|
|
2064
|
+
/** makes the filter UI always visible no matter what (ignores filterVisible, and subsequent internal visibility changes) */
|
|
2065
|
+
alwaysVisible?: boolean;
|
|
1966
2066
|
/** function to trigger search change event */
|
|
1967
2067
|
onSearchChange?: (term: string) => void;
|
|
1968
2068
|
/** function to trigger filter change events */
|
|
@@ -1974,7 +2074,7 @@ type SearchAndFilterProviderProps = {
|
|
|
1974
2074
|
*/
|
|
1975
2075
|
resetFilterValues?: Filter[];
|
|
1976
2076
|
/** sets the list of filter options for each filter row */
|
|
1977
|
-
filterOptions:
|
|
2077
|
+
filterOptions: FilterOptionGroup[];
|
|
1978
2078
|
/** the total number of results */
|
|
1979
2079
|
totalResults?: number;
|
|
1980
2080
|
/** the filter mapper function */
|
|
@@ -2004,7 +2104,7 @@ type SearchAndFilterContextProps = {
|
|
|
2004
2104
|
/** function that deletes a row and it's values visually and from state */
|
|
2005
2105
|
handleDeleteFilter: (index: number) => void;
|
|
2006
2106
|
/** sets the initial list of filter options */
|
|
2007
|
-
filterOptions:
|
|
2107
|
+
filterOptions: FilterOptionGroup[];
|
|
2008
2108
|
/** a valid list of valid filter options */
|
|
2009
2109
|
validFilterQuery: Filter[] | undefined;
|
|
2010
2110
|
/** a component list to map filter options */
|
|
@@ -2019,7 +2119,7 @@ declare const SearchAndFilterContext: React$1.Context<SearchAndFilterContextProp
|
|
|
2019
2119
|
* @deprecated beta - Search and filter provider
|
|
2020
2120
|
* @example <SearchAndFilterProvider filters={filters} filterOptions={filterOptions} onSearchChange={onSearchChange} onChange={onChange}>Children</SearchAndFilterProvider>
|
|
2021
2121
|
* */
|
|
2022
|
-
declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) =>
|
|
2122
|
+
declare const SearchAndFilterProvider: ({ filters, filterOptions, filterVisible, alwaysVisible, defaultSearchTerm, onSearchChange, onChange, resetFilterValues, totalResults, filterMapper, children, allowBindingSearchTerm, }: SearchAndFilterProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2023
2123
|
/** @deprecated beta - Search and filter hook
|
|
2024
2124
|
* @example const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();
|
|
2025
2125
|
*/
|
|
@@ -2029,7 +2129,7 @@ declare const useSearchAndFilter: () => {
|
|
|
2029
2129
|
/** sets the search term value */
|
|
2030
2130
|
setSearchTerm: (term: string) => void;
|
|
2031
2131
|
/** current filter visibility */
|
|
2032
|
-
filterVisibility?: boolean
|
|
2132
|
+
filterVisibility?: boolean;
|
|
2033
2133
|
/** sets the filter visibility */
|
|
2034
2134
|
setFilterVisibility: (visible: boolean) => void;
|
|
2035
2135
|
/** sets the initial filters */
|
|
@@ -2043,15 +2143,15 @@ declare const useSearchAndFilter: () => {
|
|
|
2043
2143
|
/** function that deletes a row and it's values visually and from state */
|
|
2044
2144
|
handleDeleteFilter: (index: number) => void;
|
|
2045
2145
|
/** sets the initial list of filter options */
|
|
2046
|
-
filterOptions:
|
|
2146
|
+
filterOptions: FilterOptionGroup[];
|
|
2047
2147
|
/** a valid list of valid filter options */
|
|
2048
2148
|
validFilterQuery: Filter[] | undefined;
|
|
2049
2149
|
/** a component list to map filter options */
|
|
2050
|
-
filterMapper?: FilterMapper
|
|
2150
|
+
filterMapper?: FilterMapper;
|
|
2051
2151
|
/** the total number of results */
|
|
2052
|
-
totalResults?: number
|
|
2152
|
+
totalResults?: number;
|
|
2053
2153
|
/** Allow to bind dynamic inputs to the search term */
|
|
2054
|
-
allowBindingSearchTerm?: boolean
|
|
2154
|
+
allowBindingSearchTerm?: boolean;
|
|
2055
2155
|
};
|
|
2056
2156
|
|
|
2057
2157
|
type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
|
|
@@ -2082,37 +2182,17 @@ type SearchAndFilterProps = Omit<SearchAndFilterProviderProps, 'children'> & {
|
|
|
2082
2182
|
* @deprecated beta - Search and filter component
|
|
2083
2183
|
* @example <SearchAndFilter filters={filters} filterOptions={filterOptions} onChange={onChange} onSearchChange={onSearchChange} onSearchReset={onSearchReset} totalResults={totalResults} />
|
|
2084
2184
|
* */
|
|
2085
|
-
declare const SearchAndFilter: ({ filters, filterOptions, filterVisible, filterControls, viewSwitchControls, resultsContainerView, filterMapper, additionalFiltersContainer, onChange, defaultSearchTerm, onSearchChange, totalResults, allowBindingSearchTerm, resetFilterValues, }: SearchAndFilterProps) =>
|
|
2185
|
+
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
2186
|
|
|
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
2187
|
type FilterItemsProps = {
|
|
2107
2188
|
/** The text for the add button */
|
|
2108
2189
|
addButtonText?: string;
|
|
2109
2190
|
additionalFiltersContainer: SearchAndFilterProps['additionalFiltersContainer'];
|
|
2110
2191
|
filterTitle?: string;
|
|
2111
2192
|
resetButtonText?: string;
|
|
2112
|
-
|
|
2113
|
-
};
|
|
2193
|
+
} & Pick<FilterItemProps, 'initialCriteriaTitle' | 'criteriaGroupOperator'>;
|
|
2114
2194
|
/** @deprecated beta - A filter items component used to display filter options */
|
|
2115
|
-
declare const FilterItems: ({ addButtonText, additionalFiltersContainer, filterTitle, resetButtonText, initialCriteriaTitle, }: FilterItemsProps) =>
|
|
2195
|
+
declare const FilterItems: ({ addButtonText, additionalFiltersContainer, filterTitle, resetButtonText, initialCriteriaTitle, criteriaGroupOperator, }: FilterItemsProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2116
2196
|
|
|
2117
2197
|
type SearchAndFilterOptionsContainerProps = {
|
|
2118
2198
|
/** The button row to be displayed at the bottom of the container */
|
|
@@ -2125,7 +2205,7 @@ type SearchAndFilterOptionsContainerProps = {
|
|
|
2125
2205
|
* @deprecated beta - A container component for search and filter options
|
|
2126
2206
|
* @example <SearchAndFilterOptionsContainer buttonRow={<button>Button</button>}>Children</SearchAndFilterOptionsContainer>
|
|
2127
2207
|
* */
|
|
2128
|
-
declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) =>
|
|
2208
|
+
declare const SearchAndFilterOptionsContainer: ({ buttonRow, additionalFiltersContainer, children, }: SearchAndFilterOptionsContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2129
2209
|
type FiltersProps = {
|
|
2130
2210
|
/** The id of the filter menu */
|
|
2131
2211
|
id: string;
|
|
@@ -2147,7 +2227,7 @@ type FiltersProps = {
|
|
|
2147
2227
|
* @deprecated beta - A filter menu component used to display filter options
|
|
2148
2228
|
* @example <FilterMenu id="search-and-filter-options">Children</FilterMenu>
|
|
2149
2229
|
* */
|
|
2150
|
-
declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) =>
|
|
2230
|
+
declare const FilterMenu: ({ id, filterTitle, menuControls, additionalFiltersContainer, children, dataTestId, resetButtonText, }: FiltersProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2151
2231
|
|
|
2152
2232
|
type SearchAndFilterResultContainerProps = {
|
|
2153
2233
|
/** The label for the clear button
|
|
@@ -2166,7 +2246,7 @@ type SearchAndFilterResultContainerProps = {
|
|
|
2166
2246
|
hideClearButton?: boolean;
|
|
2167
2247
|
};
|
|
2168
2248
|
/** @deprecated beta - Search and filter results container */
|
|
2169
|
-
declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) =>
|
|
2249
|
+
declare const SearchAndFilterResultContainer: ({ buttonText, clearButtonLabel, calloutTitle, calloutText, onHandleClear, hideClearButton, }: SearchAndFilterResultContainerProps) => _emotion_react_jsx_runtime.JSX.Element | null;
|
|
2170
2250
|
|
|
2171
2251
|
declare const SearchOnlyContext: React$1.Context<Pick<SearchAndFilterContextProps, "searchTerm" | "setSearchTerm">>;
|
|
2172
2252
|
type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChange'> & {
|
|
@@ -2175,7 +2255,7 @@ type SearchOnlyProviderProps = Pick<SearchAndFilterProviderProps, 'onSearchChang
|
|
|
2175
2255
|
*/
|
|
2176
2256
|
maxWidth?: string;
|
|
2177
2257
|
};
|
|
2178
|
-
declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) =>
|
|
2258
|
+
declare const SearchOnlyFilter: ({ onSearchChange, maxWidth }: SearchOnlyProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2179
2259
|
|
|
2180
2260
|
type SortItemsProps = {
|
|
2181
2261
|
/** The label for the sort by field
|
|
@@ -2187,7 +2267,7 @@ type SortItemsProps = {
|
|
|
2187
2267
|
*/
|
|
2188
2268
|
localeLabel?: string;
|
|
2189
2269
|
/** sets the list of sort options */
|
|
2190
|
-
sortOptions:
|
|
2270
|
+
sortOptions: FilterOptionGroup[];
|
|
2191
2271
|
/** the default sort by value */
|
|
2192
2272
|
sortByValue?: string;
|
|
2193
2273
|
/** function to trigger sort change events */
|
|
@@ -2207,7 +2287,7 @@ type SortItemsProps = {
|
|
|
2207
2287
|
/**
|
|
2208
2288
|
Copy of Design System <SortItems > component with ability to bind variables to inputs.
|
|
2209
2289
|
*/
|
|
2210
|
-
declare const SortItems: ({ sortByLabel, localeLabel, sortOptions, sortByValue, onSortChange, localeValue, localeOptions, onLocaleChange, disableSortBinding, }: SortItemsProps) =>
|
|
2290
|
+
declare const SortItems: ({ sortByLabel, localeLabel, sortOptions, sortByValue, onSortChange, localeValue, localeOptions, onLocaleChange, disableSortBinding, }: SortItemsProps) => _emotion_react_jsx_runtime.JSX.Element;
|
|
2211
2291
|
|
|
2212
2292
|
/** Converts connected data map into VariablesProvider-format variables */
|
|
2213
2293
|
declare function useConnectedDataAsVariables(connectedData: Record<string, unknown> | undefined): Record<string, MeshDataVariableDefinition>;
|
|
@@ -2260,4 +2340,4 @@ type ContentDataResourceLocaleInfoProps = {
|
|
|
2260
2340
|
};
|
|
2261
2341
|
declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
|
|
2262
2342
|
|
|
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
|
|
2343
|
+
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 };
|