@scality/core-ui 0.135.0 → 0.137.0

package/src/lib/components/searchinput/SearchInput.component.tsx

@@ -10,7 +10,6 @@ export type Props = {
   value: string;
   onChange: (e: ChangeEvent<HTMLInputElement>) => void;
   onReset?: () => void;
-  disableToggle: boolean;
   disabled?: boolean;
   id?: string;
   size?: InputSize;
@@ -57,7 +56,6 @@ const ClearButton = styled.div`
 const SearchInput = forwardRef(
   (
     {
-      disableToggle,
       placeholder,
       value,
       onChange,

package/src/lib/components/searchinput/SearchInput.test.tsx

@@ -0,0 +1,88 @@
+import React from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import { SearchInput, Props } from './SearchInput.component';
+import { QueryClient, QueryClientProvider } from 'react-query';
+import userEvent from '@testing-library/user-event';
+
+const queryClient = new QueryClient();
+
+const SearchInputRender = (props: Props) => {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <SearchInput {...props} />
+    </QueryClientProvider>
+  );
+};
+
+describe('SearchInput', () => {
+  const selectors = {
+    searchInput: () => screen.getByRole('searchbox'),
+    clearButton: () => screen.queryByRole('button'),
+  };
+  it('should render the SearchInput component', () => {
+    render(<SearchInputRender value="" onChange={() => {}} />);
+
+    const searchInput = selectors.searchInput();
+    expect(searchInput).toBeInTheDocument();
+  });
+
+  it('should render the SearchInput component with placeholder', () => {
+    render(
+      <SearchInputRender value="" onChange={() => {}} placeholder="Search" />,
+    );
+
+    const searchInput = screen.queryByPlaceholderText('Example: Search');
+    expect(searchInput).toBeInTheDocument();
+  });
+
+  it('should render the SearchInput component with disabled prop', () => {
+    render(<SearchInputRender value="" onChange={() => {}} disabled />);
+
+    const searchInput = selectors.searchInput();
+    expect(searchInput).toBeInTheDocument();
+    expect(searchInput).toBeDisabled();
+  });
+
+  it('should change value instantly but call the onChange function with a 300ms delay after the end of typing', async () => {
+    const onChange = jest.fn();
+    render(<SearchInputRender value="" onChange={onChange} />);
+    const searchInput = selectors.searchInput();
+    userEvent.type(searchInput, 'test');
+    expect(searchInput).toHaveValue('test');
+    expect(onChange).not.toHaveBeenCalled();
+    await waitFor(
+      () => {
+        expect(onChange).toHaveBeenCalled();
+      },
+      { timeout: 350 },
+    );
+  });
+
+  it('should have a clear button when the input is not empty', () => {
+    render(<SearchInputRender value="" onChange={() => {}} />);
+
+    // clear button should not be rendered as value is empty
+    let clearButton = selectors.clearButton();
+    expect(clearButton).not.toBeInTheDocument();
+
+    const searchInput = selectors.searchInput();
+    userEvent.type(searchInput, 'test');
+
+    // clear button should now be rendered
+    clearButton = selectors.clearButton();
+    expect(clearButton).toBeInTheDocument();
+  });
+
+  it('should call the onReset function when the clear button is clicked and clear the input value', async () => {
+    const onReset = jest.fn();
+    render(
+      <SearchInputRender value="test" onChange={() => {}} onReset={onReset} />,
+    );
+    const searchInput = selectors.searchInput();
+    const clearButton = selectors.clearButton();
+    expect(clearButton).toBeInTheDocument();
+    clearButton && userEvent.click(clearButton);
+    expect(onReset).toHaveBeenCalled();
+    expect(searchInput).toHaveValue('');
+  });
+});

package/src/lib/components/selectv2/Selectv2.component.tsx

@@ -135,7 +135,11 @@ const InternalOption = (width, isDefaultVariant) => (props) => {
                 ? 'sc-highlighted-matching-text'
                 : '';
             return (
-              <span key={i} className={highlightStyle}>
+              <span
+                role={highlightStyle ? 'mark' : undefined}
+                key={i}
+                className={highlightStyle}
+              >
                 {part}
               </span>
             );
@@ -238,7 +242,6 @@ const MenuList = (props) => {
     selectedIndex * optionHeight - (ITEMS_PER_SCROLL_WINDOW - 1) * optionHeight;
   useEffect(() => {
     if (listRef && listRef.current) {
-      // @ts-ignore
       listRef.current.scrollTo(
         getScrollOffset(
           listRef.current,
@@ -282,6 +285,7 @@ const ValueContainer = ({ children, ...props }) => {
   const icon = selectedOption ? selectedOption.icon : null;
   const ariaProps = {
     innerProps: {
+      disabled: true,
       role: props.selectProps.isSearchable ? 'combobox' : 'listbox',
       'aria-expanded': props.selectProps.menuIsOpen,
       'aria-autocomplete': 'list',
@@ -302,7 +306,6 @@ export type SelectProps = {
   placeholder?: string;
   disabled?: boolean;
   children?: React.ReactNode;
-  defaultValue?: string;
   value?: string;
   onFocus?: (event: FocusEvent) => void;
   onBlur?: (event: FocusEvent) => void;
@@ -310,6 +313,7 @@ export type SelectProps = {
   variant?: 'default' | 'rounded';
   size?: '1' | '2/3' | '1/2' | '1/3';
   className?: string;
+  /** use menuPositon='fixed' inside modal to avoid display issue */
   menuPosition?: 'fixed' | 'absolute';
 };
 type SelectOptionProps = {
@@ -357,7 +361,6 @@ function SelectWithOptionContext(props: SelectProps) {
 function SelectBox({
   placeholder = 'Select...',
   disabled = false,
-  defaultValue,
   value,
   onChange,
   variant = 'default',
@@ -366,11 +369,6 @@ function SelectBox({
   id,
   ...rest
 }: SelectProps) {
-  if (defaultValue && value) {
-    console.error(
-      'The `defaultValue` will be overridden by the `value` if they are set at the same time.',
-    );
-  }
   const [keyboardFocusEnabled, setKeyboardFocusEnabled] = useState(false);
   const [searchSelection, setSearchSelection] = useState('');
   const [searchValue, setSearchValue] = useState('');
@@ -414,7 +412,6 @@ function SelectBox({
   // Force to reset the value
   useEffect(() => {
     if (
-      !defaultValue &&
       !isEmptyStringInOptions &&
       value === '' &&
       selectRef.current &&
@@ -436,7 +433,6 @@ function SelectBox({
             value={
               searchSelection || options.find((opt) => opt.value === value)
             }
-            defaultValue={defaultValue}
             inputValue={options.length > NOPT_SEARCH ? searchValue : undefined}
             selectedOption={options.find((opt) => opt.value === value)}
             keyboardFocusEnabled={keyboardFocusEnabled}

package/src/lib/components/selectv2/selectv2.test.tsx

@@ -1,13 +1,7 @@
-import {
-  screen,
-  render as testingRender,
-  within,
-} from '@testing-library/react';
+import { screen, render as testingRender } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import React, { useState } from 'react';
 import { QueryClient, QueryClientProvider } from 'react-query';
-import { debug } from 'jest-preview';
-import { Icon } from '../icon/Icon.component';
 import { Option, Select } from '../selectv2/Selectv2.component';
 
 const render = (args) => {
@@ -27,26 +21,24 @@ const generateOptionsData = (n: number) =>
 
 const generateOptions = (n: number) => {
   return generateOptionsData(n).map((o, i) => (
-    <Option key={i} value={o.value} {...o}>
+    <Option key={i} {...o} value={o.value}>
       {o.label}
     </Option>
   ));
 };
+const optionsWithScrollSearchBar = generateOptions(10); // more than 8 options should display searchbar + scrollbar
+
+const simpleOptions = generateOptions(4); // less than 5 options should not displays any scroll/search bar
 
 const SelectWrapper = (props) => {
-  const [value, setValue] = useState(null);
+  const [value, setValue] = useState<string | null>(null);
   return (
     <Select value={value} onChange={(value) => setValue(value)} {...props}>
-      {props.children}
+      {props.children || simpleOptions}
     </Select>
   );
 };
 
-const variants = ['default', 'rounded'];
-const optionsWithScrollSearchBar = generateOptions(10); // more than 8 options should display searchbar + scrollbar
-
-const simpleOptions = generateOptions(4); // less than 5 options should not displays any scroll/search bar
-
 const SelectReset = (props) => {
   const [value, setValue] = useState('default');
 
@@ -64,220 +56,218 @@ const SelectReset = (props) => {
 };
 
 describe('SelectV2', () => {
-  const toBeClose = (container) => {
-    expect(container.getElementsByClassName('sc-select__option').length).toBe(
-      0,
-    );
-  };
-
-  const toBeOpenWith = (container, optionsLength: number) => {
-    expect(container.getElementsByClassName('sc-select__option').length).toBe(
-      optionsLength,
-    );
-  };
-
-  const toggleSelect = (container) => {
-    userEvent.click(container.querySelector('.sc-select__control'));
+  const selectors = {
+    option: (name: string | RegExp) => screen.getByRole('option', { name }),
+    options: () => screen.queryAllByRole('option'),
+    select: (withSearch?: boolean, name?: string) => {
+      if (withSearch) {
+        return screen.getByRole('combobox', { name });
+      }
+      return screen.getByRole('listbox', { name });
+    },
+    input: () => screen.getByRole('textbox'),
+    noOptions: () => screen.getByText(/No options/i),
+    highlightedText: () => screen.getByRole('mark'),
   };
 
-  test.each(variants)(
-    'should open select on click/Enter/ArrowDown',
-    (variant) => {
-      const { container } = render(
-        <SelectWrapper variant={variant}>{simpleOptions}</SelectWrapper>,
-      );
-      // should open on click
-      toBeClose(container);
-      toggleSelect(container); // open
-
-      toBeOpenWith(container, simpleOptions.length);
-      toggleSelect(container); // close
-
-      userEvent.tab(); // remove focus
+  it('should throw error if <Option/> is outside <Select/>', () => {
+    expect(() => render(<Option value="Option 1" />)).toThrowError();
+  });
 
-      // should open with Enter/ArrowDown
-      ['Enter', 'ArrowDown'].forEach((key) => {
-        // should open on arrow down
-        toBeClose(container);
-        userEvent.tab(); // focus
+  it('should open/close on click', () => {
+    render(<SelectWrapper />);
+    const select = selectors.select();
+    expect(select).toBeInTheDocument();
+    let options = selectors.options();
+    expect(options).toHaveLength(0);
+
+    // should open on click
+    userEvent.click(select);
+    simpleOptions.forEach((opt) => {
+      const option = selectors.option(opt.props.label);
+      expect(option).toBeInTheDocument();
+    });
+
+    userEvent.click(select);
+    options = selectors.options();
+    expect(options).toHaveLength(0);
+  });
 
-        userEvent.keyboard(`{${key}}`);
-        toBeOpenWith(container, simpleOptions.length);
-        toggleSelect(container); // close select
+  it('should open/close with keyboard', () => {
+    render(<SelectWrapper />);
+    const select = selectors.select();
+    expect(select).toBeInTheDocument();
+    const options = selectors.options();
+    expect(options).toHaveLength(0);
+
+    // should open on Enter
+    userEvent.tab();
+    userEvent.keyboard('{Enter}');
+    simpleOptions.forEach((opt) => {
+      const option = selectors.option(opt.props.label);
+      expect(option).toBeInTheDocument();
+    });
+
+    // should close on Enter
+    userEvent.keyboard('{Enter}');
+    expect(options).toHaveLength(0);
+
+    // should open on ArrowDown
+    userEvent.tab();
+    userEvent.keyboard('{ArrowDown}');
+    simpleOptions.forEach((opt) => {
+      const option = selectors.option(opt.props.label);
+      expect(option).toBeInTheDocument();
+    });
+  });
 
-        toBeClose(container);
-        userEvent.tab(); // remove focus
-      });
-    },
-  );
-  test.each(variants)('should display custom placeholder', (variant) => {
+  it('should display custom placeholder', () => {
     const placeholder = 'My placeholder...';
-    const { container } = render(
-      <SelectWrapper variant={variant} placeholder={placeholder}>
+    render(<SelectWrapper placeholder={placeholder} />);
+    expect(screen.getByText(placeholder)).toBeInTheDocument();
+  });
+
+  it('should be disabled', () => {
+    render(
+      <SelectWrapper value="1" disabled={true}>
         {simpleOptions}
       </SelectWrapper>,
     );
-    expect(
-      container.querySelector('.sc-select__placeholder'),
-    ).toHaveTextContent(placeholder);
-  });
-  test.each(variants)('should display default value', (variant) => {
-    const options = [
-      {
-        value: 0,
-        label: 'Label 0',
-      },
-    ];
-    const { container } = render(
-      <Select variant={variant} defaultValue={options[0]} options={options} />,
-    );
-    expect(container.querySelector('.sc-select__placeholder')).toBeNull();
-    expect(
-      container.querySelector('.sc-select__single-value'),
-    ).toHaveTextContent('Label 0');
+    userEvent.tab();
+    const select = selectors.select();
+    expect(select).not.toHaveFocus();
+    // use input instead of select because select will still trigger the open/close action
+    // despite select container not being clickable and input being disabled
+    const input = selectors.input();
+    userEvent.click(input);
+    const options = selectors.options();
+    expect(options).toHaveLength(0);
   });
-  test.each(variants)('select should be disabled', (variant) => {
-    const { container } = render(
-      <Select variant={variant} disabled defaultValue="0">
-        <Option value="0">{'Label 0'}</Option>
-      </Select>,
+
+  it('should display no option', () => {
+    render(
+      <SelectWrapper>
+        <></>
+      </SelectWrapper>,
     );
-    expect(container.querySelector('input')).toBeDisabled();
+    const select = selectors.select();
+    userEvent.click(select);
+    const noOptions = selectors.noOptions();
+    expect(noOptions).toBeInTheDocument();
   });
-  test.each(variants)('should display no options', (variant) => {
-    const { container } = render(<Select variant={variant} />);
-    toggleSelect(container, variant);
-    expect(
-      container.querySelector('.sc-select__menu-notice--no-options'),
-    ).toHaveTextContent('No options');
+
+  it('should filter and highlight on search', () => {
+    render(<SelectWrapper>{optionsWithScrollSearchBar} </SelectWrapper>);
+    const select = selectors.select(true);
+    userEvent.click(select);
+    const input = selectors.input();
+
+    userEvent.type(input, '2');
+    const options = selectors.options();
+    expect(options).toHaveLength(1);
+    const searchedText = selectors.highlightedText();
+    expect(searchedText).toHaveTextContent('2');
   });
-  test.each(variants)(
-    'should display a search bar if more than 8 options',
-    (variant) => {
-      const { container } = render(
-        <SelectWrapper variant={variant}>
-          {optionsWithScrollSearchBar}
-        </SelectWrapper>,
-      );
-      expect(container.querySelector('.sc-select__input')).not.toBeNull();
-    },
-  );
-  test.each(variants)('should display option', (variant) => {
-    const { container, getByTestId } = render(
-      <Select variant={variant}>
-        <Option data-testid="disabledOption" value="0" disabled>
-          Label 1
-        </Option>
-        <Option
-          data-testid="option2"
-          value="1"
-          icon={<Icon name="Deletion-marker" />}
-        >
-          Label 2
-        </Option>
-      </Select>,
-    );
-    toggleSelect(container);
-    expect(getByTestId('disabledOption')).toHaveAttribute(
-      'aria-disabled',
-      'true',
-    );
-    const icon = getByTestId('option2').querySelector('i');
-    expect(icon).not.toBeNull();
-    expect(icon).toHaveAttribute('aria-label', 'Deletion-marker ');
+
+  it('should unfocus the search input when the select is closed', () => {
+    render(<SelectWrapper>{optionsWithScrollSearchBar} </SelectWrapper>);
+    const select = selectors.select(true);
+    userEvent.click(select);
+    let input = selectors.input();
+    expect(input).toHaveFocus();
+    const option = selectors.option(/Item 1/);
+    userEvent.click(option);
+    input = selectors.input();
+    expect(input).not.toHaveFocus();
   });
-  test.each(variants)(
-    '<Option/> component should throw if outside <Select/>',
-    () => {
-      // mock console.error to not display error message on throw
-      jest.spyOn(console, 'error');
-      console.error.mockImplementation(() => {});
-      expect(() => render(<Option />)).toThrowError();
-      console.error.mockRestore(); // restore console.error
-    },
-  );
-  test.each(variants)('should highlight text on search', (variant) => {
-    const { container, getByTestId } = render(
-      <SelectWrapper variant={variant}>
-        {optionsWithScrollSearchBar}
-      </SelectWrapper>,
+
+  it('should be possible to use searchbar when option is selected', () => {
+    render(
+      <SelectWrapper value="1">{optionsWithScrollSearchBar}</SelectWrapper>,
     );
-    toggleSelect(container);
-    userEvent.type(container.querySelector('input'), 'Ite');
-    const firstOption = getByTestId('option0');
-    expect(firstOption).toHaveClass('sc-select__option--is-focused');
-    expect(
-      container.querySelector('.sc-highlighted-matching-text'),
-    ).toHaveTextContent('Ite');
+    expect(screen.getByText(/Item 1/)).toBeVisible();
+    const select = selectors.select(true);
+    userEvent.click(select);
+    const input = selectors.input();
+    userEvent.type(input, '2');
+    expect(screen.queryByText(/Item 1/)).not.toBeInTheDocument();
+    const options = selectors.options();
+    expect(options).toHaveLength(1);
   });
-  test.each(variants)('should select/unselect option', (variant) => {
-    const { container, getByTestId } = render(
-      <SelectWrapper variant={variant}>{simpleOptions}</SelectWrapper>,
-    );
-    // select option
-    toggleSelect(container); // open select
 
-    toBeOpenWith(container, simpleOptions.length);
-    userEvent.click(getByTestId('option0'));
-    toBeClose(container); // selecting an option should close select
-
-    // unselect option
-    toggleSelect(container); // reopen select
+  it('should select/unselect option with keyboard', () => {
+    render(<SelectWrapper />);
+    const select = selectors.select();
+    userEvent.tab();
+    userEvent.keyboard('{ArrowDown}');
 
-    expect(getByTestId('option0')).toHaveClass(
-      'sc-select__option--is-selected',
-    );
-    // should be focused on the selected option
-    expect(getByTestId('option0')).toHaveAttribute('aria-selected', 'true');
-    userEvent.click(getByTestId('option1')); // click on another option
+    // should select first option
+    userEvent.keyboard('{Enter}');
+    expect(select).toHaveTextContent('Item 0');
 
-    toBeClose(container); // selecting an option should close select
+    // should select second option
+    userEvent.tab();
+    userEvent.keyboard('{ArrowDown}');
+    userEvent.keyboard('{ArrowDown}');
 
-    toggleSelect(container); // reopen select
+    userEvent.keyboard('{Enter}');
+    expect(select).toHaveTextContent('Item 1');
+  });
 
-    expect(getByTestId('option1')).toHaveClass(
-      'sc-select__option--is-selected',
-    );
-    expect(getByTestId('option1')).toHaveAttribute('aria-selected', 'true');
-    expect(getByTestId('option0')).not.toHaveClass(
-      'sc-select__option--is-selected',
+  it('should scroll to selected value when opening select', () => {
+    render(
+      <SelectWrapper value={optionsWithScrollSearchBar[9].props.value}>
+        {optionsWithScrollSearchBar}
+      </SelectWrapper>,
     );
-    expect(getByTestId('option0')).not.toHaveAttribute('aria-selected', 'true');
+    const select = selectors.select(true);
+    userEvent.click(select);
+    const option = selectors.option(/Item 9/);
+    expect(screen.queryByRole('option', { name: /Item 1/i })).toBeNull();
+    expect(option).toBeVisible();
   });
-  test.each(variants)('should focus on keyDown/keyUp', (variant) => {
-    const { container, getByTestId } = render(
-      <SelectWrapper variant={variant}>{simpleOptions}</SelectWrapper>,
-    );
-    toggleSelect(container);
-    userEvent.keyboard('{ArrowDown}');
-    expect(getByTestId('option0')).not.toHaveClass(
-      'sc-select__option--is-focused',
-    );
-    expect(getByTestId('option1')).toHaveClass('sc-select__option--is-focused');
-    userEvent.keyboard('{ArrowUp}');
-    expect(getByTestId('option0')).toHaveClass('sc-select__option--is-focused');
-    expect(getByTestId('option1')).not.toHaveClass(
-      'sc-select__option--is-focused',
-    );
+
+  it('should be able to reset the value', () => {
+    render(<SelectReset>{simpleOptions}</SelectReset>);
+    const button = screen.getByText(/reset/);
+    userEvent.click(button);
+    const select = selectors.select();
+    expect(select).toHaveTextContent('Select...');
   });
-  test.each(variants)('should be able to reset the value', (variant) => {
-    const { container } = render(
-      <SelectReset variant={variant}>{simpleOptions}</SelectReset>,
+
+  it('should not be possible to select an option if it is disabled', () => {
+    render(
+      <SelectWrapper>
+        <Option value="1" disabled>
+          Item 1
+        </Option>
+        <Option value="2">Item 2</Option>
+      </SelectWrapper>,
     );
-    userEvent.click(container.querySelector('button'));
-    expect(
-      container.querySelector('.sc-select__placeholder'),
-    ).toHaveTextContent('Select...');
+    const select = selectors.select();
+    userEvent.click(select);
+    const option = selectors.option(/Item 1/);
+
+    userEvent.click(option);
+    const option2 = selectors.option(/Item 2/);
+    expect(option2).toBeVisible();
   });
 
-  it('should not trigger onChange when defaultValue is empty string', () => {
-    const onChange = jest.fn();
+  it('should display a tooltip if the option is disabled with a reason', () => {
     render(
-      <Select value={''} onChange={onChange}>
-        <Option value="test">test</Option>
-      </Select>,
+      <SelectWrapper>
+        <Option value="1" disabled disabledReason="This option is disabled">
+          Item 1
+        </Option>
+      </SelectWrapper>,
     );
-    expect(onChange).toBeCalledTimes(0);
+    const select = selectors.select();
+    userEvent.click(select);
+    const option = selectors.option(/Item 1/);
+    expect(option).toHaveAttribute('aria-disabled', 'true');
+    userEvent.hover(option);
+    const tooltip = screen.getByText(/This option is disabled/);
+    expect(tooltip).toBeInTheDocument();
   });
 
   it('should select with the right selector', async () => {

package/src/lib/components/tablev2/Search.tsx

@@ -17,7 +17,7 @@ export type SearchProps = {
   value?: string;
   locale?: TableLocalType;
   totalCount?: number;
-} & Omit<Props, 'disableToggle' | 'onChange'>;
+} & Omit<Props, 'onChange'>;
 
 const SearchContainer = styled.div`
   display: flex;
@@ -88,7 +88,6 @@ export function TableSearch(props: SearchProps) {
       <SearchInput
         value={value}
         placeholder={translations[locale].search}
-        disableToggle
         size="1"
         onChange={(evt) => {
           if (typeof onChange === 'function') {