Add support for string refs to the EntityRefLinks component

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
backstage · Mar 18, 2022 · a496cee · a496cee
1 parent ffaaec5
commit a496cee
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 21 deletions.
diff --git a/.changeset/red-snakes-float.md b/.changeset/red-snakes-float.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-react': patch
+---
+
+Add support for string refs to the `EntityRefLinks` component
diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md
@@ -261,15 +261,11 @@ export type EntityRefLinkProps = {
 } & Omit<LinkProps, 'to'>;
 
 // @public
-export const EntityRefLinks: ({
-  entityRefs,
-  defaultKind,
-  ...linkProps
-}: EntityRefLinksProps) => JSX.Element;
+export function EntityRefLinks(props: EntityRefLinksProps): JSX.Element;
 
 // @public
 export type EntityRefLinksProps = {
-  entityRefs: (Entity | CompoundEntityRef)[];
+  entityRefs: (string | Entity | CompoundEntityRef)[];
   defaultKind?: string;
 } & Omit<LinkProps, 'to'>;
 

diff --git a/plugins/catalog-react/src/components/EntityRefLink/EntityRefLinks.tsx b/plugins/catalog-react/src/components/EntityRefLink/EntityRefLinks.tsx
@@ -25,7 +25,7 @@ import { LinkProps } from '@backstage/core-components';
  * @public
  */
 export type EntityRefLinksProps = {
-  entityRefs: (Entity | CompoundEntityRef)[];
+  entityRefs: (string | Entity | CompoundEntityRef)[];
   defaultKind?: string;
 } & Omit<LinkProps, 'to'>;
 
@@ -34,17 +34,20 @@ export type EntityRefLinksProps = {
  *
  * @public
  */
-export const EntityRefLinks = ({
-  entityRefs,
-  defaultKind,
-  ...linkProps
-}: EntityRefLinksProps) => (
-  <>
-    {entityRefs.map((r, i) => (
-      <React.Fragment key={i}>
-        {i > 0 && ', '}
-        <EntityRefLink {...linkProps} entityRef={r} defaultKind={defaultKind} />
-      </React.Fragment>
-    ))}
-  </>
-);
+export function EntityRefLinks(props: EntityRefLinksProps) {
+  const { entityRefs, defaultKind, ...linkProps } = props;
+  return (
+    <>
+      {entityRefs.map((r, i) => (
+        <React.Fragment key={i}>
+          {i > 0 && ', '}
+          <EntityRefLink
+            {...linkProps}
+            entityRef={r}
+            defaultKind={defaultKind}
+          />
+        </React.Fragment>
+      ))}
+    </>
+  );
+}