feat: Add Avatar component

packages/css/src/components/avatar/README.md

@@ -0,0 +1,13 @@
+<!-- @license CC0-1.0 -->
+
+# Avatar
+
+A prominently coloured circular button containing two initials of a currently logged-in user.
+
+Clicking or tapping the button would typically open a context menu or view with information and actions related to the user.
+
+## Design
+
+The avatar contains two initial letters from the user's full name.
+The default background colour is dark blue.
+Suggestions on when to use the other colours will follow soon.

packages/css/src/components/avatar/avatar.scss

@@ -0,0 +1,70 @@
+/**
+ * @license EUPL-1.2+
+ * Copyright Gemeente Amsterdam
+ */
+
+.ams-avatar {
+  border-radius: 50%;
+  border-style: var(--ams-avatar-border-style);
+  border-width: var(--ams-avatar-border-width);
+  display: inline-block;
+  font-family: var(--ams-avatar-font-family);
+  font-size: var(--ams-avatar-font-size);
+  line-height: var(--ams-avatar-line-height);
+  min-width: 1lh;
+  text-align: center;
+}
+
+.ams-avatar--blue {
+  background-color: var(--ams-avatar-blue-background-color);
+  border-color: var(--ams-avatar-blue-background-color);
+  color: var(--ams-avatar-blue-color);
+}
+
+.ams-avatar--dark-blue {
+  background-color: var(--ams-avatar-dark-blue-background-color);
+  border-color: var(--ams-avatar-dark-blue-background-color);
+  color: var(--ams-avatar-dark-blue-color);
+}
+
+.ams-avatar--dark-green {
+  background-color: var(--ams-avatar-dark-green-background-color);
+  border-color: var(--ams-avatar-dark-green-background-color);
+  color: var(--ams-avatar-dark-green-color);
+}
+
+.ams-avatar--green {
+  background-color: var(--ams-avatar-green-background-color);
+  border-color: var(--ams-avatar-green-background-color);
+  color: var(--ams-avatar-green-color);
+}
+
+.ams-avatar--magenta {
+  background-color: var(--ams-avatar-magenta-background-color);
+  border-color: var(--ams-avatar-magenta-background-color);
+  color: var(--ams-avatar-magenta-color);
+}
+
+.ams-avatar--orange {
+  background-color: var(--ams-avatar-orange-background-color);
+  border-color: var(--ams-avatar-orange-background-color);
+  color: var(--ams-avatar-orange-color);
+}
+
+.ams-avatar--purple {
+  background-color: var(--ams-avatar-purple-background-color);
+  border-color: var(--ams-avatar-purple-background-color);
+  color: var(--ams-avatar-purple-color);
+}
+
+.ams-avatar--red {
+  background-color: var(--ams-avatar-red-background-color);
+  border-color: var(--ams-avatar-red-background-color);
+  color: var(--ams-avatar-red-color);
+}
+
+.ams-avatar--yellow {
+  background-color: var(--ams-avatar-yellow-background-color);
+  border-color: var(--ams-avatar-yellow-background-color);
+  color: var(--ams-avatar-yellow-color);
+}

packages/css/src/components/index.scss

@@ -4,6 +4,7 @@
  */
 
 /* Append here */
+@import "./avatar/avatar";
 @import "./row/row";
 @import "./radio/radio";
 @import "./tabs/tabs";

packages/react/src/Avatar/Avatar.test.tsx

@@ -0,0 +1,67 @@
+import { render } from '@testing-library/react'
+import { createRef } from 'react'
+import { Avatar, avatarColors } from './Avatar'
+import '@testing-library/jest-dom'
+
+describe('Avatar', () => {
+  it('renders', () => {
+    const { container } = render(<Avatar label="NR" />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(component).toBeInTheDocument()
+    expect(component).toBeVisible()
+  })
+
+  it('renders a design system BEM class name', () => {
+    const { container } = render(<Avatar label="RS" />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(component).toHaveClass('ams-avatar')
+  })
+
+  it('renders an additional class name', () => {
+    const { container } = render(<Avatar label="VS" className="extra" />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(component).toHaveClass('ams-avatar extra')
+  })
+
+  it('supports ForwardRef in React', () => {
+    const ref = createRef<HTMLElement>()
+
+    const { container } = render(<Avatar label="AL" ref={ref} />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(ref.current).toBe(component)
+  })
+
+  it('renders a label consisting of two letters', () => {
+    const { container } = render(<Avatar label="RS" />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(component?.textContent).toHaveLength(2)
+  })
+
+  it('renders with default color', () => {
+    const { container } = render(<Avatar label="VS" />)
+
+    const component = container.querySelector(':only-child')
+
+    expect(component).toHaveClass('ams-avatar--dark-blue')
+  })
+
+  avatarColors.map((color) =>
+    it(`renders with ${color} color`, () => {
+      const { container } = render(<Avatar label="AL" color={color} />)
+
+      const component = container.querySelector(':only-child')
+
+      expect(component).toHaveClass(`ams-avatar--${color}`)
+    }),
+  )
+})

packages/react/src/Avatar/Avatar.tsx

@@ -0,0 +1,61 @@
+/**
+ * @license EUPL-1.2+
+ * Copyright Gemeente Amsterdam
+ */
+
+import clsx from 'clsx'
+import { forwardRef, useMemo } from 'react'
+import type { ForwardedRef, HTMLAttributes } from 'react'
+
+export const avatarColors = [
+  'blue',
+  'dark-blue',
+  'dark-green',
+  'green',
+  'magenta',
+  'orange',
+  'purple',
+  'red',
+  'yellow',
+] as const
+
+type AvatarColor = (typeof avatarColors)[number]
+
+export type AvatarProps = {
+  color?: AvatarColor
+  label: string
+} & HTMLAttributes<HTMLElement>
+
+export const Avatar = forwardRef(
+  ({ label, className, color = 'dark-blue', ...restProps }: AvatarProps, ref: ForwardedRef<HTMLElement>) => {
+    if (label.length !== 2) {
+      // TODO: should we log this somewhere or throw an error to the consumer?
+      console.warn(`Avatar label should be no more and no less than two characters. Got: "${label}".`)
+    }
+
+    const initials = useMemo(() => {
+      if (label.length === 0) {
+        return 'n.b.'
+      } else if (label.length > 2) {
+        return label.slice(0, 2).toUpperCase()
+      } else {
+        return label.toUpperCase()
+      }
+    }, [label])
+
+    const initialsDotted = useMemo(() => `${initials.split('').join('.')}.`, [initials])
+
+    return (
+      <span
+        {...restProps}
+        ref={ref}
+        className={clsx('ams-avatar', `ams-avatar--${color}`, className)}
+        aria-label={`Initialen gebruiker: ${initialsDotted}`}
+      >
+        {initials}
+      </span>
+    )
+  },
+)
+
+Avatar.displayName = 'Avatar'

packages/react/src/Avatar/README.md

@@ -0,0 +1,5 @@
+<!-- @license CC0-1.0 -->
+
+# React Avatar component
+
+[Avatar documentation](../../../css/src/components/avatar/README.md)

packages/react/src/Avatar/index.ts

@@ -0,0 +1,2 @@
+export { Avatar } from './Avatar'
+export type { AvatarProps } from './Avatar'

packages/react/src/index.ts

@@ -4,6 +4,7 @@
  */
 
 /* Append here */
+export * from './Avatar'
 export * from './Row'
 export * from './Radio'
 export * from './Tabs'

proprietary/tokens/src/components/ams/avatar.tokens.json

@@ -0,0 +1,48 @@
+{
+  "ams": {
+    "avatar": {
+      "border-width": { "value": "{ams.border-width.md}" },
+      "border-style": { "value": "solid" },
+      "font-family": { "value": "{ams.text.font-family}" },
+      "font-size": { "value": "{ams.text.level.6.font-size}" },
+      "font-weight": { "value": "{ams.text.font-weight.normal}" },
+      "line-height": { "value": "{ams.text.level.6.line-height}" },
+      "blue": {
+        "background-color": { "value": "{ams.color.blue}" },
+        "color": { "value": "{ams.color.primary-black}" }
+      },
+      "dark-blue": {
+        "background-color": { "value": "{ams.color.primary-blue}" },
+        "color": { "value": "{ams.color.primary-white}" }
+      },
+      "dark-green": {
+        "background-color": { "value": "{ams.color.dark-green}" },
+        "color": { "value": "{ams.color.primary-white}" }
+      },
+      "green": {
+        "background-color": { "value": "{ams.color.green}" },
+        "color": { "value": "{ams.color.primary-black}" }
+      },
+      "magenta": {
+        "background-color": { "value": "{ams.color.magenta}" },
+        "color": { "value": "{ams.color.primary-white}" }
+      },
+      "orange": {
+        "background-color": { "value": "{ams.color.orange}" },
+        "color": { "value": "{ams.color.primary-black}" }
+      },
+      "purple": {
+        "background-color": { "value": "{ams.color.purple}" },
+        "color": { "value": "{ams.color.primary-white}" }
+      },
+      "red": {
+        "background-color": { "value": "{ams.color.primary-red}" },
+        "color": { "value": "{ams.color.primary-white}" }
+      },
+      "yellow": {
+        "background-color": { "value": "{ams.color.yellow}" },
+        "color": { "value": "{ams.color.primary-black}" }
+      }
+    }
+  }
+}

storybook/src/components/Avatar/Avatar.docs.mdx

@@ -0,0 +1,15 @@
+import { Controls, Markdown, Meta, Primary } from "@storybook/blocks";
+import * as AvatarStories from "./Avatar.stories.tsx";
+import README from "../../../../packages/css/src/components/avatar/README.md?raw";
+
+<Meta of={AvatarStories} />
+
+<Markdown>{README}</Markdown>
+
+## Stories
+
+### Default
+
+<Primary />
+
+<Controls />

storybook/src/components/Avatar/Avatar.stories.tsx

@@ -0,0 +1,30 @@
+/**
+ * @license EUPL-1.2+
+ * Copyright Gemeente Amsterdam
+ */
+
+import { Avatar } from '@amsterdam/design-system-react'
+import { Meta, StoryObj } from '@storybook/react'
+
+const meta = {
+  title: 'Components/Feedback/Avatar',
+  component: Avatar,
+  args: {
+    label: 'DS',
+  },
+  argTypes: {
+    color: {
+      control: {
+        type: 'select',
+      },
+      options: ['blue', 'dark-blue', 'dark-green', 'green', 'magenta', 'orange', 'purple', 'red', 'yellow'],
+      selected: 'dark-blue',
+    },
+  },
+} satisfies Meta<typeof Avatar>
+
+export default meta
+
+type Story = StoryObj<typeof meta>
+
+export const Default: Story = {}