akeneo-design-system 0.1.226 → 0.1.227

package/lib/components/index.d.ts

@@ -1,3 +1,5 @@
+export * from './Avatar/Avatar';
+export * from './Avatar/Avatars';
 export * from './Badge/Badge';
 export * from './Block/Block';
 export * from './BlockButton/BlockButton';

package/lib/components/index.js

@@ -10,6 +10,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Avatar/Avatar"), exports);
+__exportStar(require("./Avatar/Avatars"), exports);
 __exportStar(require("./Badge/Badge"), exports);
 __exportStar(require("./Block/Block"), exports);
 __exportStar(require("./BlockButton/BlockButton"), exports);

package/lib/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA8B;AAC9B,gDAA8B;AAC9B,4DAA0C;AAC1C,0DAAwC;AACxC,kDAAgC;AAChC,8CAA4B;AAC5B,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,gDAA8B;AAC9B,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,gDAA8B;AAC9B,4DAA0C;AAC1C,0CAAwB;AACxB,wDAAsC;AACtC,8CAA4B;AAC5B,8CAA4B;AAC5B,kDAAgC;AAChC,0DAAwC;AACxC,gDAA8B;AAC9B,+CAA6B;AAC7B,0DAAwC;AACxC,8CAA4B;AAC5B,4DAA0C;AAC1C,oDAAkC;AAClC,4DAA0C;AAC1C,wEAAsD;AACtD,kDAAgC;AAChC,8DAA4C;AAC5C,kEAAgD;AAChD,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B;AAC5B,gDAA8B;AAC9B,oDAAkC;AAClC,8CAA4B;AAC5B,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,gDAA8B;AAC9B,4DAA0C;AAC1C,0DAAwC;AACxC,kDAAgC;AAChC,8CAA4B;AAC5B,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,gDAA8B;AAC9B,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,gDAA8B;AAC9B,4DAA0C;AAC1C,0CAAwB;AACxB,wDAAsC;AACtC,8CAA4B;AAC5B,8CAA4B;AAC5B,kDAAgC;AAChC,0DAAwC;AACxC,gDAA8B;AAC9B,+CAA6B;AAC7B,0DAAwC;AACxC,8CAA4B;AAC5B,4DAA0C;AAC1C,oDAAkC;AAClC,4DAA0C;AAC1C,wEAAsD;AACtD,kDAAgC;AAChC,8DAA4C;AAC5C,kEAAgD;AAChD,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B;AAC5B,gDAA8B;AAC9B,oDAAkC;AAClC,8CAA4B;AAC5B,oDAAkC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akeneo-design-system",
-  "version": "0.1.226",
+  "version": "0.1.227",
   "description": "Akeneo design system",
   "main": "lib/index.js",
   "scripts": {

package/src/components/Avatar/Avatar.stories.mdx

@@ -0,0 +1,147 @@
+import {Meta, Story, ArgsTable, Canvas} from '@storybook/addon-docs';
+import {Avatar} from './Avatar.tsx';
+import {Avatars} from './Avatars.tsx';
+
+<Meta
+  title="Components/Avatar"
+  component={Avatar}
+  argTypes={{
+    firstName: {control: {type: 'text'}},
+    lastName: {control: {type: 'text'}},
+    username: {control: {type: 'text'}},
+    avatarUrl: {control: {type: 'text'}},
+    size: {control: {type: 'select', options: ['default', 'big']}},
+  }}
+  args={{
+    firstName: 'John',
+    lastName: 'Doe',
+    username: 'admin',
+    avatarUrl: undefined,
+    size: 'default',
+  }}
+/>
+
+# Avatar
+
+## Usage
+
+This component is used to display users avatars. If no avatar is available, first letters of the first and last name are
+displayed with a dedicated color.
+
+## Playground
+
+<Canvas>
+  <Story name="Standard">
+    {args => {
+      return <Avatar firstName={'John'} lastName={'Doe'} username={'admin'} {...args} />;
+    }}
+  </Story>
+</Canvas>
+
+<ArgsTable story="Standard" />
+
+## Variation on background colors
+
+The background color is based from the username.
+
+<Canvas>
+  <Story name="Background colors">
+    {args => {
+      return (
+        <>
+          <Avatar {...args} firstName={'Albert'} lastName={'Doe'} username={'a'} />
+          <Avatar {...args} firstName={'Bertrand'} lastName={'Doe'} username={'b'} />
+          <Avatar {...args} firstName={'Chris'} lastName={'Doe'} username={'c'} />
+          <Avatar {...args} firstName={'Danny'} lastName={'Doe'} username={'d'} />
+          <Avatar {...args} firstName={'Elon'} lastName={'Doe'} username={'e'} />
+          <Avatar {...args} firstName={'Fred'} lastName={'Doe'} username={'f'} />
+          <Avatar {...args} firstName={'Gus'} lastName={'Doe'} username={'g'} />
+          <Avatar {...args} firstName={'Helen'} lastName={'Doe'} username={'h'} />
+          <Avatar {...args} firstName={'Isabel'} lastName={'Doe'} username={'i'} />
+          <Avatar {...args} firstName={'John'} lastName={'Doe'} username={'j'} />
+          <Avatar {...args} firstName={'Kurt'} lastName={'Doe'} username={'k'} />
+          <Avatar {...args} firstName={'Leonard'} lastName={'Doe'} username={'l'} />
+        </>
+      );
+    }}
+  </Story>
+</Canvas>
+
+## Variation with image
+
+<Canvas>
+  <Story name="With image">
+    {args => {
+      return (
+        <>
+          <Avatar {...args} avatarUrl={'https://picsum.photos/seed/akeneo/32/32'} />
+        </>
+      );
+    }}
+  </Story>
+</Canvas>
+
+## Variation on List
+
+You can use a dedicated component to display avatar list. After a defined maximum, other avatars are not displayed.
+
+<Canvas>
+  <Story name="Avatar list">
+    {args => {
+      return (
+        <>
+          <Avatars
+            max={5}
+            title="Helen Doe&#10;Isabel Doe&#10;John Doe&#10;Kurt Doe&#10;Leonard Doe"
+          >
+            <Avatar
+              {...args}
+              firstName={'Albert'}
+              lastName={'Doe'}
+              username={'a'}
+              avatarUrl={'https://picsum.photos/seed/akeneo/32/32'}
+            />
+            <Avatar {...args} firstName={'Bertrand'} lastName={'Doe'} username={'b'} />
+            <Avatar
+              {...args}
+              firstName={'Chris'}
+              lastName={'Doe'}
+              username={'c'}
+              avatarUrl={'https://picsum.photos/seed/bkeneo/32/32'}
+            />
+            <Avatar {...args} firstName={'Danny'} lastName={'Doe'} username={'d'} />
+            <Avatar
+              {...args}
+              firstName={'Elon'}
+              lastName={'Doe'}
+              username={'e'}
+              avatarUrl={'https://picsum.photos/seed/ckeneo/32/32'}
+            />
+            <Avatar {...args} firstName={'Fred'} lastName={'Doe'} username={'f'} />
+            <Avatar {...args} firstName={'Gus'} lastName={'Doe'} username={'g'} />
+            <Avatar {...args} firstName={'Helen'} lastName={'Doe'} username={'h'} />
+            <Avatar {...args} firstName={'Isabel'} lastName={'Doe'} username={'i'} />
+            <Avatar {...args} firstName={'John'} lastName={'Doe'} username={'j'} />
+            <Avatar {...args} firstName={'Kurt'} lastName={'Doe'} username={'k'} />
+            <Avatar {...args} firstName={'Leonard'} lastName={'Doe'} username={'l'} />
+          </Avatars>
+        </>
+      );
+    }}
+  </Story>
+</Canvas>
+
+## Variation on Size
+
+<Canvas>
+  <Story name="Avatar size">
+    {args => {
+      return (
+        <>
+          <Avatar {...args} size={'default'} />
+          <Avatar {...args} size={'big'} />
+        </>
+      );
+    }}
+  </Story>
+</Canvas>

package/src/components/Avatar/Avatar.tsx

@@ -0,0 +1,102 @@
+import React, {useMemo} from 'react';
+import styled, {css} from 'styled-components';
+import {useTheme} from '../../hooks';
+import {Override} from '../../shared';
+import {AkeneoThemedProps, getColor} from '../../theme';
+
+const AvatarContainer = styled.span<AvatarProps & AkeneoThemedProps>`
+  ${({size}) =>
+    size === 'default'
+      ? css`
+          height: 32px;
+          width: 32px;
+          line-height: 32px;
+          font-size: 15px;
+          border-radius: 32px;
+        `
+      : css`
+          height: 140px;
+          width: 140px;
+          line-height: 140px;
+          font-size: 66px;
+          border-radius: 140px;
+        `}
+  display: inline-block;
+  color: ${getColor('white')};
+  text-align: center;
+  background-position: center;
+  background-repeat: no-repeat;
+  background-size: cover;
+  text-transform: uppercase;
+  cursor: ${({onClick}) => (onClick ? 'pointer' : 'default')};
+`;
+
+type AvatarProps = Override<
+  React.HTMLAttributes<HTMLSpanElement>,
+  {
+    /**
+     * Username to use as fallback if the avatar is not provided and the Firstname and Lastname are empty.
+     */
+    username: string;
+
+    /**
+     * Firstname to use as fallback with the Lastname if the avatar is not provided.
+     */
+    firstName: string;
+
+    /**
+     * Lastname to use as fallback with the Firstname if the avatar is not provided.
+     */
+    lastName: string;
+
+    /**
+     * Url of the avatar image.
+     */
+    avatarUrl?: string;
+
+    /**
+     * Size of the avatar.
+     */
+    size?: 'default' | 'big';
+  }
+>;
+
+const Avatar = ({username, firstName, lastName, avatarUrl, size = 'default', ...rest}: AvatarProps) => {
+  const theme = useTheme();
+
+  const fallback = (
+    firstName.trim().charAt(0) + lastName.trim().charAt(0) || username.substring(0, 2)
+  ).toLocaleUpperCase();
+  const title = `${firstName} ${lastName}`.trim() || username;
+
+  const backgroundColor = useMemo(() => {
+    const colorId = username.split('').reduce<number>((s, l) => s + l.charCodeAt(0), 0);
+    const colors = [
+      theme.colorAlternative.green120,
+      theme.colorAlternative.darkCyan120,
+      theme.colorAlternative.forestGreen120,
+      theme.colorAlternative.oliveGreen120,
+      theme.colorAlternative.blue120,
+      theme.colorAlternative.darkBlue120,
+      theme.colorAlternative.hotPink120,
+      theme.colorAlternative.red120,
+      theme.colorAlternative.coralRed120,
+      theme.colorAlternative.yellow120,
+      theme.colorAlternative.orange120,
+      theme.colorAlternative.chocolate120,
+    ];
+
+    return colors[colorId % colors.length];
+  }, [theme, username]);
+
+  const style = avatarUrl ? {backgroundImage: `url(${avatarUrl})`} : {backgroundColor};
+
+  return (
+    <AvatarContainer size={size} {...rest} style={style} title={title}>
+      {avatarUrl ? '' : fallback}
+    </AvatarContainer>
+  );
+};
+
+export {Avatar};
+export type {AvatarProps};

package/src/components/Avatar/Avatar.unit.tsx

@@ -0,0 +1,79 @@
+import React from 'react';
+import {render, screen} from '../../storybook/test-util';
+import {Avatar} from './Avatar';
+
+test('renders', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toBeInTheDocument();
+});
+
+test('avatar image', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" avatarUrl="path/to/image" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toHaveStyle('background-image: url(path/to/image)');
+});
+
+test('deterministic fallback color', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toHaveStyle('background-color: rgb(68, 31, 0)');
+});
+
+test('fallback to firstname + lastname', () => {
+  render(<Avatar username="" firstName="John" lastName="Doe" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toHaveTextContent('JD');
+});
+
+test('fallback to firstname only', () => {
+  render(<Avatar username="" firstName="John" lastName="" />);
+
+  const avatar = screen.getByTitle('John');
+  expect(avatar).toHaveTextContent('J');
+});
+
+test('fallback to lastname only', () => {
+  render(<Avatar username="" firstName="" lastName="Doe" />);
+
+  const avatar = screen.getByTitle('Doe');
+  expect(avatar).toHaveTextContent('D');
+});
+
+test('fallback to username', () => {
+  render(<Avatar username="john" firstName="" lastName="" />);
+
+  const avatar = screen.getByTitle('john');
+  expect(avatar).toHaveTextContent('JO');
+});
+
+test('initial are converted to uppercase', () => {
+  render(<Avatar username="" firstName="john" lastName="doe" />);
+
+  const avatar = screen.getByTitle('john doe');
+  expect(avatar).toHaveTextContent('JD');
+});
+
+test('size default', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toHaveStyle('width: 32px');
+});
+
+test('size big', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" size="big" />);
+
+  const avatar = screen.getByTitle('John Doe');
+  expect(avatar).toHaveStyle('width: 140px');
+});
+
+test('supports ...rest props', () => {
+  render(<Avatar username="john" firstName="John" lastName="Doe" data-testid="my_value" />);
+
+  expect(screen.getByTestId('my_value')).toBeInTheDocument();
+});

package/src/components/Avatar/Avatars.tsx

@@ -0,0 +1,50 @@
+import React, {Children} from 'react';
+import styled from 'styled-components';
+import {Override} from '../../shared';
+import {AkeneoThemedProps, getColor} from '../../theme';
+
+const AvatarListContainer = styled.div<AvatarsProps & AkeneoThemedProps>`
+  display: flex;
+  flex-direction: row-reverse;
+  justify-content: flex-end;
+  & > * {
+    margin-right: -4px;
+    position: relative;
+  }
+`;
+
+const RemainingAvatar = styled.span`
+  height: 32px;
+  width: 32px;
+  display: inline-block;
+  border: 1px solid ${getColor('grey', 10)};
+  line-height: 32px;
+  text-align: center;
+  font-size: 15px;
+  border-radius: 32px;
+  background-color: ${getColor('white')};
+`;
+
+type AvatarsProps = Override<
+  React.HTMLAttributes<HTMLDivElement>,
+  {
+    max: number;
+  }
+>;
+
+const Avatars = ({max, children, ...rest}: AvatarsProps) => {
+  const childrenArray = Children.toArray(children);
+  const displayedChildren = childrenArray.slice(0, max);
+  const remainingChildrenCount = childrenArray.length - max;
+  const reverseChildren = displayedChildren.reverse();
+
+  return (
+    <AvatarListContainer {...rest}>
+      {remainingChildrenCount > 0 && <RemainingAvatar>+{remainingChildrenCount}</RemainingAvatar>}
+      {reverseChildren}
+    </AvatarListContainer>
+  );
+};
+
+export {Avatars};
+export type {AvatarsProps};

package/src/components/Avatar/Avatars.unit.tsx

@@ -0,0 +1,41 @@
+import React from 'react';
+import {render, screen} from '../../storybook/test-util';
+import {Avatar} from './Avatar';
+import {Avatars} from './Avatars';
+
+test('renders multiple avatars', () => {
+  render(
+    <Avatars max={2}>
+      <Avatar username="john" firstName="John" lastName="Doe" />
+      <Avatar username="leonard" firstName="Leonard" lastName="Doe" />
+    </Avatars>
+  );
+
+  expect(screen.getByTitle('John Doe')).toBeInTheDocument();
+  expect(screen.getByTitle('Leonard Doe')).toBeInTheDocument();
+});
+
+test('renders a maximum number of avatars', () => {
+  render(
+    <Avatars max={1}>
+      <Avatar username="john" firstName="John" lastName="Doe" />
+      <Avatar username="leonard" firstName="Leonard" lastName="Doe" />
+    </Avatars>
+  );
+
+  expect(screen.getByTitle('John Doe')).toBeInTheDocument();
+  expect(screen.queryByTitle('Leonard Doe')).not.toBeInTheDocument();
+  expect(screen.getByText('+1')).toBeInTheDocument();
+});
+
+test('renders no avatar', () => {
+  render(<Avatars max={1}></Avatars>);
+
+  expect(screen.queryByTitle('+1')).not.toBeInTheDocument();
+});
+
+test('supports ...rest props', () => {
+  render(<Avatars max={1} data-testid="my_value" />);
+
+  expect(screen.getByTestId('my_value')).toBeInTheDocument();
+});

package/src/components/Input/BooleanInput/BooleanInput.tsx

@@ -149,7 +149,7 @@ type BooleanInputProps = Override<
         clearLabel?: string;
       }
   ) & {
-    readOnly: boolean;
+    readOnly?: boolean;
     yesLabel: string;
     noLabel: string;
     invalid?: boolean;
@@ -165,7 +165,7 @@ const BooleanInput = React.forwardRef<HTMLDivElement, BooleanInputProps>(
   (
     {
       value,
-      readOnly,
+      readOnly = false,
       onChange,
       clearable = false,
       yesLabel,

package/src/components/Input/MultiSelectInput/MultiSelectInput.tsx

@@ -150,17 +150,24 @@ type MultiMultiSelectInputProps = Override<
      * Callback called when the user hit enter on the field.
      */
     onSubmit?: () => void;
-
-    /**
-     * Handler called when the next page is almost reached.
-     */
-    onNextPage?: () => void;
-
-    /**
-     * Handler called when the search value changed
-     */
-    onSearchChange?: (searchValue: string) => void;
-  }
+  } & (
+      | {
+          /**
+           * Handler called when the next page is almost reached.
+           */
+          onNextPage?: () => void;
+          /**
+           * Handler called when the search value changed
+           */
+          onSearchChange?: (searchValue: string) => void;
+          disableInternalSearch?: false;
+        }
+      | {
+          onNextPage: () => void;
+          onSearchChange: (searchValue: string) => void;
+          disableInternalSearch: true;
+        }
+    )
 >;
 
 /**
@@ -183,6 +190,7 @@ const MultiSelectInput = ({
   verticalPosition,
   onNextPage,
   onSearchChange,
+  disableInternalSearch = false,
   'aria-labelledby': ariaLabelledby,
   ...rest
 }: MultiMultiSelectInputProps) => {
@@ -211,12 +219,14 @@ const MultiSelectInput = ({
     return indexedChips;
   }, {});
 
-  const filteredChildren = validChildren.filter(({props}) => {
-    const childValue = props.value;
-    const optionValue = childValue + props.children;
+  const filteredChildren = disableInternalSearch
+    ? validChildren
+    : validChildren.filter(({props}) => {
+        const childValue = props.value;
+        const optionValue = childValue + props.children;
 
-    return !value.includes(childValue) && optionValue.toLowerCase().includes(searchValue.toLowerCase());
-  });
+        return !value.includes(childValue) && optionValue.toLowerCase().includes(searchValue.toLowerCase());
+      });
 
   const handleEnter = () => {
     if (filteredChildren.length > 0 && dropdownIsOpen) {

package/src/components/Input/MultiSelectInput/MultiSelectInput.unit.tsx

@@ -77,6 +77,51 @@ test('it handles search', () => {
   expect(onChange).toHaveBeenCalledTimes(2);
 });
 
+test('it handles external search', () => {
+  const onChange = jest.fn();
+  const onNextPage = jest.fn();
+  const onSearchChange = jest.fn();
+
+  const observe = jest.fn();
+  const unobserve = jest.fn();
+  window.IntersectionObserver = jest.fn(() => ({
+    observe,
+    unobserve,
+  })) as unknown as jest.Mock<IntersectionObserver>;
+
+  render(
+    <MultiSelectInput
+      openLabel="Open"
+      value={[]}
+      onChange={onChange}
+      placeholder="Placeholder"
+      emptyResultLabel="Empty result"
+      onNextPage={onNextPage}
+      onSearchChange={onSearchChange}
+      disableInternalSearch={true}
+      removeLabel="Remove"
+    >
+      <MultiSelectInput.Option value="en_US">English</MultiSelectInput.Option>
+      <MultiSelectInput.Option value="fr_FR">French</MultiSelectInput.Option>
+      <MultiSelectInput.Option value="de_DE">German</MultiSelectInput.Option>
+      <MultiSelectInput.Option value="es_ES">Spanish</MultiSelectInput.Option>
+    </MultiSelectInput>
+  );
+
+  const input = screen.getByRole('textbox');
+  fireEvent.click(input);
+  fireEvent.change(input, {target: {value: 'Fr'}});
+
+  const germanOption = screen.queryByText('German');
+  expect(germanOption).toBeInTheDocument();
+  const usOption = screen.queryByText('English');
+  expect(usOption).toBeInTheDocument();
+  const spanishOption = screen.queryByText('Spanish');
+  expect(spanishOption).toBeInTheDocument();
+  const frenchOption = screen.getByText('French');
+  expect(frenchOption).toBeInTheDocument();
+});
+
 test('it handles empty cases', () => {
   const onChange = jest.fn();
   render(

package/src/components/Input/SelectInput/SelectInput.tsx

@@ -178,17 +178,24 @@ type SelectInputProps = Override<
      * Force the vertical position of the overlay.
      */
     verticalPosition?: VerticalPosition;
-
-    /**
-     * Handler called when the next page is almost reached.
-     */
-    onNextPage?: () => void;
-
-    /**
-     * Handler called when the search value changed
-     */
-    onSearchChange?: (searchValue: string) => void;
-  }
+  } & (
+      | {
+          /**
+           * Handler called when the next page is almost reached.
+           */
+          onNextPage?: () => void;
+          /**
+           * Handler called when the search value changed
+           */
+          onSearchChange?: (searchValue: string) => void;
+          disableInternalSearch?: false;
+        }
+      | {
+          onNextPage: () => void;
+          onSearchChange: (searchValue: string) => void;
+          disableInternalSearch: true;
+        }
+    )
 >;
 
 /**
@@ -209,6 +216,7 @@ const SelectInput = ({
   verticalPosition,
   onNextPage,
   onSearchChange,
+  disableInternalSearch = false,
   'aria-labelledby': ariaLabelledby,
   ...rest
 }: SelectInputProps) => {
@@ -235,14 +243,16 @@ const SelectInput = ({
     return optionCodes;
   }, []);
 
-  const filteredChildren = validChildren.filter(child => {
-    const content = typeof child.props.children === 'string' ? child.props.children : '';
-    const title = child.props.title ?? '';
-    const value = child.props.value;
-    const optionValue = value + content + title;
+  const filteredChildren = disableInternalSearch
+    ? validChildren
+    : validChildren.filter(child => {
+        const content = typeof child.props.children === 'string' ? child.props.children : '';
+        const title = child.props.title ?? '';
+        const value = child.props.value;
+        const optionValue = value + content + title;
 
-    return optionValue.toLowerCase().includes(searchValue.toLowerCase());
-  });
+        return optionValue.toLowerCase().includes(searchValue.toLowerCase());
+      });
 
   const currentValueElement =
     validChildren.find(child => {