Merge pull request #9632 from backstage/rugvip/maybe

maybe rename CatalogResultListItem

plugins/catalog/api-report.md

@@ -102,13 +102,19 @@ export const catalogPlugin: BackstagePlugin<
   }
 >;
 
+// @public @deprecated (undocumented)
+export const CatalogResultListItem: typeof CatalogSearchResultListItem;
+
+// @public @deprecated (undocumented)
+export type CatalogResultListItemProps = CatalogSearchResultListItemProps;
+
 // @public (undocumented)
-export function CatalogResultListItem(
-  props: CatalogResultListItemProps,
+export function CatalogSearchResultListItem(
+  props: CatalogSearchResultListItemProps,
 ): JSX.Element;
 
 // @public
-export interface CatalogResultListItemProps {
+export interface CatalogSearchResultListItemProps {
   // (undocumented)
   result: IndexableDocument;
 }

plugins/catalog/src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.tsx

@@ -38,16 +38,18 @@ const useStyles = makeStyles({
 });
 
 /**
- * Props for {@link CatalogResultListItem}.
+ * Props for {@link CatalogSearchResultListItem}.
  *
  * @public
  */
-export interface CatalogResultListItemProps {
+export interface CatalogSearchResultListItemProps {
   result: IndexableDocument;
 }
 
 /** @public */
-export function CatalogResultListItem(props: CatalogResultListItemProps) {
+export function CatalogSearchResultListItem(
+  props: CatalogSearchResultListItemProps,
+) {
   const result = props.result as any;
 
   const classes = useStyles();
@@ -71,3 +73,15 @@ export function CatalogResultListItem(props: CatalogResultListItemProps) {
     </Link>
   );
 }
+
+/**
+ * @public
+ * @deprecated use {@link CatalogSearchResultListItemProps} instead
+ */
+export type CatalogResultListItemProps = CatalogSearchResultListItemProps;
+
+/**
+ * @public
+ * @deprecated use {@link CatalogSearchResultListItem} instead
+ */
+export const CatalogResultListItem = CatalogSearchResultListItem;

plugins/catalog/src/components/CatalogSearchResultListItem/index.ts

@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
-export { CatalogResultListItem } from './CatalogResultListItem';
-export type { CatalogResultListItemProps } from './CatalogResultListItem';
+export {
+  CatalogSearchResultListItem,
+  CatalogResultListItem,
+} from './CatalogSearchResultListItem';
+export type {
+  CatalogSearchResultListItemProps,
+  CatalogResultListItemProps,
+} from './CatalogSearchResultListItem';

plugins/catalog/src/index.ts

@@ -22,7 +22,7 @@
 
 export * from './components/AboutCard';
 export * from './components/CatalogKindHeader';
-export * from './components/CatalogResultListItem';
+export * from './components/CatalogSearchResultListItem';
 export * from './components/CatalogTable';
 export * from './components/CatalogTable/columns';
 export * from './components/EntityLayout';