From a29b164fcba66847cd5b25e25126940bd196b9ed Mon Sep 17 00:00:00 2001 From: KICKdesigns Date: Mon, 9 Nov 2020 15:38:36 -0800 Subject: [PATCH] chore(avatars): update prop descriptions (#926) --- packages/avatars/src/elements/Avatar.tsx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/packages/avatars/src/elements/Avatar.tsx b/packages/avatars/src/elements/Avatar.tsx index 00b5438e39c..79effb54a31 100644 --- a/packages/avatars/src/elements/Avatar.tsx +++ b/packages/avatars/src/elements/Avatar.tsx @@ -10,16 +10,19 @@ import PropTypes from 'prop-types'; import { StyledAvatar, StyledText } from '../styled'; interface IAvatarProps extends HTMLAttributes { - /** Set the avatar background color */ + /** Sets the avatar's background color */ backgroundColor?: string; - /** Set the color for child SVG or `Avatar.Text` components */ + /** Sets the color for the child SVG or `Avatar.Text` components */ foregroundColor?: string; - /** Set the color of the surface behind the avatar – used to manipulate the inner status rings */ + /** Sets the color of the surface behind the avatar, which is used to manipulate the inner status rings */ surfaceColor?: string; /** Applies system styling */ isSystem?: boolean; + /** Sets the avatar's size */ size?: 'extraextrasmall' | 'extrasmall' | 'small' | 'medium' | 'large'; + /** Sets the avatar's status */ status?: 'available' | 'away'; + /** Sets the badge text */ badge?: string | number; } @@ -81,7 +84,6 @@ Avatar.defaultProps = { (Avatar as any).Text = StyledText; -/** @component */ export default Avatar as React.FunctionComponent< IAvatarProps & React.RefAttributes > & {