Fix docs and types for InfoCard styling props

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>
This commit is contained in:
Andrew Shirley
2021-08-03 14:41:13 +01:00
parent e013dbb7ac
commit 7bf0062106
2 changed files with 7 additions and 4 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/core-components': patch
---
Remove unused props from InfoCard prop type
@@ -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
@@ -115,8 +115,6 @@ type Props = {
slackChannel?: string;
errorBoundaryProps?: ErrorBoundaryProps;
variant?: InfoCardVariants;
style?: object;
cardStyle?: object;
children?: ReactNode;
headerStyle?: object;
headerProps?: CardHeaderProps;