diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx index d7d37a71e7..0bc9fc5bac 100644 --- a/.storybook/preview.tsx +++ b/.storybook/preview.tsx @@ -101,6 +101,7 @@ const preview: Preview = { }, options: { storySort: { + method: "alphabetical", order: ["Documentation", ["Introduction", "Colors", "Icons"], "Component Library"], }, }, diff --git a/libs/components/src/avatar/avatar.mdx b/libs/components/src/avatar/avatar.mdx new file mode 100644 index 0000000000..c6c5ff78ba --- /dev/null +++ b/libs/components/src/avatar/avatar.mdx @@ -0,0 +1,67 @@ +import { Meta, Story, Primary, Controls } from "@storybook/addon-docs"; + +import * as stories from "./avatar.stories"; + + + +# Avatar + +Avatars display a unique color that helps a user visually recognize their logged in account. + +A variance in color across the avatar component is important as it is used in Account Switching as a +visual indicator to recognize which of a personal or work account a user is logged into. + + + + +## Size + +### Large: 64px + + + +### Default: 48px + + + +### Small 28px + + + +## Background color + +The Background color can be set 3 ways. The color is generated using the following order of +priority: + +- Color +- ID +- Text, usually set to the user's Name field + + +Use the user 'ID' field if `Name` is not defined. + + +## Outline + +If the avatar is displayed on one of the theme's `background` color variables or is interactive, +display the avatar with a 1 pixel `secondary-500` border to meet WCAG AA graphic contrast guidelines +for interactive elements. + + + +## Avatar as a button + +The Avatar can be used as a button. + +Typically this is only in the navigation on client apps where account switching is used and in the +web app for the account menu indicator. + +When the avatar is used as a button, the following states should be used: + +`TODO:` [Jira add stories](https://bitwarden.atlassian.net/browse/CL-101) for button avatars. +[See Figma](https://www.figma.com/file/Zt3YSeb6E6lebAffrNLa0h/Tailwind-Component-Library?type=design&node-id=9730-31746&mode=design&t=IjDIHDb6FZl6bUQW-4) + +## Accessibility + +Avatar background color should have 3.1:1 contrast with it’s background; or include the +`secondary-500` border Avatar text should have 4.5:1 contrast with the avatar background color diff --git a/libs/components/src/badge/badge.mdx b/libs/components/src/badge/badge.mdx new file mode 100644 index 0000000000..1c91944997 --- /dev/null +++ b/libs/components/src/badge/badge.mdx @@ -0,0 +1,67 @@ +import { Meta, Story, Primary, Controls } from "@storybook/addon-docs"; + +import * as stories from "./badge.stories"; + + + +# Badge + +The Badge directive can be used on a `` (non clickable events), or an `` or `