@strapi/design-system 1.2.7 → 1.3.0-beta.1

package/src/Dialog/__tests__/Dialog.e2e.js

@@ -0,0 +1,20 @@
+import { injectAxe, getViolations } from 'axe-playwright';
+
+import { test, expect } from '@playwright/test';
+
+test.describe.parallel('Dialog', () => {
+  test.beforeEach(async ({ page }) => {
+    // This is the URL of the Storybook Iframe
+    await page.goto('/iframe.html?id=design-system-components-dialog--base&args=&viewMode=story');
+    await injectAxe(page);
+  });
+
+  test('triggers axe on the document', async ({ page }) => {
+    const violations = await getViolations(page);
+
+    // Axe throws an error about landmark for the role dialog
+    const realViolations = violations.filter((violation) => violation.id !== 'region');
+
+    expect(realViolations.length).toBe(0);
+  });
+});

package/src/Dialog/__tests__/Dialog.spec.js

@@ -0,0 +1,28 @@
+import * as React from 'react';
+import { render } from '@testing-library/react';
+import { ThemeProvider } from '../../ThemeProvider';
+import { lightTheme } from '../../themes';
+import { Dialog } from '../Dialog';
+import { DialogBody } from '../DialogBody';
+import { DialogFooter } from '../DialogFooter';
+import { Button } from '../../Button/Button';
+
+describe('Dialog', () => {
+  it('should render Dialog with props', () => {
+    const { getByText } = render(
+      <ThemeProvider theme={lightTheme}>
+        <Dialog isOpen={true} onClose={jest.fn()} title="Confirmation" labelledBy="confirmation">
+          <DialogBody>are you sure you want to delete this?</DialogBody>
+          <DialogFooter
+            startAction={<Button variant="tertiary">Cancel</Button>}
+            endAction={<Button variant="danger-light">Confirm</Button>}
+          />
+        </Dialog>
+      </ThemeProvider>,
+    );
+
+    expect(getByText('are you sure you want to delete this?')).toBeInTheDocument();
+    expect(getByText('Cancel')).toBeInTheDocument();
+    expect(getByText('Confirm')).toBeInTheDocument();
+  });
+});

package/src/Dialog/index.js

@@ -0,0 +1,3 @@
+export * from './Dialog';
+export * from './DialogBody';
+export * from './DialogFooter';

package/src/DismissibleLayer/DismissibleLayer.js

@@ -0,0 +1,87 @@
+import React, { useEffect, useRef, useMemo } from 'react';
+import PropTypes from 'prop-types';
+
+export const DismissibleLayer = ({ children, className, onEscapeKeyDown, onPointerDownOutside }) => {
+  const layerRef = useRef(null);
+  const onEscapeKeyDownHandler = useCallbackRef(onEscapeKeyDown);
+  const onPointerDownOutsideHandler = useCallbackRef(onPointerDownOutside);
+
+  useEffect(() => {
+    /**
+     * @type {(event: KeyboardEvent) => void}
+     */
+    const handleKeyDown = (event) => {
+      if (event.key === 'Escape') {
+        onEscapeKeyDownHandler(event);
+      }
+    };
+
+    document.addEventListener('keydown', handleKeyDown);
+
+    return () => document.removeEventListener('keydown', handleKeyDown);
+  }, [onEscapeKeyDownHandler]);
+
+  useEffect(() => {
+    /**
+     * @type {(event: PointerEvent) => void}
+     */
+    const handlePointerDownOutside = (event) => {
+      /**
+       * Because certain elements that live inside modals e.g. Selects
+       * render their dropdowns in portals the `layerRef.current.contains(event.target)` fails.
+       *
+       * Therefore we check the closest portal of the DimissibleLayer (which we're trying to close)
+       * and the event that _may_ prematurely close the layer and see if they are equal.
+       */
+      const dismissibleLayersReactPortal = layerRef.current.closest('[data-react-portal]');
+      const eventsReactPortal = event.target.closest('[data-react-portal]');
+
+      if (
+        layerRef.current &&
+        !layerRef.current.contains(event.target) &&
+        dismissibleLayersReactPortal === eventsReactPortal
+      ) {
+        onPointerDownOutsideHandler();
+      }
+    };
+
+    document.addEventListener('pointerdown', handlePointerDownOutside);
+
+    return () => document.removeEventListener('pointerdown', handlePointerDownOutside);
+  }, [onPointerDownOutsideHandler]);
+
+  return (
+    <div ref={layerRef} className={className}>
+      {children}
+    </div>
+  );
+};
+
+DismissibleLayer.propTypes = {
+  children: PropTypes.node.isRequired,
+  className: PropTypes.string,
+  onEscapeKeyDown: PropTypes.func.isRequired,
+  onPointerDownOutside: PropTypes.func.isRequired,
+};
+
+/**
+ * A custom hook that converts a callback to a ref to avoid triggering re-renders when passed as a
+ * prop or avoid re-executing effects when passed as a dependency
+ *
+ * Stolen from @radix-ui/react-use-callback-ref
+ */
+function useCallbackRef(callback) {
+  const callbackRef = useRef(callback);
+
+  useEffect(() => {
+    callbackRef.current = callback;
+  });
+
+  // https://github.com/facebook/react/issues/19240
+  return useMemo(
+    () =>
+      (...args) =>
+        callbackRef.current?.(...args),
+    [],
+  );
+}

package/src/DismissibleLayer/DismissibleLayer.stories.mdx

@@ -0,0 +1,50 @@
+<!--- Dismissable.stories.mdx --->
+
+import { useState, useEffect } from 'react';
+import { Meta, Story, Canvas } from '@storybook/addon-docs';
+import { ArgsTable } from '@storybook/addon-docs';
+
+import { Typography } from '../Typography';
+import { DismissibleLayer } from './DismissibleLayer';
+
+<Meta title="Design System/Technical Components/DismissibleLayer" component={DismissibleLayer} />
+
+# DismissibleLayer
+
+`DismissibleLayer` is a internal utility component wrapping the logic for a layer that can dismissed. It's typically used within a `Modal` or a `Popover` & in conjunction with `FocusTrap`.
+
+[View source](https://github.com/strapi/design-system/tree/main/packages/strapi-design-system/src/DismissibleLayer)
+
+## Imports
+
+```js
+import { DismissibleLayer } from '@strapi/design-system/DismissibleLayer';
+```
+
+## Usage
+
+<Canvas>
+  <Story name="base">
+    {() => {
+      const [isVisible, setIsVisible] = useState(false);
+      useEffect(() => {
+        let timeout = null;
+        if (!isVisible) {
+          timeout = setTimeout(() => setIsVisible(true), 1000);
+        }
+        return () => clearTimeout(timeout);
+      }, [isVisible]);
+      return isVisible ? (
+        <DismissibleLayer onEscapeKeyDown={() => setIsVisible(false)} onPointerDownOutside={() => setIsVisible(false)}>
+          <Typography style={{ backgroundColor: '#ccc', padding: '20px', display: 'block' }}>
+            press escape or click outside to dismiss
+          </Typography>
+        </DismissibleLayer>
+      ) : null;
+    }}
+  </Story>
+</Canvas>
+
+## Props
+
+<ArgsTable of={DismissibleLayer} />

package/src/DismissibleLayer/__test__/DimissibleLayer.spec.js

@@ -0,0 +1,44 @@
+import React from 'react';
+import { fireEvent, render, screen } from '@testing-library/react';
+import { DismissibleLayer } from '../DismissibleLayer';
+
+describe('DismissibleLayer', () => {
+  it('should fire onEscapeKeyDown when the ESCAPE key is pressed', () => {
+    const onEscapeKeyDownMock = jest.fn();
+    const onPointerDownOutsideMock = jest.fn();
+    render(
+      <DismissibleLayer onEscapeKeyDown={onEscapeKeyDownMock} onPointerDownOutside={onPointerDownOutsideMock}>
+        <h1>hello world</h1>
+      </DismissibleLayer>,
+    );
+
+    fireEvent.keyDown(document, { key: 'Escape' });
+
+    expect(onEscapeKeyDownMock).toHaveBeenCalled();
+  });
+
+  it('should fire onPointerDownOutside when the user clicks outside the DismissibleLayer', () => {
+    const onPointerDownOutsideMock = jest.fn();
+    const onEscapeKeyDownMock = jest.fn();
+    render(
+      <>
+        <DismissibleLayer onPointerDownOutside={onPointerDownOutsideMock} onEscapeKeyDown={onEscapeKeyDownMock}>
+          <h1>hello world</h1>
+        </DismissibleLayer>
+        <button>Click me</button>
+      </>,
+    );
+
+    const insideLayer = screen.getByText('hello world');
+
+    fireEvent.mouseDown(insideLayer);
+
+    expect(onPointerDownOutsideMock).not.toHaveBeenCalled();
+
+    const outsideLayer = screen.getByText('Click me');
+
+    fireEvent.pointerDown(outsideLayer);
+
+    expect(onPointerDownOutsideMock).toHaveBeenCalled();
+  });
+});

package/src/DismissibleLayer/index.js

@@ -0,0 +1 @@
+export * from './DismissibleLayer';

package/src/Divider/Divider.js

@@ -0,0 +1,26 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Box } from '../Box';
+import styled from 'styled-components';
+
+const DividerWrapper = styled(Box)`
+  height: 1px;
+  border: none;
+  ${({ unsetMargin }) => (unsetMargin ? 'margin: 0;' : '')}
+`;
+
+export const Divider = ({ unsetMargin, ...props }) => <DividerWrapper {...props} as="hr" unsetMargin={unsetMargin} />;
+
+/**
+ * The background props is implicitly passed to the Box component
+ * Make sure to KEEP this line
+ */
+Divider.defaultProps = {
+  background: 'neutral150',
+  unsetMargin: true,
+};
+
+Divider.propTypes = {
+  background: PropTypes.string,
+  unsetMargin: PropTypes.bool,
+};

package/src/Divider/Divider.stories.mdx

@@ -0,0 +1,55 @@
+<!--- Divider.stories.mdx --->
+
+import { Meta, Story, Canvas } from '@storybook/addon-docs';
+import { ArgsTable } from '@storybook/addon-docs';
+import { Divider } from './Divider';
+import { Box } from '../Box';
+
+<Meta title="Design System/Components/Divider" component={Divider} />
+
+# Divider
+
+Dividers are used to separate two pieces of content. They have a generic style in the interface.
+
+**Best practices**
+
+- Depending on what is about to be made, a small spacing left and right can be added.
+- Dividers should not be bolder.
+
+[View source](https://github.com/strapi/design-system/tree/main/packages/strapi-design-system/src/Divider)
+
+## Imports
+
+```js
+import { Divider } from '@strapi/design-system/Divider';
+```
+
+## Usage
+
+Use a divider to separate content in forms, PopOvers, tables, ...
+
+<Canvas>
+  <Story name="base">
+    <Box padding={8}>
+      <Divider />
+    </Box>
+  </Story>
+</Canvas>
+
+### With default margin
+
+Use a divider to separate content in forms, PopOvers, tables, ...
+
+<Canvas>
+  <Story name="with-default-margin">
+    <Box padding={8}>
+      <Divider unsetMargin={false} />
+    </Box>
+  </Story>
+</Canvas>
+
+## Props
+
+The Divider component wraps all its children in the (Box)[https://design-system-git-main-strapijs.vercel.app/?path=/docs/design-system-technical-components-box--base] component, so you can pass all Box props to change its style.
+
+<ArgsTable of={Divider} />

package/src/Divider/__tests__/Divider.e2e.js

@@ -0,0 +1,23 @@
+import { injectAxe, checkA11y } from 'axe-playwright';
+
+import { test } from '@playwright/test';
+
+test.describe.parallel('Divider', () => {
+  test.describe('light mode', () => {
+    test('triggers axe on the document', async ({ page }) => {
+      // This is the URL of the Storybook Iframe
+      await page.goto('/iframe.html?id=design-system-components-divider--base&viewMode=story');
+      await injectAxe(page);
+      await checkA11y(page);
+    });
+  });
+
+  test.describe('dark mode', () => {
+    test('triggers axe on the document', async ({ page }) => {
+      // This is the URL of the Storybook Iframe
+      await page.goto('/iframe.html?id=design-system-components-divider--base&viewMode=story&theme=dark');
+      await injectAxe(page);
+      await checkA11y(page);
+    });
+  });
+});

package/src/Divider/index.js

@@ -0,0 +1 @@
+export * from './Divider';

package/src/EmptyStateLayout/EmptyStateLayout.js

@@ -0,0 +1,48 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import styled from 'styled-components';
+import { Typography } from '../Typography';
+import { Box } from '../Box';
+
+const EmptyStateWrapper = styled(Box)`
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  text-align: center;
+`;
+
+const EmptyStateImageWrapper = styled(Box)`
+  svg {
+    height: ${88 / 16}rem;
+  }
+`;
+
+export const EmptyStateLayout = ({ icon, content, action, hasRadius, shadow }) => {
+  return (
+    <EmptyStateWrapper padding={11} background="neutral0" hasRadius={hasRadius} shadow={shadow}>
+      <EmptyStateImageWrapper paddingBottom={6} aria-hidden>
+        {icon}
+      </EmptyStateImageWrapper>
+      <Box paddingBottom={4}>
+        <Typography variant="delta" as="p" textColor="neutral600">
+          {content}
+        </Typography>
+      </Box>
+      {action}
+    </EmptyStateWrapper>
+  );
+};
+
+EmptyStateLayout.defaultProps = {
+  action: undefined,
+  hasRadius: true,
+  shadow: 'tableShadow',
+};
+
+EmptyStateLayout.propTypes = {
+  action: PropTypes.node,
+  content: PropTypes.string.isRequired,
+  hasRadius: PropTypes.bool,
+  icon: PropTypes.node.isRequired,
+  shadow: PropTypes.string,
+};

package/src/EmptyStateLayout/EmptyStateLayout.stories.mdx

@@ -0,0 +1,87 @@
+<!--- EmptyStateLayout.stories.mdx --->
+
+import { Meta, Story, Canvas } from '@storybook/addon-docs';
+import { ArgsTable } from '@storybook/addon-docs';
+import Plus from '@strapi/icons/Plus';
+import { Illo } from './story-assets/Illo';
+import { EmptyStateLayout } from './EmptyStateLayout';
+import { Button } from '../Button';
+import { Box } from '../Box';
+
+<Meta title="Design System/Components/EmptyStateLayout" component={EmptyStateLayout} />
+
+# EmptyStateLayout
+
+EmptyStates are a pattern used to indicate a page or a table is empty.
+
+**Best practices**
+
+- Use everytime a page or a table is empty.
+- Use the most appropriate illustration for the usecase. If related to permissions, choose the eye one.
+- Use the button to help redirecting the user to a more relevant place.
+
+[View source](https://github.com/strapi/design-system/tree/main/packages/strapi-design-system/src/EmptyStateLayout)
+
+## Imports
+
+```js
+import { EmptyStateLayout } from '@strapi/design-system/EmptyStateLayout';
+```
+
+## Usage
+
+A page or a table might be empty for different reasons: no entries have been created yet, a user doesn't have the permission to access something, something went wrong, ...
+
+### EmptyStateLayout with action
+
+EmptyStates can be coupled with a button to help redirecting the user to a more relevant place.
+
+<Canvas>
+  <Story name="base">
+    <Box padding={8} background="neutral100">
+      <EmptyStateLayout
+        icon={<Illo />}
+        content="You don't have any content yet..."
+        action={
+          <Button variant="secondary" startIcon={<Plus />}>
+            Create your first content-type
+          </Button>
+        }
+      />
+    </Box>
+  </Story>
+</Canvas>
+
+### EmptyStateLayout without action
+
+If no need to redirect the user to a more relevant place or if the context does not suit for that type of action, an EmptyState without any particular action can be added.
+
+<Canvas>
+  <Story name="without action">
+    <Box padding={8} background="neutral100">
+      <EmptyStateLayout icon={<Illo />} content="You don't have any content yet..." />
+    </Box>
+  </Story>
+</Canvas>
+
+### EmptyStateLayout with longer text
+
+<Canvas>
+  <Story name="with large text">
+    <Box padding={8} background="neutral100">
+      <EmptyStateLayout
+        icon={<Illo />}
+        content="Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
+        action={
+          <Button variant="secondary" startIcon={<Plus />}>
+            Create your first content-type
+          </Button>
+        }
+      />
+    </Box>
+  </Story>
+</Canvas>
+
+## Props
+
+<ArgsTable of={EmptyStateLayout} />

package/src/EmptyStateLayout/__tests__/EmptyStateLayout.e2e.js

@@ -0,0 +1,31 @@
+import { injectAxe, checkA11y } from 'axe-playwright';
+
+import { test } from '@playwright/test';
+
+test.describe.parallel('EmptyStateLayout', () => {
+  test.describe('light mode', () => {
+    test.describe('base', () => {
+      test('triggers axe on the document', async ({ page }) => {
+        await page.goto('/iframe.html?id=design-system-components-emptystatelayout--base&viewMode=story');
+        await injectAxe(page);
+        await checkA11y(page);
+      });
+    });
+
+    test.describe('without action', () => {
+      test('triggers axe on the document', async ({ page }) => {
+        await page.goto('/iframe.html?id=design-system-components-emptystatelayout--without-action&viewMode=story');
+        await injectAxe(page);
+        await checkA11y(page);
+      });
+    });
+  });
+
+  test.describe('dark mode', () => {
+    test('triggers axe on the document', async ({ page }) => {
+      await page.goto('/iframe.html?id=design-system-components-emptystatelayout--base&viewMode=story&theme=dark');
+      await injectAxe(page);
+      await checkA11y(page);
+    });
+  });
+});

package/src/EmptyStateLayout/index.js

@@ -0,0 +1 @@
+export * from './EmptyStateLayout';

package/src/EmptyStateLayout/story-assets/Illo.js

@@ -0,0 +1,51 @@
+import React from 'react';
+
+export const Illo = () => (
+  <svg width="159" height="88" viewBox="0 0 159 88" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      fillRule="evenodd"
+      clipRule="evenodd"
+      d="M134.933 17.417C137.768 17.417 140.067 19.7153 140.067 22.5503C140.067 25.3854 137.768 27.6837 134.933 27.6837H105.6C108.435 27.6837 110.733 29.9819 110.733 32.817C110.733 35.6521 108.435 37.9503 105.6 37.9503H121.733C124.568 37.9503 126.867 40.2486 126.867 43.0837C126.867 45.9187 124.568 48.217 121.733 48.217H114.272C110.698 48.217 107.8 50.5153 107.8 53.3503C107.8 55.2404 109.267 56.9515 112.2 58.4837C115.035 58.4837 117.333 60.7819 117.333 63.617C117.333 66.4521 115.035 68.7503 112.2 68.7503H51.3333C48.4982 68.7503 46.2 66.4521 46.2 63.617C46.2 60.7819 48.4982 58.4837 51.3333 58.4837H22.7333C19.8982 58.4837 17.6 56.1854 17.6 53.3503C17.6 50.5153 19.8982 48.217 22.7333 48.217H52.0666C54.9017 48.217 57.2 45.9187 57.2 43.0837C57.2 40.2486 54.9017 37.9503 52.0666 37.9503H33.7333C30.8982 37.9503 28.6 35.6521 28.6 32.817C28.6 29.9819 30.8982 27.6837 33.7333 27.6837H63.0666C60.2316 27.6837 57.9333 25.3854 57.9333 22.5503C57.9333 19.7153 60.2316 17.417 63.0666 17.417H134.933ZM134.933 37.9503C137.768 37.9503 140.067 40.2486 140.067 43.0837C140.067 45.9187 137.768 48.217 134.933 48.217C132.098 48.217 129.8 45.9187 129.8 43.0837C129.8 40.2486 132.098 37.9503 134.933 37.9503Z"
+      fill="#DBDBFA"
+    />
+    <path
+      fillRule="evenodd"
+      clipRule="evenodd"
+      d="M95.826 16.6834L102.647 66.4348L103.26 71.4261C103.458 73.034 102.314 74.4976 100.706 74.695L57.7621 79.9679C56.1542 80.1653 54.6906 79.0219 54.4932 77.4139L47.8816 23.5671C47.7829 22.7631 48.3546 22.0313 49.1586 21.9326C49.1637 21.932 49.1688 21.9313 49.1739 21.9307L52.7367 21.5311L95.826 16.6834ZM55.6176 21.208L58.9814 20.8306Z"
+      fill="white"
+    />
+    <path
+      d="M55.6176 21.208L58.9814 20.8306M95.826 16.6834L102.647 66.4348L103.26 71.4261C103.458 73.034 102.314 74.4976 100.706 74.695L57.7621 79.9679C56.1542 80.1653 54.6906 79.0219 54.4932 77.4139L47.8816 23.5671C47.7829 22.7631 48.3546 22.0313 49.1586 21.9326C49.1637 21.932 49.1688 21.9313 49.1739 21.9307L52.7367 21.5311L95.826 16.6834Z"
+      stroke="#7E7BF6"
+      strokeWidth="2.5"
+    />
+    <path
+      fillRule="evenodd"
+      clipRule="evenodd"
+      d="M93.9695 19.8144L100.144 64.9025L100.699 69.4258C100.878 70.8831 99.8559 72.2077 98.416 72.3845L59.9585 77.1065C58.5185 77.2833 57.2062 76.2453 57.0272 74.7881L51.0506 26.112C50.9519 25.308 51.5236 24.5762 52.3276 24.4775L57.0851 23.8934"
+      fill="#F0F0FF"
+    />
+    <path
+      fillRule="evenodd"
+      clipRule="evenodd"
+      d="M97.701 7.33301H64.2927C63.7358 7.33301 63.2316 7.55873 62.8667 7.92368C62.5017 8.28862 62.276 8.79279 62.276 9.34967V65.083C62.276 65.6399 62.5017 66.1441 62.8667 66.509C63.2316 66.874 63.7358 67.0997 64.2927 67.0997H107.559C108.116 67.0997 108.62 66.874 108.985 66.509C109.35 66.1441 109.576 65.6399 109.576 65.083V19.202C109.576 18.6669 109.363 18.1537 108.985 17.7755L99.1265 7.92324C98.7484 7.54531 98.2356 7.33301 97.701 7.33301Z"
+      fill="white"
+      stroke="#7F7CFA"
+      strokeWidth="2.5"
+    />
+    <path
+      d="M98.026 8.17871V16.6833C98.026 17.8983 99.011 18.8833 100.226 18.8833H106.044"
+      stroke="#807EFA"
+      strokeWidth="2.5"
+      strokeLinecap="round"
+      strokeLinejoin="round"
+    />
+    <path
+      d="M70.1594 56.2838H89.2261M70.1594 18.8838H89.2261H70.1594ZM70.1594 27.6838H101.693H70.1594ZM70.1594 37.2171H101.693H70.1594ZM70.1594 46.7505H101.693H70.1594Z"
+      stroke="#817FFA"
+      strokeWidth="2.5"
+      strokeLinecap="round"
+      strokeLinejoin="round"
+    />
+  </svg>
+);

package/src/Field/Field.js

@@ -0,0 +1,29 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { FieldContext } from './FieldContext';
+import { useId } from '../helpers/useId';
+
+export const Field = ({ children, name, error, hint, id, ...props }) => {
+  const generatedId = useId('field', id);
+
+  return (
+    <div {...props}>
+      <FieldContext.Provider value={{ name, id: generatedId, error, hint }}>{children}</FieldContext.Provider>
+    </div>
+  );
+};
+
+Field.defaultProps = {
+  error: undefined,
+  hint: undefined,
+  id: undefined,
+  name: undefined,
+};
+
+Field.propTypes = {
+  children: PropTypes.node.isRequired,
+  error: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
+  hint: PropTypes.oneOfType([PropTypes.string, PropTypes.node, PropTypes.arrayOf(PropTypes.node)]),
+  id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  name: PropTypes.string,
+};