Skip to content

Commit

Permalink
Fix docs and types for InfoCard styling props
Browse files Browse the repository at this point in the history
Note that there is no change in the api-report due to `Warning:
(ae-forgotten-export) The symbol "Props" needs to be exported by the entry
point index.d.ts` and as these props are currently ignored, I think this is
fine as a patch release but please confirm.

Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk>
  • Loading branch information
ashirley committed Aug 3, 2021
1 parent e013dbb commit 7bf0062
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/hot-bees-sleep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage/core-components': patch
---

Remove unused props from InfoCard prop type
6 changes: 2 additions & 4 deletions packages/core-components/src/layout/InfoCard/InfoCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ export type InfoCardVariants = 'flex' | 'fullHeight' | 'gridItem';
/**
* InfoCard is used to display a paper-styled block on the screen, similar to a panel.
*
* You can custom style an InfoCard with the 'style' (outer container) and 'cardStyle' (inner container)
* styles.
* You can custom style an InfoCard with the 'className' (outer container) and 'cardClassName' (inner container)
* props. This is typically used with the material-ui makeStyles mechanism.
*
* The InfoCard serves as an error boundary. As a result, if you provide an 'errorBoundaryProps' property this
* specifies the extra information to display in the error component that is displayed if an error occurs
Expand All @@ -115,8 +115,6 @@ type Props = {
slackChannel?: string;
errorBoundaryProps?: ErrorBoundaryProps;
variant?: InfoCardVariants;
style?: object;
cardStyle?: object;
children?: ReactNode;
headerStyle?: object;
headerProps?: CardHeaderProps;
Expand Down

0 comments on commit 7bf0062

Please sign in to comment.