fix(react-card): improve api description

marcosmoura · Nov 2, 2022 · 64ad7aa · 64ad7aa
1 parent 3c1b9fb
commit 64ad7aa
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/packages/react-components/react-card/src/components/Card/Card.types.ts b/packages/react-components/react-card/src/components/Card/Card.types.ts
@@ -4,15 +4,13 @@ import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utili
 /**
  * Card refs to the root element slot.
  */
-
 export type CardRefElement = HTMLDivElement | HTMLButtonElement | HTMLAnchorElement;
 
 /**
  * Card selected event type
  *
  * This event is fired when a selectable card changes its selection state.
  */
-
 export type CardOnSelectEvent = React.MouseEvent | React.KeyboardEvent | React.ChangeEvent;
 
 /**
@@ -48,13 +46,13 @@ export type CardProps = ComponentProps<CardSlots> & {
  * The card will have a shadow, border and background color.
  *
  * `filled-alternative`
- * This appearance is similar to `filled` but the background color will be a little darker.
+ * This appearance is similar to `filled`, but the background color will be a little darker.
  *
  * `outline`
- * This appearance is similar to `filled` but the background color will be transparent and no shadow applied.
+ * This appearance is similar to `filled`, but the background color will be transparent and no shadow applied.
  *
  * `subtle`
- * This appearance is similar to `filled-alternative` but no border is applied.
+ * This appearance is similar to `filled-alternative`, but no border is applied.
  *
  * @default 'filled'
  */

diff --git a/packages/react-components/react-card/src/components/Card/useCard.ts b/packages/react-components/react-card/src/components/Card/useCard.ts
@@ -40,7 +40,7 @@ const useCardFocusAttributes = ({ focusMode = 'off' }: CardProps, { isInteractiv
  * before being passed to renderCard_unstable.
  *
  * @param props - props from this instance of Card
- * @param ref - reference to root HTMLElement of Card
+ * @param ref - reference to the root element of Card
  */
 export const useCard_unstable = (props: CardProps, ref: React.Ref<CardRefElement>): CardState => {
  const { appearance = 'filled', orientation = 'vertical', size = 'medium', as = 'div' } = props;