Improved changeset note

Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2022-04-03 15:39:56 -05:00
parent cb592bfce7
commit 8d3f09e88c
1 changed files with 21 additions and 1 deletions
@@ -2,4 +2,24 @@
 '@backstage/plugin-org': patch
 ---

-Provides the ability to hide the relations toggle as well as setting a default relation type
+Provides the ability to hide the relations toggle on the `OwnershipCard` as well as setting a default relation type.
+
+To hide the toggle simply include the `hideRelationsToggle` prop like this:
+
+```tsx
+<EntityOwnershipCard
+  variant="gridItem"
+  entityFilterKind={customEntityFilterKind}
+  hideRelationsToggle
+/>
+```
+
+To set the default relation type, add the `relationsType` prop with a value of direct or aggregated, the default if not provided is direct. Here is an example:
+
+```tsx
+<EntityOwnershipCard
+  variant="gridItem"
+  entityFilterKind={customEntityFilterKind}
+  relationsType="aggregated"
+/>
+```