From 22df9c501f743f18fc6840b63ce2b3182534161c Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Mon, 8 Jan 2018 11:32:38 -0500 Subject: [PATCH] docs(avatar): update avatar documentation --- packages/core/src/components/avatar/readme.md | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/packages/core/src/components/avatar/readme.md b/packages/core/src/components/avatar/readme.md index 362c20c044..627e32ce5d 100644 --- a/packages/core/src/components/avatar/readme.md +++ b/packages/core/src/components/avatar/readme.md @@ -1,7 +1,28 @@ # ion-avatar -An Avatar is a component that creates a circular image for an item. -Avatars can be placed on the left or right side of an item with the `item-start` or `item-end` directive. +Avatars are circular components that usually wrap an image or icon. They can be used to represent a person or an object. + +Avatars can be used by themselves or inside of any element. If placed inside of an `ion-chip` or `ion-item`, the avatar will resize to fit the parent component. To position an avatar on the left or right side of an item, set the slot to `start` or `end`, respectively. + +```html + + + + + + + + + Chip Avatar + + + + + + + Item Avatar + +```