Skip to content

Commit

Permalink
Updated readme based on comments
Browse files Browse the repository at this point in the history
  • Loading branch information
brianacnguyen committed Jul 26, 2023
1 parent 8352322 commit ce805b3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions app/component-library/components/Avatars/Avatar/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Avatar

Avatar is a component that renders any circular graphic, which includes [AvatarAccount](./variants/AvatarAccount/AvatarAccount.tsx), [AvatarFavicon](./variants/AvatarFavicon/AvatarFavicon.tsx), [AvatarIcon](./variants/AvatarIcon/AvatarIcon.tsx), [AvatarNetwork](./variants/AvatarNetwork/AvatarNetwork.tsx) and [AvatarToken](./variants/AvatarToken/AvatarToken.tsx).
The Avatar is a round graphic identity. It unifies [AvatarAccount](./variants/AvatarAccount/AvatarAccount.tsx), [AvatarFavicon](./variants/AvatarFavicon/AvatarFavicon.tsx), [AvatarIcon](./variants/AvatarIcon/AvatarIcon.tsx), [AvatarNetwork](./variants/AvatarNetwork/AvatarNetwork.tsx) and [AvatarToken](./variants/AvatarToken/AvatarToken.tsx).

## Common Props

Expand Down Expand Up @@ -82,7 +82,7 @@ Optional network name.

| <span style="color:gray;font-size:14px">TYPE</span> | <span style="color:gray;font-size:14px">REQUIRED</span> |
| :-------------------------------------------------- | :------------------------------------------------------ |
| [name](./AvatarNetwork.types.ts#L11) | No |
| [name](./variants/AvatarNetwork/AvatarNetwork.types.ts) | No |

### `imageSource`

Expand All @@ -100,7 +100,7 @@ Optional token name.

| <span style="color:gray;font-size:14px">TYPE</span> | <span style="color:gray;font-size:14px">REQUIRED</span> |
| :-------------------------------------------------- | :------------------------------------------------------ |
| [tokenName](./AvatarToken.types.ts#L10) | No |
| [tokenName](./variants/AvatarToken/AvatarToken.types.ts) | No |

### `imageSource`

Expand All @@ -116,7 +116,7 @@ Boolean value that activates halo effect (blurred image colors around).

| <span style="color:gray;font-size:14px">TYPE</span> | <span style="color:gray;font-size:14px">REQUIRED</span> |
| :-------------------------------------------------- | :------------------------------------------------------ |
| [isHaloEnabled](./AvatarToken.types.ts#L18) | No |
| [isHaloEnabled](./variants/AvatarToken/AvatarToken.types.ts) | No |

## Usage

Expand Down

0 comments on commit ce805b3

Please sign in to comment.