docs(mui-card): add prop definitions

Availity · Jan 29, 2025 · b6bf7eb · b6bf7eb
1 parent b9950ee
commit b6bf7eb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/card/src/lib/CardHeader.tsx b/packages/card/src/lib/CardHeader.tsx
@@ -2,12 +2,14 @@ import { default as MuiCardHeader, CardHeaderProps as MuiCardHeaderProps } from
 import { StatusChip, StatusChipProps } from '@availity/mui-chip';
 
 type CardStatusChipProps = StatusChipProps & {
+  /** Setting the position to `bottom` displays the StatusChip under the header and subheader. Setting the position to `right` displays the StatusChip next to the actions section. */
   position: 'bottom' | 'right';
 };
 
 export interface CardHeaderProps extends MuiCardHeaderProps {
-  children?: React.ReactNode;
+  /** These props will be forwarded to the StatusChip.  */
   statusChipProps?: CardStatusChipProps;
+  /** Section at the top-right of the card for displaying logos. */
   logo?: React.ReactNode;
 }