@altinn/altinn-components 0.0.1 → 0.2.0

package/.storybook/StoryDecorator.tsx

@@ -0,0 +1,27 @@
+import { ReactNode } from "react";
+import styles from "./storyDecorator.module.css";
+
+interface StoryDecoratorProps {
+  tags: string[];
+  theme: string;
+  children: ReactNode;
+}
+
+export const StoryDecorator = ({
+  tags,
+  theme,
+  children,
+}: StoryDecoratorProps) => {
+  const isStable = (tags || []).includes("stable");
+  const state = isStable ? "stable" : "experimental";
+
+  return (
+    <div className={styles.preview} data-theme={theme}>
+      <span className={styles.tag} data-tag={state}>
+        {state}
+      </span>
+
+      <div className={styles.component}>{children}</div>
+    </div>
+  );
+};

package/.storybook/ThemeProvider.tsx

@@ -0,0 +1,16 @@
+import React, { ReactNode } from "react";
+import styles from "./theme.module.css";
+
+export const ThemeProvider = <Theme,>({
+  children,
+  theme,
+}: {
+  children?: ReactNode;
+  theme?: Theme;
+}) => {
+  return (
+    <div className={styles.theme} data-theme={theme}>
+      {children}
+    </div>
+  );
+};

package/.storybook/main.ts

@@ -1,15 +1,14 @@
-import {StorybookConfig} from "@storybook/react-vite";
+import { StorybookConfig } from "@storybook/react-vite";
 
 const config: StorybookConfig = {
-  stories: [
-    "../lib/components/**/*.stories.@(ts|tsx)",
-  ],
+  stories: ["../lib/components/**/*.stories.@(ts|tsx)"],
   addons: [
     "@storybook/addon-onboarding",
     "@storybook/addon-links",
     "@storybook/addon-essentials",
+    "@storybook/addon-themes",
     "@chromatic-com/storybook",
-    "@storybook/addon-interactions",
+    "@storybook/addon-interactions"
   ],
   framework: {
     name: "@storybook/react-vite",

package/.storybook/preview.tsx

@@ -0,0 +1,35 @@
+import { withThemeByDataAttribute } from "@storybook/addon-themes";
+import { Preview, StoryFn } from "@storybook/react";
+import { StoryDecorator } from "./StoryDecorator";
+import "../lib/css/global.css";
+/** @type { import('@storybook/react').Preview } */
+const preview: Preview = {
+    parameters: {
+        controls: {
+            matchers: {
+                color: /(background|color)$/i,
+                date: /Date$/i,
+            },
+        },
+    },
+    decorators: [
+        (Story: StoryFn, data) => {
+            const { tags, globals } = data;
+            return (
+                <StoryDecorator tags={tags} theme={globals?.theme}>
+                    <Story />
+                </StoryDecorator>
+            );
+        },
+        withThemeByDataAttribute({
+            themes: {
+                global: "global",
+                neutral: "neutral",
+                company: "company",
+                person: "person",
+            },
+            defaultTheme: "neutral",
+        }),
+    ],
+};
+export default preview;

package/.storybook/storyDecorator.module.css

@@ -0,0 +1,20 @@
+.preview {
+  display: flex;
+  flex-direction: column;
+  row-gap: 1rem;
+}
+
+.tag {
+  font-size: 1rem;
+  color: #fff;
+}
+
+.tag[data-tag="experimental"] {
+  background-color: #f0ad4e;
+  padding: 0.25rem 0.5rem;
+}
+
+.tag[data-tag="stable"] {
+  background-color: #5cb85c;
+  padding: 0.25rem 0.5rem;
+}

package/.storybook/theme.module.css

@@ -0,0 +1,3 @@
+.theme[data-theme] {
+  background: var(--theme-background-subtle);
+}

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.2.0](https://github.com/Altinn/altinn-components/compare/v0.1.0...v0.2.0) (2024-11-06)
+
+
+### Features
+
+* add dialogs as experimental ([#24](https://github.com/Altinn/altinn-components/issues/24)) ([12b3e4d](https://github.com/Altinn/altinn-components/commit/12b3e4dc81c236eff5a5ab0364b3a7e992606c3a))
+* add meta fields ([#23](https://github.com/Altinn/altinn-components/issues/23)) ([ea8ef87](https://github.com/Altinn/altinn-components/commit/ea8ef87ca03c089e52a331ab62526be2b5acc089))
+* list item + meta tags ([#17](https://github.com/Altinn/altinn-components/issues/17)) ([f865f6c](https://github.com/Altinn/altinn-components/commit/f865f6c226e8f7ce9d4ce18c0014fb4e1c9d0383))
+
+
+### Bug Fixes
+
+* icons for checkbox and radio ([#25](https://github.com/Altinn/altinn-components/issues/25)) ([fb796e2](https://github.com/Altinn/altinn-components/commit/fb796e25636ec0b27ff643a3036ea25171202a11))
+
+## [0.1.0](https://github.com/Altinn/altinn-components/compare/v0.0.1...v0.1.0) (2024-11-01)
+
+
+### Features
+
+* mark Avatar and AvatarGroup as stable ([#14](https://github.com/Altinn/altinn-components/issues/14)) ([fd8bbce](https://github.com/Altinn/altinn-components/commit/fd8bbce2ce59954d8682527b1a9d70bd08b9ccd7))
+
 ## 0.0.1 (2024-10-31)
 
 

package/CONTRIBUTING.MD

@@ -0,0 +1,59 @@
+# Contributing to altinn-components
+
+Thank you for contributing to altinn 3 components! 
+
+This project is a collection of reusable components for building web applications for [Altinn 3](https://docs.altinn.studio/nb/community/about/), and not a general-purpose library.
+If you are looking for a more general-purpose library, you might be looking for [Norwegian public sector's Design system](https://designsystemet.no/).
+
+We appreciate your help in making this project better, and keep in mind that the project is in an early development stage, and we are actively working to improve both the documentation and the codebase.
+
+## Share your feedback and report issues
+
+You can report bugs or suggest new features by going to our [Github Issue Templates](https://github.com/Altinn/altinn-components/issues/new/choose).
+We also welcome questions and feedback. 
+
+## I Want To Contribute
+
+### Getting started with development
+Follow these steps to set up Storybook and the necessary tools for development.
+
+#### Prerequisites for local development and storybook
+
+- The project uses `pnpm` as package manager. It is recommended to use install and use correct version of `pnpm` by using `corepack`, cf. [Using corepack section](https://pnpm.io/installation).
+- Install dependencies with `pnpm install`
+- Required node version is `20.x` or higher.
+
+#### Storybook
+Run storybook with `pnpm storybook` and navigate to `http://localhost:6006/` in your browser.
+
+### Pull requests
+A lot has been written already about how to write good pull requests. [Here are some](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests) tips to make the process smoother.
+
+## Style guides
+
+### Code Style
+This project uses [`Biome`](https://biomejs.dev/) for linting and formatting. The configuration is found in the `biome.jsonc` file.
+We recommend using the `biome` CLI to lint and format your code before committing, or using the `biome` extension in your IDE.
+
+Use `pnpm format` to format staged files.
+
+### Commit Messages
+
+This project uses Changesets with the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+specification in order to generate changelogs, communicating the nature of changes.
+
+To include commits in the changelog, please ensure that you include the following keywords:
+
+- Start the commit with `fix:` to trigger a patch (0.0.x) version.
+- Start the commit with `feat:` to trigger a minor (0.x.0) version.
+
+Other keywords are also supported, but will not trigger a version bump. These keywords include:
+- `chore:` for changes that do not affect the end user, such as refactoring or updating dependencies.
+- `docs:` for changes to the documentation.
+- `refactor:` for changes that neither fixes a bug nor adds a feature. but improves the codebase.
+
+To make the changelog more specific, you have the option to scope your commits by adding a keyword in parentheses that indicates the area or aspect you are working on. 
+For example:
+- Modifying documentation for contributing: `docs(contributing): add a section on commit messages`.
+- Fixing a bug in the Avatar component: `fix(avatar): fix bug with incorrect image size`.
+

package/README.md

@@ -1,2 +1,34 @@
 # altinn-components
-Reusable react components
+This package is a set of reusable components for building web applications for [Altinn 3](https://docs.altinn.studio/nb/community/about/).
+This is *not* a general purpose library, but a library of components that are specifically designed for the Altinn platform, to ensure
+a consistent look and feel across all applications. It also contains a storybook with stories explaining the purpose and usage of each component, and
+with real examples of how to use them separately or together (composition).
+
+## Installation
+To install the package, run the following command:
+
+```bash
+# for npm users
+npm install @altinn/components
+# for yarn users
+yarn add @altinn/components 
+# for pnpm users
+pnpm add @altinn/components
+```
+Tested with Node.js 20.x <
+
+## Usage
+To use the components in your application, you need to import the components you want to use from the package. For example:
+
+```tsx
+// example: import the Avatar component and type
+import { Avatar, type AvatarVariant } from '@altinn/components';
+```
+and import the css file in your application once:
+```ts
+import '@altinn/components/dist/index.css';
+```
+for correct `font-family` and minimal collection of resets.
+
+## Documentation
+The documentation for the components can be found in the storybook, cf. [TODO ADD Storybook]()

package/lib/components/Attachment/AttachmentLink.stories.ts

@@ -0,0 +1,21 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { fn } from '@storybook/test';
+
+import { AttachmentLink } from './AttachmentLink';
+
+const meta = {
+  title: 'Attachment/AttachmentLink',
+  component: AttachmentLink,
+  tags: ['autodocs'],
+  parameters: {},
+  args: {
+    label: 'Document.pdf',
+  },
+} satisfies Meta<typeof AttachmentLink>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/lib/components/Attachment/AttachmentLink.tsx

@@ -0,0 +1,20 @@
+import { Icon, type IconName } from '../Icon';
+import styles from './attachmentLink.module.css';
+
+export interface AttachmentLinkProps {
+  /** Link url */
+  href: string;
+  /** Label (filename) */
+  label: string;
+  /** Icon */
+  icon?: IconName;
+}
+
+export const AttachmentLink = ({ icon = 'file', href, label }: AttachmentLinkProps) => {
+  return (
+    <a href={href} className={styles.link}>
+      <Icon name={icon} className={styles.icon} />
+      <span className={styles.label}>{label}</span>
+    </a>
+  );
+};

package/lib/components/Attachment/AttachmentList.stories.ts

@@ -0,0 +1,39 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { fn } from '@storybook/test';
+
+import { AttachmentList } from './AttachmentList';
+
+const meta = {
+  title: 'Attachment/AttachmentList',
+  component: AttachmentList,
+  tags: ['autodocs'],
+  parameters: {
+    layout: 'fullscreen',
+  },
+  args: {
+    items: [
+      {
+        label: '1-0 Castro.pdf',
+      },
+      {
+        label: '2-0 Kornvig.pdf',
+      },
+      {
+        label: '3-0 Kartum.pdf',
+      },
+      {
+        label: '3-1 Zinkernagel.pdf',
+      },
+      {
+        label: '4-1 Castro.pdf',
+      },
+    ],
+  },
+} satisfies Meta<typeof AttachmentList>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/lib/components/Attachment/AttachmentList.tsx

@@ -0,0 +1,26 @@
+import type { TypographySize } from '../Typography';
+import { AttachmentLink, type AttachmentLinkProps } from './AttachmentLink';
+import styles from './attachmentList.module.css';
+
+export interface AttachmentListProps {
+  items: AttachmentLinkProps[];
+  size?: TypographySize;
+}
+
+export const AttachmentList = ({ size, items }: AttachmentListProps) => {
+  if (!items.length) {
+    return null;
+  }
+
+  return (
+    <ul className={styles.list} data-size={size}>
+      {items.map((item, index) => {
+        return (
+          <li key={index} className={styles.item}>
+            <AttachmentLink {...item} key={'attachment' + index} />
+          </li>
+        );
+      })}
+    </ul>
+  );
+};

package/lib/components/Attachment/attachmentLink.module.css

@@ -0,0 +1,20 @@
+.link {
+  display: inline-flex;
+  align-items: start;
+  column-gap: 0.25em;
+  color: var(--theme-base-default);
+}
+
+.link:hover {
+  color: var(--theme-base-hover);
+}
+
+.label {
+  text-decoration: underline;
+  text-decoration-thickness: 2px;
+  text-underline-offset: 2px;
+}
+
+.icon {
+  font-size: 1.5em;
+}

package/lib/components/Attachment/attachmentList.module.css

@@ -0,0 +1,12 @@
+.list {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  display: flex;
+  flex-direction: column;
+}
+
+.item {
+  padding: 0;
+  margin: 0;
+}

package/lib/components/Attachment/index.ts

@@ -0,0 +1,2 @@
+export * from './AttachmentLink';
+export * from './AttachmentList';

package/lib/components/Avatar/Avatar.tsx

@@ -6,8 +6,9 @@ import { fromStringToColor } from './color';
 
 export type AvatarType = 'company' | 'person' | 'custom';
 export type AvatarSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
-export type AvatarVariant = 'square' | 'circle';
-export type AvatarColor = 'dark' | 'light';
+
+type AvatarVariant = 'square' | 'circle';
+type AvatarColor = 'dark' | 'light';
 
 /**
  * Props for the Avatar component.
@@ -19,10 +20,6 @@ export interface AvatarProps {
   type?: AvatarType;
   /** The size of the avatar. */
   size?: AvatarSize;
-  /** The variant of the avatar shape. */
-  variant?: AvatarVariant;
-  /** The color theme of the avatar. */
-  color?: AvatarColor;
   /** Additional class names to apply to the avatar. */
   className?: string;
   /** URL of the image to display in the avatar. */
@@ -39,10 +36,8 @@ export interface AvatarProps {
  * Avatar component to display user or company avatars with various customization options.
  */
 export const Avatar = ({
-  type,
+  type = 'person',
   size = 'sm',
-  variant,
-  color,
   name = 'Avatar',
   outline = false,
   imageUrl,
@@ -51,13 +46,10 @@ export const Avatar = ({
   className,
 }: AvatarProps): JSX.Element => {
   const [hasImageError, setHasImageError] = useState<boolean>(false);
+  const variant: AvatarVariant = type === 'person' ? 'circle' : 'square';
+  const color: AvatarColor = type === 'person' ? 'light' : 'dark';
 
-  const defaultVariant = type === 'person' ? 'circle' : 'square';
-  const defaultColor = type === 'person' ? 'light' : 'dark';
-  const appliedVariant = variant || defaultVariant;
-  const appliedColor = color || defaultColor;
-
-  const { backgroundColor, foregroundColor } = fromStringToColor(name, appliedColor);
+  const { backgroundColor, foregroundColor } = fromStringToColor(name, color);
   const initials = (name[0] ?? '').toUpperCase();
   const usingImageUrl = imageUrl && !hasImageError;
 
@@ -70,7 +62,7 @@ export const Avatar = ({
 
   return (
     <div
-      className={cx(styles.avatar, styles[appliedVariant], styles[size], { [styles.outline]: outline }, className)}
+      className={cx(styles.avatar, styles[variant], styles[size], { [styles.outline]: outline }, className)}
       style={inlineStyles}
       aria-hidden
     >

package/lib/components/Avatar/AvatarGroup.stories.ts

@@ -1,12 +1,11 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { fn } from '@storybook/test';
 import { AvatarGroup } from './AvatarGroup';
 
 const meta = {
   title: 'Avatar/AvatarGroup',
   component: AvatarGroup,
   // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
-  tags: ['autodocs'],
+  tags: ['autodocs', 'stable'],
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
     //    layout: 'fullscreen',
@@ -19,7 +18,7 @@ type Story = StoryObj<typeof meta>;
 
 export const People: Story = {
   args: {
-    type: 'person',
+    defaultType: 'person',
     items: [
       {
         name: 'Albert Åberg',
@@ -36,7 +35,7 @@ export const People: Story = {
 
 export const Companies: Story = {
   args: {
-    type: 'company',
+    defaultType: 'company',
     items: [
       {
         name: 'Albert Åberg',

package/lib/components/Avatar/AvatarGroup.tsx

@@ -3,15 +3,32 @@ import { useMemo } from 'react';
 import { Avatar, type AvatarProps, type AvatarSize, type AvatarType } from '.';
 import styles from './avatarGroup.module.css';
 
+/**
+ * Props for the AvatarGroup components.
+ */
 export interface AvatarGroupProps {
+  /** Array of avatars to display in the group, each specified by AvatarProps. */
   items?: AvatarProps[];
+  /** Maximum number of avatars to show in the group. Remaining avatars are summarized in a "+X" label. */
   maxItemsCount?: number;
-  type?: AvatarType;
+  /** Default avatar type to apply if not specified in individual items. This affects the styling. */
+  defaultType?: AvatarType;
+  /** Size of all avatars in the group (e.g., 'sm', 'md', 'lg'). */
   size?: AvatarSize;
+  /** Additional CSS class for styling the avatar group container. */
   className?: string;
 }
 
-export const AvatarGroup = ({ items = [], maxItemsCount = 4, type, size = 'sm', className }: AvatarGroupProps) => {
+/**
+ * Avatar group component for displaying multiple avatars as a group.
+ */
+export const AvatarGroup = ({
+  items = [],
+  maxItemsCount = 4,
+  defaultType,
+  size = 'sm',
+  className,
+}: AvatarGroupProps) => {
   const maxItems = useMemo(() => items.slice(0, maxItemsCount), [items, maxItemsCount]);
 
   if (items?.length === 0) {
@@ -30,7 +47,7 @@ export const AvatarGroup = ({ items = [], maxItemsCount = 4, type, size = 'sm',
               customLabel={customLabel}
               imageUrl={avatar.imageUrl}
               imageUrlAlt={avatar.imageUrlAlt}
-              type={avatar?.type || type}
+              type={avatar?.type || defaultType}
               size={size}
               outline
             />

package/lib/components/Avatar/avatar.module.css

@@ -1,4 +1,6 @@
 .avatar {
+  flex-grow: 0;
+  flex-shrink: 0;
   display: flex;
   justify-content: center;
   align-items: center;

package/lib/components/Avatar/avatar.stories.tsx

@@ -4,13 +4,11 @@ import { Avatar } from './';
 const meta = {
   title: 'Avatar/Avatar',
   component: Avatar,
-  tags: ['autodocs'],
+  tags: ['autodocs', 'stable'],
   parameters: {},
   args: {
     name: 'Jane Doe',
     type: 'person',
-    variant: 'circle',
-    color: 'light',
     size: 'xl',
   },
 } satisfies Meta<typeof Avatar>;
@@ -30,15 +28,12 @@ export const Company: Story = {
   args: {
     type: 'company',
     name: 'Boligeksperten',
-    variant: 'square',
   },
 };
 
 export const Logo: Story = {
   args: {
-    variant: 'square',
     imageUrl: 'https://avatars.githubusercontent.com/u/1536293?s=200&v=4',
     size: 'xl',
-    color: 'dark',
   },
 };

package/lib/components/Badge/Badge.stories.ts

@@ -0,0 +1,32 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { Badge } from './Badge';
+
+const meta = {
+  title: 'Atoms/Badge/Badge',
+  component: Badge,
+  tags: ['autodocs'],
+  parameters: {},
+  args: {
+    label: 'Badge',
+  },
+} satisfies Meta<typeof Badge>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};
+
+export const Alert: Story = {
+  args: {
+    color: 'alert',
+  },
+};
+
+export const UnreadCount: Story = {
+  args: {
+    label: '2',
+    color: 'alert',
+  },
+};

package/lib/components/Badge/Badge.tsx

@@ -2,18 +2,21 @@ import cx from 'classnames';
 import type { ReactNode } from 'react';
 import styles from './badge.module.css';
 
-interface BadgeProps {
+export type BadgeColor = 'subtle' | 'alert';
+export type BadgeSize = 'sm';
+
+export interface BadgeProps {
   label?: string | number;
-  variant?: 'neutral' | 'strong';
-  size?: 'medium' | 'small';
+  color?: BadgeColor;
+  size?: BadgeSize;
+  className?: string;
   children?: ReactNode;
 }
 
-// TODO: add aria-label to the badge
-export const Badge = ({ label, variant = 'neutral', size = 'medium', children }: BadgeProps) => {
-  const classNames = cx(styles.badge, {
-    [styles.strong]: variant === 'strong',
-    [styles.small]: size === 'small',
-  });
-  return <span className={classNames}>{label || children}</span>;
+export const Badge = ({ label, color = 'subtle', size = 'sm', className, children }: BadgeProps) => {
+  return (
+    <span className={cx(styles.badge, className)} data-color={color} data-size={size}>
+      <span className={styles.label}>{label || children}</span>
+    </span>
+  );
 };