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

package/src/Checkbox/Checkbox.stories.mdx

@@ -1,190 +0,0 @@
-<!--- Button.stories.mdx --->
-
-import { useState } from 'react';
-import { ArgsTable } from '@storybook/addon-docs';
-import { Meta, Story, Canvas } from '@storybook/addon-docs';
-import { Checkbox } from './Checkbox';
-
-<Meta title="Design System/Components/Checkbox" component={Checkbox} />
-
-# Checkbox
-
-Checkboxes allow users to choose one or multiple values from a range of options.
-
-**Best practices**
-
-- Content of the checkbox should be concise and straightforward.
-- Use the Radio button component if the user should select only one value.
-- Start all checkbox labels with a capital letter.
-- Avoid using hint state in tables.
-
-[View source](https://github.com/strapi/design-system/tree/main/packages/strapi-design-system/src/Checkbox)
-
-## Imports
-
-```js
-import { Checkbox } from '@strapi/design-system/Checkbox';
-```
-
-## Usage
-
-<Canvas withSource="open">
-  <Story name="base" parameters={{ docs: { source: { code: '<Checkbox>Label</Checkbox>' } } }}>
-    {() => {
-      const [val, setValue] = useState(false);
-      return (
-        <Checkbox name="default" onValueChange={(value) => setValue(value)} value={val}>
-          Label
-        </Checkbox>
-      );
-    }}
-  </Story>
-</Canvas>
-
-### Indeterminate checkbox
-
-<Canvas withSource="open">
-  <Story
-    name="indeterminate"
-    parameters={{
-      docs: {
-        source: {
-          code: `<Checkbox indeterminate>Parent</Checkbox>`,
-        },
-      },
-    }}
-  >
-    {() => {
-      const [checkedItems, setCheckedItems] = useState([true, false]);
-      const allChecked = checkedItems.every(Boolean);
-      const isIndeterminate = checkedItems.some(Boolean) && !allChecked;
-      return (
-        <ul>
-          <li>
-            <Checkbox
-              id="parent"
-              name="parent"
-              indeterminate={isIndeterminate}
-              onValueChange={(value) => setCheckedItems([value, value])}
-              value={allChecked}
-            >
-              Parent
-            </Checkbox>
-          </li>
-          <li>
-            <ul>
-              <li>
-                <Checkbox
-                  id="child1"
-                  name="child1"
-                  onValueChange={(value) => setCheckedItems([value, checkedItems[1]])}
-                  value={checkedItems[0]}
-                >
-                  Child 1
-                </Checkbox>
-              </li>
-              <li>
-                <Checkbox
-                  id="child2"
-                  name="child2"
-                  onValueChange={(value) => setCheckedItems([checkedItems[0], value])}
-                  value={checkedItems[1]}
-                >
-                  Child 2
-                </Checkbox>
-              </li>
-            </ul>
-          </li>
-        </ul>
-      );
-    }}
-  </Story>
-</Canvas>
-
-#### Checked
-
-Checked state is used to show that an option has been selected.
-
-#### Indeterminate
-
-Indeterminate state is used to show partially checked states.
-
-#### Unchecked
-
-Unchecked state is used to show that an option has been selected.
-
-### Disabled
-
-Checkboxes can possibily not be available to selection yet. This state can be related to a lack of permission or a need to pursue another action first.
-
-<Canvas withSource="open">
-  <Story name="disabled" parameters={{ docs: { source: { code: '<Checkbox disabled>Label</Checkbox>' } } }}>
-    {() => {
-      const [val, setValue] = useState(false);
-      return (
-        <Checkbox disabled name="default" onValueChange={(value) => setValue(value)} value={val}>
-          Label
-        </Checkbox>
-      );
-    }}
-  </Story>
-</Canvas>
-
-### Hint
-
-Use hint state to give more information about the purpose of a checkbox.
-
-<Canvas withSource="open">
-  <Story
-    name="hint"
-    parameters={{ docs: { source: { code: '<Checkbox hint="Description line lorem ipsum">Label</Checkbox>' } } }}
-  >
-    {() => {
-      const [val, setValue] = useState(false);
-      return (
-        <Checkbox
-          hint="Description line lorem ipsum"
-          name="default"
-          onValueChange={(value) => setValue(value)}
-          value={val}
-        >
-          Label
-        </Checkbox>
-      );
-    }}
-  </Story>
-</Canvas>
-
-### Error
-
-Display an error message.
-
-<Canvas withSource="open">
-  <Story
-    name="error"
-    parameters={{ docs: { source: { code: '<Checkbox error="Description line lorem ipsum">Label</Checkbox>' } } }}
-  >
-    {() => {
-      const [val, setValue] = useState(false);
-      return (
-        <Checkbox
-          error="Description line lorem ipsum"
-          name="default"
-          onValueChange={(value) => setValue(value)}
-          value={val}
-        >
-          Label
-        </Checkbox>
-      );
-    }}
-  </Story>
-</Canvas>
-
-## Accessibility
-
-- Checkbox has role of checkbox.
-- When Checkbox has focus, `Space` or `Enter` activates/deactivates it.
-
-## Props
-
-<ArgsTable of={Checkbox} />

package/src/Checkbox/__tests__/Checkbox.e2e.js

@@ -1,96 +0,0 @@
-import { injectAxe, checkA11y } from 'axe-playwright';
-
-import { test, expect } from '@playwright/test';
-
-test.describe.parallel('Checkbox', () => {
-  test.describe('light mode', () => {
-    test.describe('base', () => {
-      test('verifies A11y on base story', async ({ page }) => {
-        await page.goto('/iframe.html?id=design-system-components-checkbox--base&viewMode=story');
-        await injectAxe(page);
-        await checkA11y(page);
-      });
-    });
-
-    test.describe('intermediate', () => {
-      test.beforeEach(async ({ page }) => {
-        // This is the URL of the Storybook Iframe
-        await page.goto('/iframe.html?id=design-system-components-checkbox--indeterminate&viewMode=story');
-        await injectAxe(page);
-      });
-
-      test('triggers axe on the document', async ({ page }) => {
-        await checkA11y(page);
-      });
-
-      test('moves to the next element when pressing tab and select when pressing the spacebar', async ({
-        page,
-        browserName,
-      }) => {
-        test.skip(browserName === 'webkit', 'Still working on it');
-        await page.focus('text="Child 1"');
-        await page.keyboard.press('Tab');
-        await page.keyboard.press(' ');
-
-        const secondBox = await page.$('#child2');
-        if (secondBox) {
-          expect(await secondBox.isChecked()).toBe(true);
-        }
-      });
-
-      test('select the parent element when all child are selected', async ({ page, browserName }) => {
-        test.skip(browserName === 'webkit', 'Still working on it');
-        await page.focus('text="Child 1"');
-        await page.keyboard.press('Tab');
-        await page.keyboard.press(' ');
-
-        const secondBox = await page.$('#parent');
-        if (secondBox) {
-          expect(await secondBox.isChecked()).toBe(true);
-        }
-      });
-    });
-
-    test.describe('hint', () => {
-      test('verifies A11y errors on the hint page', async ({ page }) => {
-        await page.goto('/iframe.html?id=design-system-components-checkbox--hint&viewMode=story');
-        await injectAxe(page);
-        await checkA11y(page);
-      });
-    });
-
-    test.describe('error', () => {
-      test('verifies A11y errors on the error page', async ({ page }) => {
-        await page.goto('/iframe.html?id=design-system-components-checkbox--error&viewMode=story');
-        await injectAxe(page);
-        await checkA11y(page);
-      });
-    });
-  });
-
-  test.describe('dark mode', () => {
-    test('base A11y', async ({ page }) => {
-      await page.goto('/iframe.html?id=design-system-components-checkbox--base&viewMode=story&theme=dark');
-      await injectAxe(page);
-      await checkA11y(page);
-    });
-
-    test('intermediate A11y', async ({ page }) => {
-      await page.goto('/iframe.html?id=design-system-components-checkbox--indeterminate&viewMode=story&theme=dark');
-      await injectAxe(page);
-      await checkA11y(page);
-    });
-
-    test('hint A11y', async ({ page }) => {
-      await page.goto('/iframe.html?id=design-system-components-checkbox--hint&viewMode=story&theme=dark');
-      await injectAxe(page);
-      await checkA11y(page);
-    });
-
-    test('error A11y', async ({ page }) => {
-      await page.goto('/iframe.html?id=design-system-components-checkbox--error&viewMode=story&theme=dark');
-      await injectAxe(page);
-      await checkA11y(page);
-    });
-  });
-});

package/src/Checkbox/index.js

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

package/src/Combobox/Combobox.js

@@ -1,421 +0,0 @@
-import React, { useEffect, useState, useRef, useLayoutEffect, Children, cloneElement } from 'react';
-import PropTypes from 'prop-types';
-import { useId } from '../helpers/useId';
-import CarretDown from '@strapi/icons/CarretDown';
-import Cross from '@strapi/icons/Cross';
-import { getActionFromKey, getUpdatedIndex, maintainScrollVisibility, MenuActions, filterOptions } from './utils';
-
-import { Flex } from '../Flex';
-import { CaretBox, IconBox } from '../Select/components';
-import { Popover } from '../Popover';
-import { Box } from '../Box';
-import { Typography } from '../Typography';
-import { Loader } from '../Loader/Loader';
-import { Input, MainRow, ValueContainer, InputContainer } from './components';
-import { ComboboxOption } from './ComboboxOption';
-import { ComboboxList } from './ComboboxList';
-import { Field, FieldError, FieldHint, FieldLabel } from '../Field';
-import { Stack } from '../Stack';
-import { KeyboardKeys } from '../helpers/keyboardKeys';
-import { VisuallyHidden } from '../VisuallyHidden';
-
-export const Combobox = ({
-  children: nodes,
-  clearLabel,
-  creatable,
-  createMessage,
-  disabled,
-  error,
-  hasMoreItems,
-  hint,
-  label,
-  labelAction,
-  loading,
-  loadingMessage,
-  noOptionsMessage,
-  onChange,
-  onClear,
-  onCreateOption,
-  onInputChange,
-  onLoadMore,
-  placeholder,
-  required,
-  value,
-  ...props
-}) => {
-  const getInputValueFromNodes = () =>
-    nodes.find((node) => node.props?.value.toLowerCase() === value.toLowerCase()).props?.children;
-
-  const [activeIndex, setActiveIndex] = useState(0);
-  const [selectedIndex, setSelectedIndex] = useState(null);
-  const [filteredNodes, setFilteredNodes] = useState(nodes);
-  const [open, setOpen] = useState(false);
-  const [inputValue, setInputValue] = useState('');
-
-  const activeOptionRef = useRef();
-  const ignoreBlur = useRef(false);
-  const inputRef = useRef();
-  const containerRef = useRef();
-  const listboxRef = useRef();
-  const firstUpdate = useRef(true);
-
-  const generatedId = useId('combobox');
-  const labelId = `${generatedId}-label`;
-
-  if (!label && !props['aria-label']) {
-    throw new Error('The Combobox component needs a "label" or an "aria-label" props');
-  }
-
-  // Filter the nodes on input changes.
-  useEffect(() => {
-    setFilteredNodes(filterOptions(nodes, inputValue));
-  }, [inputValue, nodes]);
-
-  // Maintain the scroll visibility
-  useEffect(() => {
-    if (open && activeOptionRef.current) {
-      maintainScrollVisibility(activeOptionRef.current);
-    }
-  }, [activeIndex]);
-
-  useLayoutEffect(() => {
-    if (firstUpdate.current) {
-      firstUpdate.current = false;
-      return;
-    }
-  }, [value]);
-
-  const activeId = open ? `${generatedId}-${activeIndex}` : '';
-
-  const clearCombobox = () => {
-    onChange(null);
-    setInputValue('');
-  };
-
-  const onInput = (event) => {
-    if (onInputChange) {
-      onInputChange(event);
-    }
-
-    const curValue = inputRef.current.value;
-    setFilteredNodes(filterOptions(nodes, curValue));
-    setActiveIndex(0);
-    setSelectedIndex(null);
-
-    if (inputValue !== curValue) {
-      setInputValue(curValue);
-    }
-
-    if (!open) {
-      updateMenuState(true, false);
-    }
-  };
-
-  const onInputKeyDown = (event) => {
-    const { key } = event;
-    const max = creatable && inputValue ? filteredNodes.length : filteredNodes.length - 1;
-    const action = getActionFromKey(key, open);
-
-    if (value && !inputValue && key === KeyboardKeys.BACKSPACE) {
-      clearCombobox();
-    }
-
-    switch (action) {
-      case MenuActions.Next: {
-        if (activeIndex === max) {
-          return onOptionChange(0);
-        }
-
-        return onOptionChange(getUpdatedIndex(activeIndex, max, action));
-      }
-      case MenuActions.Previous: {
-        if (activeIndex === 0) {
-          return onOptionChange(max);
-        }
-
-        return onOptionChange(getUpdatedIndex(activeIndex, max, action));
-      }
-      case MenuActions.Last:
-      case MenuActions.First: {
-        if (activeIndex === max) {
-          return onOptionChange(0);
-        }
-
-        return onOptionChange(getUpdatedIndex(activeIndex, max, action));
-      }
-      case MenuActions.CloseSelect:
-        event.preventDefault();
-        onOptionSelect(activeIndex);
-        return;
-      case MenuActions.Close:
-        event.preventDefault();
-        return updateMenuState(false);
-      case MenuActions.Open:
-        return updateMenuState(true);
-      default:
-        return;
-    }
-  };
-
-  const onInputBlur = (e) => {
-    e.preventDefault();
-    if (value && !ignoreBlur.current) {
-      setInputValue('');
-    }
-
-    if (ignoreBlur.current) {
-      ignoreBlur.current = false;
-      return;
-    }
-
-    updateMenuState(false, false);
-  };
-
-  const onOptionChange = (index) => {
-    setActiveIndex(index);
-  };
-
-  const onOptionClick = (index) => {
-    onOptionChange(index);
-    onOptionSelect(index);
-  };
-
-  const onOptionMouseDown = () => {
-    ignoreBlur.current = true;
-  };
-
-  const onOptionSelect = (index) => {
-    const selected = filteredNodes[index];
-    setInputValue('');
-
-    if (selected) {
-      onChange(selected.props.value);
-      return updateMenuState(false);
-    }
-
-    if (creatable) {
-      onCreateOption(inputValue);
-      updateMenuState(false);
-    }
-  };
-
-  const updateMenuState = (open, callFocus = true) => {
-    setOpen(open);
-    callFocus && inputRef.current.focus();
-  };
-
-  const filteredNodesClone = Children.toArray(filteredNodes).map((node, i) => {
-    const isActive = activeIndex === i;
-
-    return cloneElement(node, {
-      id: `${generatedId}-${i}`,
-      'aria-selected': selectedIndex === i ? true : false,
-      'aria-posinset': i + 1,
-      'aria-setsize': Children.toArray(filteredNodes).length,
-      ref: (r) => {
-        if (isActive) activeOptionRef.current = r;
-      },
-      onClick: () => onOptionClick(i),
-      onMouseDown: onOptionMouseDown,
-      isSelected: isActive,
-    });
-  });
-
-  const handleClear = () => {
-    inputRef.current.focus();
-
-    if (onClear) {
-      onClear();
-    }
-
-    clearCombobox();
-  };
-
-  const handleCaretClick = () => {
-    inputRef.current.focus();
-    updateMenuState(true);
-  };
-
-  const hasOption = () => {
-    const nodeIndex = filteredNodes.findIndex((node) => node.props?.children === inputValue);
-    return inputValue && nodeIndex === -1;
-  };
-
-  const handleClick = (e) => {
-    e.preventDefault();
-    updateMenuState(e, true);
-  };
-
-  return (
-    <Field hint={hint} error={error} id={generatedId}>
-      <VisuallyHidden aria-live="polite" aria-atomic="false" aria-relevant="additions text">
-        {value}
-      </VisuallyHidden>
-      <Stack spacing={label || hint || error ? 1 : 0}>
-        {label && (
-          <FieldLabel action={labelAction} required={required} id={labelId}>
-            {label}
-          </FieldLabel>
-        )}
-        <MainRow ref={containerRef} $disabled={disabled} hasError={error}>
-          <InputContainer wrap="wrap">
-            {!inputValue && value && (
-              <ValueContainer id={`${generatedId}-selected-value`}>
-                <Typography>{getInputValueFromNodes()}</Typography>
-              </ValueContainer>
-            )}
-            <Input
-              aria-activedescendant={activeId}
-              aria-autocomplete="list"
-              aria-controls={`${generatedId}-listbox`}
-              aria-disabled={disabled}
-              aria-expanded={open}
-              aria-haspopup="listbox"
-              aria-labelledby={label ? labelId : undefined}
-              id={generatedId}
-              onBlur={disabled ? undefined : onInputBlur}
-              onClick={disabled ? undefined : handleClick}
-              onInput={disabled ? undefined : onInput}
-              onKeyDown={disabled ? undefined : onInputKeyDown}
-              placeholder={value ? '' : placeholder}
-              readOnly={disabled}
-              ref={inputRef}
-              role="combobox"
-              autoComplete="off"
-              autoCorrect="off"
-              spellCheck="off"
-              type="text"
-              value={inputValue}
-            />
-          </InputContainer>
-          <Flex>
-            {(value || inputValue) && (
-              <IconBox
-                id={`${generatedId}-clear`}
-                aria-label={clearLabel}
-                disabled={disabled}
-                paddingLeft={3}
-                as="button"
-                onClick={handleClear}
-                type="button"
-              >
-                <Cross />
-              </IconBox>
-            )}
-            <CaretBox
-              disabled={disabled}
-              paddingLeft={3}
-              aria-hidden
-              as="button"
-              onClick={handleCaretClick}
-              tabIndex={-1}
-              type="button"
-            >
-              <CarretDown />
-            </CaretBox>
-          </Flex>
-        </MainRow>
-        <FieldHint />
-        <FieldError />
-      </Stack>
-      {open && (
-        <Popover
-          id={`${generatedId}-popover`}
-          source={containerRef}
-          spacing={4}
-          fullWidth
-          intersectionId={`${generatedId}-listbox-popover-intersection`}
-          onReachEnd={hasMoreItems && !loading ? onLoadMore : undefined}
-        >
-          <div
-            role="listbox"
-            ref={listboxRef}
-            id={`${generatedId}-listbox`}
-            aria-labelledby={label ? labelId : undefined}
-          >
-            {(Boolean(filteredNodes.length) || creatable) && (
-              <>
-                <ComboboxList activeOptionRef={activeOptionRef} options={filteredNodesClone} />
-                {hasOption(inputValue) && creatable && (
-                  <ComboboxOption
-                    isSelected={activeIndex === filteredNodes.length}
-                    ref={(r) => {
-                      if (activeIndex === filteredNodes.length) activeOptionRef.current = r;
-                    }}
-                    onMouseDown={onOptionMouseDown}
-                    onClick={() => onOptionSelect()}
-                    taindex={0}
-                  >
-                    {createMessage(inputValue)}
-                  </ComboboxOption>
-                )}
-              </>
-            )}
-            {!Boolean(filteredNodes.length) && !creatable && !loading && (
-              <Box paddingLeft={4} paddingRight={4} paddingTop={2} paddingBottom={2} ref={activeOptionRef}>
-                <Typography textColor="neutral800">{noOptionsMessage(inputValue)}</Typography>
-              </Box>
-            )}
-            {loading && (
-              <Flex justifyContent="center" alignItems="center" paddingTop={2} paddingBottom={2}>
-                <Loader small>{loadingMessage}</Loader>
-              </Flex>
-            )}
-          </div>
-        </Popover>
-      )}
-    </Field>
-  );
-};
-
-export const CreatableCombobox = (props) => <Combobox {...props} creatable />;
-
-Combobox.defaultProps = CreatableCombobox.defaultProps = {
-  'aria-label': undefined,
-  clearLabel: 'clear',
-  creatable: false,
-  createMessage: (value) => `Create "${value}"`,
-  disabled: false,
-  error: undefined,
-  hasMoreItems: false,
-  hint: undefined,
-  label: undefined,
-  loading: false,
-  loadingMessage: 'Loading content...',
-  noOptionsMessage: () => 'No results found',
-  onClear: undefined,
-  onCreateOption: undefined,
-  onInputChange: undefined,
-  onLoadMore: undefined,
-  placeholder: 'Select or enter a value',
-  value: undefined,
-};
-
-Combobox.propTypes = {
-  'aria-label': PropTypes.string,
-  children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]),
-  clearLabel: PropTypes.string,
-  creatable: PropTypes.bool,
-  createMessage: PropTypes.func,
-  disabled: PropTypes.bool,
-  error: PropTypes.string,
-  hasMoreItems: PropTypes.bool,
-  hint: PropTypes.oneOfType([PropTypes.string, PropTypes.node, PropTypes.arrayOf(PropTypes.node)]),
-  label: PropTypes.string,
-  labelAction: PropTypes.element,
-  loading: PropTypes.bool,
-  loadingMessage: PropTypes.string,
-  noOptionsMessage: PropTypes.func,
-  onChange: PropTypes.func.isRequired,
-  onClear: PropTypes.func,
-  onCreateOption: PropTypes.func,
-  onInputChange: PropTypes.func,
-  onLoadMore: PropTypes.func,
-  placeholder: PropTypes.string,
-  value: PropTypes.string,
-};
-
-CreatableCombobox.propTypes = {
-  ...Combobox.propTypes,
-  onCreateOption: PropTypes.func.isRequired,
-};