@uniformdev/mesh-sdk-react 19.136.1-alpha.4 → 19.138.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +51 -107
- package/dist/index.d.ts +51 -107
- package/dist/index.esm.js +305 -463
- package/dist/index.js +388 -552
- package/dist/index.mjs +305 -463
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -391,8 +391,6 @@ type DataResourceDynamicInputProviderProps = {
|
|
|
391
391
|
/** Child components of the provider. Variables-using components, such as InputVariables, can be used here. */
|
|
392
392
|
children: ReactNode;
|
|
393
393
|
};
|
|
394
|
-
declare const DataResourceInputContext: React$1.Context<DynamicInputs | undefined>;
|
|
395
|
-
declare const useDataResourceDynamicInputs: () => DynamicInputs | undefined;
|
|
396
394
|
/**
|
|
397
395
|
* Wrapper for data resource locations. Provides read-only access to dynamic inputs as if they were variables,
|
|
398
396
|
* using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
|
|
@@ -1206,11 +1204,57 @@ type ObjectSearchContainerProps = {
|
|
|
1206
1204
|
};
|
|
1207
1205
|
/**
|
|
1208
1206
|
* @description Object search container is an opinionated layout for search parameters and retrieved results
|
|
1209
|
-
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
|
|
1210
|
-
* @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
|
|
1211
|
-
*/
|
|
1207
|
+
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
|
|
1212
1208
|
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1213
1209
|
|
|
1210
|
+
type ObjectSearchFilterProps = {
|
|
1211
|
+
/** shows or hides the required content type select option */
|
|
1212
|
+
requireContentType?: boolean;
|
|
1213
|
+
/** sets the text for the required content type select option
|
|
1214
|
+
* @default 'All content types'
|
|
1215
|
+
*/
|
|
1216
|
+
typeSelectorAllTypesOptionText?: string;
|
|
1217
|
+
/** sets the select input value label text
|
|
1218
|
+
* @default 'Content Type Select'
|
|
1219
|
+
*/
|
|
1220
|
+
selectLabel?: string;
|
|
1221
|
+
/** sets the select input options, if empty - only keyword search field will be rendered */
|
|
1222
|
+
selectOptions?: Array<{
|
|
1223
|
+
id?: string;
|
|
1224
|
+
name?: string;
|
|
1225
|
+
label: string;
|
|
1226
|
+
value?: string;
|
|
1227
|
+
}>;
|
|
1228
|
+
/** sets the search input name value
|
|
1229
|
+
* @default 'searchText'
|
|
1230
|
+
*/
|
|
1231
|
+
searchInputName?: string;
|
|
1232
|
+
/** sets the search input placeholder text
|
|
1233
|
+
* @default 'Enter keyword to narrow your results'
|
|
1234
|
+
*/
|
|
1235
|
+
searchInputPlaceholderText?: string;
|
|
1236
|
+
};
|
|
1237
|
+
/**
|
|
1238
|
+
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1239
|
+
* that can be extended with custom functions
|
|
1240
|
+
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
|
|
1241
|
+
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1242
|
+
|
|
1243
|
+
type ObjectSearchFilterContainerProps = {
|
|
1244
|
+
/**
|
|
1245
|
+
* sets the title for the container
|
|
1246
|
+
* @deprecated we recommend setting the label on ObjectSearchContainer instead
|
|
1247
|
+
*/
|
|
1248
|
+
label?: string;
|
|
1249
|
+
/** sets child components in an opinionated layout */
|
|
1250
|
+
children?: React.ReactNode;
|
|
1251
|
+
};
|
|
1252
|
+
/**
|
|
1253
|
+
* @description an opinionated layout for search filters
|
|
1254
|
+
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1255
|
+
*/
|
|
1256
|
+
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1257
|
+
|
|
1214
1258
|
type SearchQueryProps<TExtraFilters = unknown> = {
|
|
1215
1259
|
/** sets the content type in the search context */
|
|
1216
1260
|
contentType?: string;
|
|
@@ -1218,7 +1262,6 @@ type SearchQueryProps<TExtraFilters = unknown> = {
|
|
|
1218
1262
|
keyword?: string;
|
|
1219
1263
|
/** sets the locale in the search context */
|
|
1220
1264
|
locale?: string;
|
|
1221
|
-
dynamicEntryId?: string;
|
|
1222
1265
|
} & TExtraFilters;
|
|
1223
1266
|
type SelectedItemProps<TExtraProps = unknown> = {
|
|
1224
1267
|
/** sets the id value */
|
|
@@ -1288,97 +1331,18 @@ type ObjectSearchContextProps<TExtraFilters = unknown, TExtraItemProps = unknown
|
|
|
1288
1331
|
/** current list of results in state */
|
|
1289
1332
|
list: ItemListProps<TExtraItemProps>;
|
|
1290
1333
|
/** function that sets the list of items to state */
|
|
1291
|
-
onSetList
|
|
1334
|
+
onSetList: (value: ItemListProps) => void;
|
|
1292
1335
|
/** is multi items selection allowed or not */
|
|
1293
1336
|
isMulti: boolean;
|
|
1294
|
-
localeOptions?: {
|
|
1295
|
-
label: string;
|
|
1296
|
-
value: string;
|
|
1297
|
-
}[];
|
|
1298
|
-
enableFilterByLocale?: boolean;
|
|
1299
|
-
isListLoading?: boolean;
|
|
1300
|
-
isSelectedItemsListLoading?: boolean;
|
|
1301
|
-
dynamicEntryId?: string;
|
|
1302
1337
|
};
|
|
1303
|
-
declare const ObjectSearchContext: React$1.Context<ObjectSearchContextProps<unknown, unknown>>;
|
|
1304
1338
|
type ObjectSearchProviderProps = {
|
|
1305
1339
|
children: ReactNode;
|
|
1306
1340
|
currentlySelectedItems?: Array<SelectedItemProps>;
|
|
1307
|
-
searchResultList?: Array<SelectedItemProps>;
|
|
1308
1341
|
isMulti?: boolean;
|
|
1309
1342
|
defaultQuery?: SearchQueryProps;
|
|
1310
1343
|
};
|
|
1311
|
-
/**
|
|
1312
|
-
* @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
|
|
1313
|
-
*/
|
|
1314
1344
|
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1315
1345
|
declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
|
|
1316
|
-
declare function bindQuery(query: SearchQueryProps, inputs: Record<string, unknown>): {
|
|
1317
|
-
/** sets the content type in the search context */
|
|
1318
|
-
contentType?: string | undefined;
|
|
1319
|
-
/** sets the keyword search in the search context */
|
|
1320
|
-
keyword?: string | undefined;
|
|
1321
|
-
/** sets the locale in the search context */
|
|
1322
|
-
locale?: string | undefined;
|
|
1323
|
-
dynamicEntryId?: string | undefined;
|
|
1324
|
-
};
|
|
1325
|
-
|
|
1326
|
-
type ObjectSearchFilterProps = {
|
|
1327
|
-
/** shows or hides the required content type select option */
|
|
1328
|
-
requireContentType?: boolean;
|
|
1329
|
-
/** sets the text for the required content type select option
|
|
1330
|
-
* @default 'All content types'
|
|
1331
|
-
*/
|
|
1332
|
-
typeSelectorAllTypesOptionText?: string;
|
|
1333
|
-
/** sets the select input value label text
|
|
1334
|
-
* @default 'Content Type Select'
|
|
1335
|
-
*/
|
|
1336
|
-
selectLabel?: string;
|
|
1337
|
-
/** sets the select input options, if empty - only keyword search field will be rendered */
|
|
1338
|
-
selectOptions?: Array<{
|
|
1339
|
-
id?: string;
|
|
1340
|
-
name?: string;
|
|
1341
|
-
label: string;
|
|
1342
|
-
value?: string;
|
|
1343
|
-
}>;
|
|
1344
|
-
/** sets the search input name value
|
|
1345
|
-
* @default 'searchText'
|
|
1346
|
-
*/
|
|
1347
|
-
searchInputName?: string;
|
|
1348
|
-
/** sets the search input placeholder text
|
|
1349
|
-
* @default 'Enter keyword to narrow your results'
|
|
1350
|
-
*/
|
|
1351
|
-
searchInputPlaceholderText?: string;
|
|
1352
|
-
/** sets the label for the locale selectbox filter */
|
|
1353
|
-
localeFilterLabel?: string;
|
|
1354
|
-
/** sets the locale options for the locale selectbox filter */
|
|
1355
|
-
localeOptions?: ObjectSearchContextProps['localeOptions'];
|
|
1356
|
-
/** enables or disables the locale filter */
|
|
1357
|
-
enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
|
|
1358
|
-
};
|
|
1359
|
-
/**
|
|
1360
|
-
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1361
|
-
* that can be extended with custom functions
|
|
1362
|
-
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
|
|
1363
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1364
|
-
*/
|
|
1365
|
-
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, localeFilterLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1366
|
-
|
|
1367
|
-
type ObjectSearchFilterContainerProps = {
|
|
1368
|
-
/**
|
|
1369
|
-
* sets the title for the container
|
|
1370
|
-
* @deprecated we recommend setting the label on ObjectSearchContainer instead
|
|
1371
|
-
*/
|
|
1372
|
-
label?: string;
|
|
1373
|
-
/** sets child components in an opinionated layout */
|
|
1374
|
-
children?: React.ReactNode;
|
|
1375
|
-
};
|
|
1376
|
-
/**
|
|
1377
|
-
* @description an opinionated layout for search filters
|
|
1378
|
-
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1379
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1380
|
-
*/
|
|
1381
|
-
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1382
1346
|
|
|
1383
1347
|
type ObjectSearchListItemProps = SelectedItemProps & {
|
|
1384
1348
|
/** sets the content type value, this is normally used for subtitles e.g. Kitchens */
|
|
@@ -1583,29 +1547,9 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
|
|
|
1583
1547
|
/**
|
|
1584
1548
|
* @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
|
|
1585
1549
|
* @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
|
|
1586
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1587
1550
|
*/
|
|
1588
1551
|
declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1589
1552
|
|
|
1590
|
-
declare function ObjectSearchListOfSearchResults(): _emotion_react_types_jsx_namespace.EmotionJSX.Element | _emotion_react_types_jsx_namespace.EmotionJSX.Element[] | undefined;
|
|
1591
|
-
|
|
1592
|
-
type ControlledObjectSearchProviderProps = {
|
|
1593
|
-
children: ReactNode;
|
|
1594
|
-
selectedItems: Array<SelectedItemProps> | undefined;
|
|
1595
|
-
searchResultItems: Array<SelectedItemProps> | undefined;
|
|
1596
|
-
selectedItemsLoading?: boolean;
|
|
1597
|
-
searchResultItemsLoading?: boolean;
|
|
1598
|
-
searchResultListLoading?: boolean;
|
|
1599
|
-
onQueryChange: (value: SearchQueryProps) => void;
|
|
1600
|
-
onSelectItemsChange: (selectedItems: Array<SelectedItemProps>) => void;
|
|
1601
|
-
isMulti?: boolean;
|
|
1602
|
-
query: SearchQueryProps;
|
|
1603
|
-
localeOptions?: ObjectSearchContextProps['localeOptions'];
|
|
1604
|
-
enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
|
|
1605
|
-
dynamicEntryId?: ObjectSearchContextProps['dynamicEntryId'];
|
|
1606
|
-
};
|
|
1607
|
-
declare const ControlledObjectSearchProvider: ({ selectedItems, searchResultItems, selectedItemsLoading, searchResultListLoading, searchResultItemsLoading, onQueryChange, onSelectItemsChange, isMulti, children, query, enableFilterByLocale, localeOptions, dynamicEntryId, }: ControlledObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1608
|
-
|
|
1609
1553
|
type ParamTypeDynamicDataProviderProps = {
|
|
1610
1554
|
/** Child components of the provider. Variables-using components, such as ParameterVariables, can be used here. */
|
|
1611
1555
|
children: ReactNode;
|
|
@@ -1842,4 +1786,4 @@ type ContentDataResourceLocaleInfoProps = {
|
|
|
1842
1786
|
};
|
|
1843
1787
|
declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
|
|
1844
1788
|
|
|
1845
|
-
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult,
|
|
1789
|
+
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledValuePlugin, 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, 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 GetProductOptions, type GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, InputVariables, type InputVariablesProps, type InsertVariableCommandArguments, type ItemListProps, type KnownUndefinedVariableInfo, LinkButton, MeshApp, type MeshAppProps, type MeshDataVariableDefinition, type NoResultsProps, OPEN_INSERT_VARIABLE_COMMAND, 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, 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, type RequestAction, RequestBody, type RequestContext, type RequestData, RequestHeaders, RequestMethodSelect, type RequestParameter, RequestParameters, type RequestParametersProps, RequestProvider, type RequestProviderProps, RequestTypeContainer, type RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, type SearchQueryProps, type SelectedItemProps, SelectionField, type SelectionFieldValue, type SerializedVariableNode, type SetLocationValueDispatch, type SetLocationValueFunction, TextVariableRenderer, type UseVariablesMenu, type UseVariablesMenuInput, 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, 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, serializeVariablesEditorState, setVariablesEditorValue, urlEncodeRequestParameter, urlEncodeRequestUrl, useConnectedDataAsVariables, useContentDataResourceLocaleInfo, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
|
package/dist/index.d.ts
CHANGED
|
@@ -391,8 +391,6 @@ type DataResourceDynamicInputProviderProps = {
|
|
|
391
391
|
/** Child components of the provider. Variables-using components, such as InputVariables, can be used here. */
|
|
392
392
|
children: ReactNode;
|
|
393
393
|
};
|
|
394
|
-
declare const DataResourceInputContext: React$1.Context<DynamicInputs | undefined>;
|
|
395
|
-
declare const useDataResourceDynamicInputs: () => DynamicInputs | undefined;
|
|
396
394
|
/**
|
|
397
395
|
* Wrapper for data resource locations. Provides read-only access to dynamic inputs as if they were variables,
|
|
398
396
|
* using variables-aware components (i.e. InputVariables). This simplifies building dynamic-input-aware editors,
|
|
@@ -1206,11 +1204,57 @@ type ObjectSearchContainerProps = {
|
|
|
1206
1204
|
};
|
|
1207
1205
|
/**
|
|
1208
1206
|
* @description Object search container is an opinionated layout for search parameters and retrieved results
|
|
1209
|
-
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
|
|
1210
|
-
* @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
|
|
1211
|
-
*/
|
|
1207
|
+
* @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
|
|
1212
1208
|
declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1213
1209
|
|
|
1210
|
+
type ObjectSearchFilterProps = {
|
|
1211
|
+
/** shows or hides the required content type select option */
|
|
1212
|
+
requireContentType?: boolean;
|
|
1213
|
+
/** sets the text for the required content type select option
|
|
1214
|
+
* @default 'All content types'
|
|
1215
|
+
*/
|
|
1216
|
+
typeSelectorAllTypesOptionText?: string;
|
|
1217
|
+
/** sets the select input value label text
|
|
1218
|
+
* @default 'Content Type Select'
|
|
1219
|
+
*/
|
|
1220
|
+
selectLabel?: string;
|
|
1221
|
+
/** sets the select input options, if empty - only keyword search field will be rendered */
|
|
1222
|
+
selectOptions?: Array<{
|
|
1223
|
+
id?: string;
|
|
1224
|
+
name?: string;
|
|
1225
|
+
label: string;
|
|
1226
|
+
value?: string;
|
|
1227
|
+
}>;
|
|
1228
|
+
/** sets the search input name value
|
|
1229
|
+
* @default 'searchText'
|
|
1230
|
+
*/
|
|
1231
|
+
searchInputName?: string;
|
|
1232
|
+
/** sets the search input placeholder text
|
|
1233
|
+
* @default 'Enter keyword to narrow your results'
|
|
1234
|
+
*/
|
|
1235
|
+
searchInputPlaceholderText?: string;
|
|
1236
|
+
};
|
|
1237
|
+
/**
|
|
1238
|
+
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1239
|
+
* that can be extended with custom functions
|
|
1240
|
+
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
|
|
1241
|
+
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1242
|
+
|
|
1243
|
+
type ObjectSearchFilterContainerProps = {
|
|
1244
|
+
/**
|
|
1245
|
+
* sets the title for the container
|
|
1246
|
+
* @deprecated we recommend setting the label on ObjectSearchContainer instead
|
|
1247
|
+
*/
|
|
1248
|
+
label?: string;
|
|
1249
|
+
/** sets child components in an opinionated layout */
|
|
1250
|
+
children?: React.ReactNode;
|
|
1251
|
+
};
|
|
1252
|
+
/**
|
|
1253
|
+
* @description an opinionated layout for search filters
|
|
1254
|
+
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1255
|
+
*/
|
|
1256
|
+
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1257
|
+
|
|
1214
1258
|
type SearchQueryProps<TExtraFilters = unknown> = {
|
|
1215
1259
|
/** sets the content type in the search context */
|
|
1216
1260
|
contentType?: string;
|
|
@@ -1218,7 +1262,6 @@ type SearchQueryProps<TExtraFilters = unknown> = {
|
|
|
1218
1262
|
keyword?: string;
|
|
1219
1263
|
/** sets the locale in the search context */
|
|
1220
1264
|
locale?: string;
|
|
1221
|
-
dynamicEntryId?: string;
|
|
1222
1265
|
} & TExtraFilters;
|
|
1223
1266
|
type SelectedItemProps<TExtraProps = unknown> = {
|
|
1224
1267
|
/** sets the id value */
|
|
@@ -1288,97 +1331,18 @@ type ObjectSearchContextProps<TExtraFilters = unknown, TExtraItemProps = unknown
|
|
|
1288
1331
|
/** current list of results in state */
|
|
1289
1332
|
list: ItemListProps<TExtraItemProps>;
|
|
1290
1333
|
/** function that sets the list of items to state */
|
|
1291
|
-
onSetList
|
|
1334
|
+
onSetList: (value: ItemListProps) => void;
|
|
1292
1335
|
/** is multi items selection allowed or not */
|
|
1293
1336
|
isMulti: boolean;
|
|
1294
|
-
localeOptions?: {
|
|
1295
|
-
label: string;
|
|
1296
|
-
value: string;
|
|
1297
|
-
}[];
|
|
1298
|
-
enableFilterByLocale?: boolean;
|
|
1299
|
-
isListLoading?: boolean;
|
|
1300
|
-
isSelectedItemsListLoading?: boolean;
|
|
1301
|
-
dynamicEntryId?: string;
|
|
1302
1337
|
};
|
|
1303
|
-
declare const ObjectSearchContext: React$1.Context<ObjectSearchContextProps<unknown, unknown>>;
|
|
1304
1338
|
type ObjectSearchProviderProps = {
|
|
1305
1339
|
children: ReactNode;
|
|
1306
1340
|
currentlySelectedItems?: Array<SelectedItemProps>;
|
|
1307
|
-
searchResultList?: Array<SelectedItemProps>;
|
|
1308
1341
|
isMulti?: boolean;
|
|
1309
1342
|
defaultQuery?: SearchQueryProps;
|
|
1310
1343
|
};
|
|
1311
|
-
/**
|
|
1312
|
-
* @deprecated Please use ControlledObjectSearchProvider with SearchAndFilter instead. You can use Mesh Example for reference.
|
|
1313
|
-
*/
|
|
1314
1344
|
declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1315
1345
|
declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
|
|
1316
|
-
declare function bindQuery(query: SearchQueryProps, inputs: Record<string, unknown>): {
|
|
1317
|
-
/** sets the content type in the search context */
|
|
1318
|
-
contentType?: string | undefined;
|
|
1319
|
-
/** sets the keyword search in the search context */
|
|
1320
|
-
keyword?: string | undefined;
|
|
1321
|
-
/** sets the locale in the search context */
|
|
1322
|
-
locale?: string | undefined;
|
|
1323
|
-
dynamicEntryId?: string | undefined;
|
|
1324
|
-
};
|
|
1325
|
-
|
|
1326
|
-
type ObjectSearchFilterProps = {
|
|
1327
|
-
/** shows or hides the required content type select option */
|
|
1328
|
-
requireContentType?: boolean;
|
|
1329
|
-
/** sets the text for the required content type select option
|
|
1330
|
-
* @default 'All content types'
|
|
1331
|
-
*/
|
|
1332
|
-
typeSelectorAllTypesOptionText?: string;
|
|
1333
|
-
/** sets the select input value label text
|
|
1334
|
-
* @default 'Content Type Select'
|
|
1335
|
-
*/
|
|
1336
|
-
selectLabel?: string;
|
|
1337
|
-
/** sets the select input options, if empty - only keyword search field will be rendered */
|
|
1338
|
-
selectOptions?: Array<{
|
|
1339
|
-
id?: string;
|
|
1340
|
-
name?: string;
|
|
1341
|
-
label: string;
|
|
1342
|
-
value?: string;
|
|
1343
|
-
}>;
|
|
1344
|
-
/** sets the search input name value
|
|
1345
|
-
* @default 'searchText'
|
|
1346
|
-
*/
|
|
1347
|
-
searchInputName?: string;
|
|
1348
|
-
/** sets the search input placeholder text
|
|
1349
|
-
* @default 'Enter keyword to narrow your results'
|
|
1350
|
-
*/
|
|
1351
|
-
searchInputPlaceholderText?: string;
|
|
1352
|
-
/** sets the label for the locale selectbox filter */
|
|
1353
|
-
localeFilterLabel?: string;
|
|
1354
|
-
/** sets the locale options for the locale selectbox filter */
|
|
1355
|
-
localeOptions?: ObjectSearchContextProps['localeOptions'];
|
|
1356
|
-
/** enables or disables the locale filter */
|
|
1357
|
-
enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
|
|
1358
|
-
};
|
|
1359
|
-
/**
|
|
1360
|
-
* @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
|
|
1361
|
-
* that can be extended with custom functions
|
|
1362
|
-
* @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
|
|
1363
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1364
|
-
*/
|
|
1365
|
-
declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, localeFilterLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1366
|
-
|
|
1367
|
-
type ObjectSearchFilterContainerProps = {
|
|
1368
|
-
/**
|
|
1369
|
-
* sets the title for the container
|
|
1370
|
-
* @deprecated we recommend setting the label on ObjectSearchContainer instead
|
|
1371
|
-
*/
|
|
1372
|
-
label?: string;
|
|
1373
|
-
/** sets child components in an opinionated layout */
|
|
1374
|
-
children?: React.ReactNode;
|
|
1375
|
-
};
|
|
1376
|
-
/**
|
|
1377
|
-
* @description an opinionated layout for search filters
|
|
1378
|
-
* @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
|
|
1379
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1380
|
-
*/
|
|
1381
|
-
declare const ObjectSearchFilterContainer: ({ label, children }: ObjectSearchFilterContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1382
1346
|
|
|
1383
1347
|
type ObjectSearchListItemProps = SelectedItemProps & {
|
|
1384
1348
|
/** sets the content type value, this is normally used for subtitles e.g. Kitchens */
|
|
@@ -1583,29 +1547,9 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
|
|
|
1583
1547
|
/**
|
|
1584
1548
|
* @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
|
|
1585
1549
|
* @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
|
|
1586
|
-
* @deprecated Please use SearchAndFilter from @uniformdev/design-system instead.
|
|
1587
1550
|
*/
|
|
1588
1551
|
declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, countValue, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1589
1552
|
|
|
1590
|
-
declare function ObjectSearchListOfSearchResults(): _emotion_react_types_jsx_namespace.EmotionJSX.Element | _emotion_react_types_jsx_namespace.EmotionJSX.Element[] | undefined;
|
|
1591
|
-
|
|
1592
|
-
type ControlledObjectSearchProviderProps = {
|
|
1593
|
-
children: ReactNode;
|
|
1594
|
-
selectedItems: Array<SelectedItemProps> | undefined;
|
|
1595
|
-
searchResultItems: Array<SelectedItemProps> | undefined;
|
|
1596
|
-
selectedItemsLoading?: boolean;
|
|
1597
|
-
searchResultItemsLoading?: boolean;
|
|
1598
|
-
searchResultListLoading?: boolean;
|
|
1599
|
-
onQueryChange: (value: SearchQueryProps) => void;
|
|
1600
|
-
onSelectItemsChange: (selectedItems: Array<SelectedItemProps>) => void;
|
|
1601
|
-
isMulti?: boolean;
|
|
1602
|
-
query: SearchQueryProps;
|
|
1603
|
-
localeOptions?: ObjectSearchContextProps['localeOptions'];
|
|
1604
|
-
enableFilterByLocale?: ObjectSearchContextProps['enableFilterByLocale'];
|
|
1605
|
-
dynamicEntryId?: ObjectSearchContextProps['dynamicEntryId'];
|
|
1606
|
-
};
|
|
1607
|
-
declare const ControlledObjectSearchProvider: ({ selectedItems, searchResultItems, selectedItemsLoading, searchResultListLoading, searchResultItemsLoading, onQueryChange, onSelectItemsChange, isMulti, children, query, enableFilterByLocale, localeOptions, dynamicEntryId, }: ControlledObjectSearchProviderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
1608
|
-
|
|
1609
1553
|
type ParamTypeDynamicDataProviderProps = {
|
|
1610
1554
|
/** Child components of the provider. Variables-using components, such as ParameterVariables, can be used here. */
|
|
1611
1555
|
children: ReactNode;
|
|
@@ -1842,4 +1786,4 @@ type ContentDataResourceLocaleInfoProps = {
|
|
|
1842
1786
|
};
|
|
1843
1787
|
declare function useContentDataResourceLocaleInfo({ locale, setLocale, dynamicInputs, }: ContentDataResourceLocaleInfoProps): ContentDataResourceLocaleInfoResult;
|
|
1844
1788
|
|
|
1845
|
-
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult,
|
|
1789
|
+
export { $createVariableNode, $isVariableNode, type BaseRequestData, type Brand, type ContentDataResourceLocaleInfoProps, type ContentDataResourceLocaleInfoResult, ControlledValuePlugin, 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, 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 GetProductOptions, type GetProductsOptions, INSERT_VARIABLE_COMMAND, index as Icons, InputVariables, type InputVariablesProps, type InsertVariableCommandArguments, type ItemListProps, type KnownUndefinedVariableInfo, LinkButton, MeshApp, type MeshAppProps, type MeshDataVariableDefinition, type NoResultsProps, OPEN_INSERT_VARIABLE_COMMAND, 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, 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, type RequestAction, RequestBody, type RequestContext, type RequestData, RequestHeaders, RequestMethodSelect, type RequestParameter, RequestParameters, type RequestParametersProps, RequestProvider, type RequestProviderProps, RequestTypeContainer, type RequestTypeContainerProps, RequestUrl, RequestUrlInput, ResolvableLoadingValue, type SearchQueryProps, type SelectedItemProps, SelectionField, type SelectionFieldValue, type SerializedVariableNode, type SetLocationValueDispatch, type SetLocationValueFunction, TextVariableRenderer, type UseVariablesMenu, type UseVariablesMenuInput, 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, 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, serializeVariablesEditorState, setVariablesEditorValue, urlEncodeRequestParameter, urlEncodeRequestUrl, useConnectedDataAsVariables, useContentDataResourceLocaleInfo, useDynamicInputsAsVariables, useMeshLocation, useObjectSearchContext, useProductQueryContext, useProductSearchContext, useRequest, useRequestHeader, useRequestParameter, useUniformMeshSdk, useVariableEditor, useVariables, useVariablesMenu, variableDefaultTextValue, variablePrefix, variableSuffix, variablesToGroupedList, variablesToList };
|