@uniformdev/mesh-sdk-react 20.9.0 → 20.9.1-alpha.16

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 CHANGED
@@ -887,7 +887,9 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
887
887
  };
888
888
  /**
889
889
  * @description The data refresh button is a UI component to indicate to users a request for data is taking place
890
- * @example <DataRefreshButton buttonText="my button" isLoading /> */
890
+ * @example <DataRefreshButton buttonText="my button" isLoading />
891
+ * @deprecated this component is not recommended for use in new projects
892
+ */
891
893
  declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
892
894
 
893
895
  type ObjectSearchContainerProps = {
@@ -914,7 +916,9 @@ type ObjectSearchContainerProps = {
914
916
  };
915
917
  /**
916
918
  * @description Object search container is an opinionated layout for search parameters and retrieved results
917
- * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
919
+ * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
920
+ * @deprecated this component is not recommended for use in new projects
921
+ */
918
922
  declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
919
923
 
920
924
  type ObjectSearchFilterProps = {
@@ -945,7 +949,9 @@ type ObjectSearchFilterProps = {
945
949
  /**
946
950
  * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
947
951
  * that can be extended with custom functions
948
- * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
952
+ * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
953
+ * @deprecated this component is not recommended for use in new projects
954
+ */
949
955
  declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
950
956
 
951
957
  type ObjectSearchFilterContainerProps = {
@@ -955,6 +961,7 @@ type ObjectSearchFilterContainerProps = {
955
961
  /**
956
962
  * @description an opinionated layout for search filters
957
963
  * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
964
+ * @deprecated this component is not recommended for use in new projects
958
965
  */
959
966
  declare const ObjectSearchFilterContainer: ({ children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
960
967
 
@@ -977,6 +984,7 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
977
984
  /**
978
985
  * @description An opinionated result item, best used for selected results
979
986
  * @example <ObjectSearchResultItem id="my-result" title="title" />
987
+ * @deprecated this component is not recommended for use in new projects
980
988
  */
981
989
  declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, onClick, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
982
990
 
@@ -1056,7 +1064,13 @@ type ObjectSearchProviderProps = {
1056
1064
  isMulti?: boolean;
1057
1065
  defaultQuery?: SearchQueryProps;
1058
1066
  };
1067
+ /**
1068
+ * @deprecated this component is not recommended for use in new projects
1069
+ */
1059
1070
  declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1071
+ /**
1072
+ * @deprecated this component is not recommended for use in new projects
1073
+ */
1060
1074
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1061
1075
 
1062
1076
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1078,7 +1092,9 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1078
1092
  } & React$1.HTMLAttributes<HTMLDivElement>;
1079
1093
  /**
1080
1094
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1081
- * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1095
+ * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
1096
+ * @deprecated this component is not recommended for use in new projects
1097
+ */
1082
1098
  declare const ObjectSearchListItem: ({ id, title, contentType, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
1083
1099
  /**
1084
1100
  * An opinionated loading skeleton component best used with ObjectSearchListItem
@@ -1097,12 +1113,14 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
1097
1113
  /**
1098
1114
  * @description An opinionated button component best used within the ObjectSearchResultItem component
1099
1115
  * @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
1116
+ * @deprecated this component is not recommended for use in new projects
1100
1117
  */
1101
1118
  declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
1102
1119
  /**
1103
1120
  * @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
1104
1121
  * that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
1105
1122
  * @example <LinkButton text="link text" icon="/my-image.png" />
1123
+ * @deprecated this component is not recommended for use in new projects
1106
1124
  */
1107
1125
  declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
1108
1126
 
@@ -1147,6 +1165,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1147
1165
  * The result item component defaults to <ObjectSearchResultItem {...props} />, however this can be overridden with any other UI component and still
1148
1166
  * maintain drag and drop functionality
1149
1167
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1168
+ * @deprecated this component is not recommended for use in new projects
1150
1169
  */
1151
1170
  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;
1152
1171
 
@@ -1216,6 +1235,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
1216
1235
  /**
1217
1236
  * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
1218
1237
  * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
1238
+ * @deprecated this component is not recommended for use in new projects
1219
1239
  */
1220
1240
  declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1221
1241
 
package/dist/index.d.ts CHANGED
@@ -887,7 +887,9 @@ type DataRefreshButtonProps = HTMLAttributes<HTMLButtonElement> & {
887
887
  };
888
888
  /**
889
889
  * @description The data refresh button is a UI component to indicate to users a request for data is taking place
890
- * @example <DataRefreshButton buttonText="my button" isLoading /> */
890
+ * @example <DataRefreshButton buttonText="my button" isLoading />
891
+ * @deprecated this component is not recommended for use in new projects
892
+ */
891
893
  declare const DataRefreshButton: ({ buttonText, isLoading, onRefreshData, ...props }: DataRefreshButtonProps) => _emotion_react_jsx_runtime.JSX.Element;
892
894
 
893
895
  type ObjectSearchContainerProps = {
@@ -914,7 +916,9 @@ type ObjectSearchContainerProps = {
914
916
  };
915
917
  /**
916
918
  * @description Object search container is an opinionated layout for search parameters and retrieved results
917
- * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} /> */
919
+ * @example <ObjectSearchContainer searchFilters={<>your component</>} resultList={<>your result list component<>} onSave={yourSaveAction} onCancel={yourCancelAction} />
920
+ * @deprecated this component is not recommended for use in new projects
921
+ */
918
922
  declare const ObjectSearchContainer: ({ label, enableDynamicInputToResultId, searchFilters, resultList, children, }: ObjectSearchContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
919
923
 
920
924
  type ObjectSearchFilterProps = {
@@ -945,7 +949,9 @@ type ObjectSearchFilterProps = {
945
949
  /**
946
950
  * @description Object search filter is an opinionated filter that has pre-defined query and setQuery functions
947
951
  * that can be extended with custom functions
948
- * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} /> */
952
+ * @example <ObjectSearchFilter selectOptions={[{ id: 'id value', name: 'name value'}]} />
953
+ * @deprecated this component is not recommended for use in new projects
954
+ */
949
955
  declare const ObjectSearchFilter: ({ requireContentType, typeSelectorAllTypesOptionText, searchInputName, searchInputPlaceholderText, selectLabel, selectOptions, }: ObjectSearchFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
950
956
 
951
957
  type ObjectSearchFilterContainerProps = {
@@ -955,6 +961,7 @@ type ObjectSearchFilterContainerProps = {
955
961
  /**
956
962
  * @description an opinionated layout for search filters
957
963
  * @example <ObjectSearchFilterContainer label="my label"><input type="text" aria-label="my input" /></ObjectSearchFilterContainer>
964
+ * @deprecated this component is not recommended for use in new projects
958
965
  */
959
966
  declare const ObjectSearchFilterContainer: ({ children }: ObjectSearchFilterContainerProps) => _emotion_react_jsx_runtime.JSX.Element;
960
967
 
@@ -977,6 +984,7 @@ type ObjectSearchResultItemProps = SelectedItemProps & {
977
984
  /**
978
985
  * @description An opinionated result item, best used for selected results
979
986
  * @example <ObjectSearchResultItem id="my-result" title="title" />
987
+ * @deprecated this component is not recommended for use in new projects
980
988
  */
981
989
  declare const ObjectSearchResultItem: ({ id, title, contentType, popoverData, publishStatus, editLinkIcon, editLink, imageUrl, onRemove, createdAt, publishedAt, hideRemoveButton, disableDnD, children, onClick, }: ObjectSearchResultItemProps) => _emotion_react_jsx_runtime.JSX.Element;
982
990
 
@@ -1056,7 +1064,13 @@ type ObjectSearchProviderProps = {
1056
1064
  isMulti?: boolean;
1057
1065
  defaultQuery?: SearchQueryProps;
1058
1066
  };
1067
+ /**
1068
+ * @deprecated this component is not recommended for use in new projects
1069
+ */
1059
1070
  declare const ObjectSearchProvider: ({ currentlySelectedItems, isMulti, children, defaultQuery, }: ObjectSearchProviderProps) => _emotion_react_jsx_runtime.JSX.Element;
1071
+ /**
1072
+ * @deprecated this component is not recommended for use in new projects
1073
+ */
1060
1074
  declare function useObjectSearchContext<TExtraSearchFilters = unknown, TExtraItemProps = unknown>(): ObjectSearchContextProps<TExtraSearchFilters, TExtraItemProps>;
1061
1075
 
1062
1076
  type ObjectSearchListItemProps = SelectedItemProps & {
@@ -1078,7 +1092,9 @@ type ObjectSearchListItemProps = SelectedItemProps & {
1078
1092
  } & React$1.HTMLAttributes<HTMLDivElement>;
1079
1093
  /**
1080
1094
  * @description entry search list item is an opinionated UI component best used for initial retrieved results
1081
- * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem> */
1095
+ * @example <ObjectSearchListItem id="my-result-item" title="title" popoverData={<p>some data info</p>}><div>example of uncontrolled content</div></ObjectSearchListItem>
1096
+ * @deprecated this component is not recommended for use in new projects
1097
+ */
1082
1098
  declare const ObjectSearchListItem: ({ id, title, contentType, imageUrl, popoverData, onSelect, isMulti, disabled, children, ...props }: ObjectSearchListItemProps & React$1.HTMLAttributes<HTMLDivElement>) => _emotion_react_jsx_runtime.JSX.Element;
1083
1099
  /**
1084
1100
  * An opinionated loading skeleton component best used with ObjectSearchListItem
@@ -1097,12 +1113,14 @@ type ObjectSearchResultItemButtonProps<THtml extends HTMLAttributes<HTMLElement>
1097
1113
  /**
1098
1114
  * @description An opinionated button component best used within the ObjectSearchResultItem component
1099
1115
  * @example <ObjectSearchResultItemButton text="button text" icon="/my-image.png" onClick={() => myFunction()} />
1116
+ * @deprecated this component is not recommended for use in new projects
1100
1117
  */
1101
1118
  declare const ObjectSearchResultItemButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<HTMLAttributes<HTMLButtonElement>>) => _emotion_react_jsx_runtime.JSX.Element;
1102
1119
  /**
1103
1120
  * @description An opinionated link component styled the same of the ObjectSearchResultItemButton component,
1104
1121
  * that automatically sets the target and rel attributes. Best used within the ObjectSearchResultItem component
1105
1122
  * @example <LinkButton text="link text" icon="/my-image.png" />
1123
+ * @deprecated this component is not recommended for use in new projects
1106
1124
  */
1107
1125
  declare const LinkButton: ({ text, icon, ...props }: ObjectSearchResultItemButtonProps<Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "target" | "rel">>) => _emotion_react_jsx_runtime.JSX.Element;
1108
1126
 
@@ -1147,6 +1165,7 @@ type ObjectSearchResultListProps<TRenderComponent extends SelectedItemProps = Se
1147
1165
  * The result item component defaults to <ObjectSearchResultItem {...props} />, however this can be overridden with any other UI component and still
1148
1166
  * maintain drag and drop functionality
1149
1167
  * @example <ObjectSearchResultList id="my-id" title="title" renderResultComponent={(values) => <CustomComponent {...values} />} />
1168
+ * @deprecated this component is not recommended for use in new projects
1150
1169
  */
1151
1170
  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;
1152
1171
 
@@ -1216,6 +1235,7 @@ type QueryFilterProps<TSelectOptions extends QueryFilterSelectionOptionProps = Q
1216
1235
  /**
1217
1236
  * @description An opinionated multi query filter UI component, best used for querying product data or more complex scenarios
1218
1237
  * @example <QueryFilter contentTypeOptions={[{ id: 'id', name: 'name' }]} sortOptions={[{ id: 'id', name: 'name' }]} sortOrderOptions={[{ id: 'id', name: 'name' }]} />
1238
+ * @deprecated this component is not recommended for use in new projects
1219
1239
  */
1220
1240
  declare const QueryFilter: ({ requireContentType, queryFilterTitle, contentTypeLabel, typeSelectorAllTypesOptionText, contentTypeOptions, searchInputName, searchInputPlaceholderText, searchInputLabel, countLabel, sortLabel, sortOptions, sortOrderLabel, sortOrderOptions, children, }: QueryFilterProps) => _emotion_react_jsx_runtime.JSX.Element;
1221
1241
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk-react",
3
- "version": "20.9.0",
3
+ "version": "20.9.1-alpha.16+5d93781920",
4
4
  "description": "Uniform Mesh Framework SDK for React",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -49,11 +49,11 @@
49
49
  "@lexical/react": "0.25.0",
50
50
  "@lexical/selection": "0.25.0",
51
51
  "@lexical/utils": "0.25.0",
52
- "@react-icons/all-files": "https://github.com/react-icons/react-icons/releases/download/v5.2.1/react-icons-all-files-5.2.1.tgz",
53
- "@uniformdev/canvas": "20.9.0",
54
- "@uniformdev/design-system": "20.9.0",
55
- "@uniformdev/mesh-sdk": "20.9.0",
56
- "@uniformdev/richtext": "20.9.0",
52
+ "@react-icons/all-files": "https://github.com/react-icons/react-icons/releases/download/v5.5.0/react-icons-all-files-5.5.0.tgz",
53
+ "@uniformdev/canvas": "20.9.1-alpha.16+5d93781920",
54
+ "@uniformdev/design-system": "20.9.1-alpha.16+5d93781920",
55
+ "@uniformdev/mesh-sdk": "20.9.1-alpha.16+5d93781920",
56
+ "@uniformdev/richtext": "20.9.1-alpha.16+5d93781920",
57
57
  "dequal": "^2.0.3",
58
58
  "lexical": "0.25.0",
59
59
  "mitt": "3.0.1",
@@ -86,5 +86,5 @@
86
86
  "publishConfig": {
87
87
  "access": "public"
88
88
  },
89
- "gitHead": "47e2e9af8e7e56d2c524c6057920fe6a9480a4a9"
89
+ "gitHead": "5d937819205e0fe171a5b51f2e204cddc910cbf3"
90
90
  }