@patternfly/react-templates 6.0.0-alpha.4 → 6.0.0-alpha.41

package/src/components/Select/__tests__/TypeaheadSelect.test.tsx

@@ -0,0 +1,408 @@
+import * as React from 'react';
+import { render, screen, waitForElementToBeRemoved } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { TypeaheadSelect } from '../TypeaheadSelect';
+import styles from '@patternfly/react-styles/css/components/Menu/menu';
+
+test('renders typeahead select with options', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  const option1 = screen.getByText('Option 1');
+  const option2 = screen.getByText('Option 2');
+  const option3 = screen.getByText('Option 3');
+
+  expect(option1).toBeInTheDocument();
+  expect(option2).toBeInTheDocument();
+  expect(option3).toBeInTheDocument();
+});
+
+test('selects options when clicked', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+
+  expect(option1).not.toHaveClass(styles.modifiers.selected);
+
+  await user.click(option1);
+
+  expect(option1).toHaveClass(styles.modifiers.selected);
+});
+
+test('calls the onSelect callback with the selected value when an option is selected', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+  const onSelectMock = jest.fn();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} onSelect={onSelectMock} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  expect(onSelectMock).not.toHaveBeenCalled();
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+
+  await user.click(option1);
+
+  expect(onSelectMock).toHaveBeenCalledTimes(1);
+  expect(onSelectMock).toHaveBeenCalledWith(expect.anything(), 'option1');
+});
+
+test('deselects options when clear button is clicked', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+  await user.click(option1);
+  expect(option1).toHaveClass(styles.modifiers.selected);
+
+  const input = screen.getByRole('combobox');
+  expect(input).toHaveValue('Option 1');
+
+  const clearButton = screen.getByRole('button', { name: 'Clear input value' });
+  await user.click(clearButton);
+  expect(input).toHaveValue('');
+
+  await user.click(toggle);
+  expect(screen.getByRole('option', { name: 'Option 1' })).not.toHaveClass(styles.modifiers.selected);
+});
+
+test('toggles the select menu when the toggle button is clicked', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  const menu = screen.getByRole('listbox');
+  expect(menu).toBeInTheDocument();
+
+  await user.click(toggle);
+
+  await waitForElementToBeRemoved(menu);
+
+  expect(screen.queryByRole('listbox')).not.toBeInTheDocument();
+});
+
+test('calls the onToggle callback when the toggle is clicked', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+  const onToggleMock = jest.fn();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} onToggle={onToggleMock} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  expect(onToggleMock).not.toHaveBeenCalled();
+
+  await user.click(toggle);
+
+  expect(onToggleMock).toHaveBeenCalledTimes(1);
+  expect(onToggleMock).toHaveBeenCalledWith(true);
+
+  await user.click(toggle);
+
+  expect(onToggleMock).toHaveBeenCalledTimes(2);
+  expect(onToggleMock).toHaveBeenCalledWith(false);
+});
+
+test('Passes toggleWidth', () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  render(<TypeaheadSelect initialOptions={initialOptions} toggleWidth="500px" />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  expect(toggle.parentElement).toHaveAttribute('style', 'width: 500px;');
+});
+
+test('Passes additional toggleProps', () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  render(<TypeaheadSelect initialOptions={initialOptions} toggleProps={{ id: 'toggle' }} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  expect(toggle.parentElement).toHaveAttribute('id', 'toggle');
+});
+
+test('passes custom placeholder text', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  render(<TypeaheadSelect initialOptions={initialOptions} placeholder="custom" />);
+
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'custom');
+});
+
+test('displays noOptionsFoundMessage when filter returns no results', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'Select an option');
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+  const option2 = screen.getByRole('option', { name: 'Option 2' });
+  const option3 = screen.getByRole('option', { name: 'Option 3' });
+
+  expect(option1).toBeInTheDocument();
+  expect(option2).toBeInTheDocument();
+  expect(option3).toBeInTheDocument();
+
+  await user.type(input, '9');
+  expect(input).toHaveValue('9');
+
+  expect(option1).not.toBeInTheDocument();
+  expect(option2).not.toBeInTheDocument();
+  expect(option3).not.toBeInTheDocument();
+  expect(screen.getByRole('option', { name: 'No results found for "9"' })).toBeInTheDocument();
+});
+
+test('displays custom noOptionsFoundMessage', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} noOptionsFoundMessage="custom" />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'Select an option');
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+  const option2 = screen.getByRole('option', { name: 'Option 2' });
+  const option3 = screen.getByRole('option', { name: 'Option 3' });
+
+  expect(option1).toBeInTheDocument();
+  expect(option2).toBeInTheDocument();
+  expect(option3).toBeInTheDocument();
+
+  await user.type(input, '9');
+  expect(input).toHaveValue('9');
+
+  expect(option1).not.toBeInTheDocument();
+  expect(option2).not.toBeInTheDocument();
+  expect(option3).not.toBeInTheDocument();
+  expect(screen.getByRole('option', { name: 'custom' })).toBeInTheDocument();
+});
+
+test('disables the select when isDisabled prop is true', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} isDisabled={true} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  expect(toggle.parentElement).toHaveClass(styles.modifiers.disabled);
+
+  await user.click(toggle);
+
+  expect(screen.queryByRole('menu')).not.toBeInTheDocument();
+});
+
+test('passes other SelectOption props to the SelectOption component', async () => {
+  const initialOptions = [{ content: 'Option 1', value: 'option1', isDisabled: true }];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+  expect(option1).toBeDisabled();
+});
+
+test('displays the option in input when option is selected', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'Select an option');
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+
+  await user.click(option1);
+
+  expect(input).toHaveValue('Option 1');
+
+  const clearButton = screen.getByRole('button', { name: 'Clear input value' });
+  await user.click(clearButton);
+
+  expect(input).toHaveValue('');
+});
+
+test('typing in input filters options', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'Select an option');
+
+  await user.click(toggle);
+
+  const option1 = screen.getByRole('option', { name: 'Option 1' });
+  const option2 = screen.getByRole('option', { name: 'Option 2' });
+  const option3 = screen.getByRole('option', { name: 'Option 3' });
+
+  expect(option1).toBeInTheDocument();
+  expect(option2).toBeInTheDocument();
+  expect(option3).toBeInTheDocument();
+
+  await user.type(input, '1');
+  expect(input).toHaveValue('1');
+
+  expect(option1).toBeInTheDocument();
+  expect(option2).not.toBeInTheDocument();
+  expect(option3).not.toBeInTheDocument();
+});
+
+test('typing in input triggers onInputChange callback', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+  const onInputChangeMock = jest.fn();
+
+  render(<TypeaheadSelect initialOptions={initialOptions} onInputChange={onInputChangeMock} />);
+
+  const input = screen.getByRole('combobox');
+
+  expect(input).toHaveAttribute('placeholder', 'Select an option');
+
+  await user.type(input, '1');
+
+  expect(input).toHaveValue('1');
+  expect(onInputChangeMock).toHaveBeenCalledTimes(1);
+  expect(onInputChangeMock).toHaveBeenCalledWith('1');
+});
+
+test('Matches snapshot', async () => {
+  const initialOptions = [
+    { content: 'Option 1', value: 'option1' },
+    { content: 'Option 2', value: 'option2' },
+    { content: 'Option 3', value: 'option3' }
+  ];
+
+  const user = userEvent.setup();
+
+  const { asFragment } = render(<TypeaheadSelect initialOptions={initialOptions} />);
+
+  const toggle = screen.getByRole('button', { name: 'Typeahead menu toggle' });
+  await user.click(toggle);
+
+  expect(asFragment()).toMatchSnapshot();
+});

package/src/components/Select/__tests__/__snapshots__/CheckboxSelectSnapshots.test.tsx.snap

@@ -0,0 +1,83 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`checkbox select with no props snapshot 1`] = `
+<DocumentFragment>
+  <button
+    aria-expanded="false"
+    class="pf-v6-c-menu-toggle"
+    data-ouia-component-id="OUIA-Generated-MenuToggle-1"
+    data-ouia-component-type="PF6/MenuToggle"
+    data-ouia-safe="true"
+    style="width: 200px;"
+    type="button"
+  >
+    <span
+      class="pf-v6-c-menu-toggle__text"
+    >
+      Filter by status
+    </span>
+    <span
+      class="pf-v6-c-menu-toggle__controls"
+    >
+      <span
+        class="pf-v6-c-menu-toggle__toggle-icon"
+      >
+        <svg
+          aria-hidden="true"
+          class="pf-v6-svg"
+          fill="currentColor"
+          height="1em"
+          role="img"
+          viewBox="0 0 320 512"
+          width="1em"
+        >
+          <path
+            d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+          />
+        </svg>
+      </span>
+    </span>
+  </button>
+</DocumentFragment>
+`;
+
+exports[`opened checkbox select snapshot 1`] = `
+<DocumentFragment>
+  <button
+    aria-expanded="true"
+    class="pf-v6-c-menu-toggle pf-m-expanded"
+    data-ouia-component-id="OUIA-Generated-MenuToggle-2"
+    data-ouia-component-type="PF6/MenuToggle"
+    data-ouia-safe="true"
+    style="width: 200px;"
+    type="button"
+  >
+    <span
+      class="pf-v6-c-menu-toggle__text"
+    >
+      Filter by status
+    </span>
+    <span
+      class="pf-v6-c-menu-toggle__controls"
+    >
+      <span
+        class="pf-v6-c-menu-toggle__toggle-icon"
+      >
+        <svg
+          aria-hidden="true"
+          class="pf-v6-svg"
+          fill="currentColor"
+          height="1em"
+          role="img"
+          viewBox="0 0 320 512"
+          width="1em"
+        >
+          <path
+            d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+          />
+        </svg>
+      </span>
+    </span>
+  </button>
+</DocumentFragment>
+`;

package/src/components/Select/__tests__/__snapshots__/SimpleSelect.test.tsx.snap

@@ -0,0 +1,83 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Matches snapshot 1`] = `
+<DocumentFragment>
+  <button
+    aria-expanded="true"
+    class="pf-v6-c-menu-toggle pf-m-expanded"
+    data-ouia-component-id="OUIA-Generated-MenuToggle-13"
+    data-ouia-component-type="PF6/MenuToggle"
+    data-ouia-safe="true"
+    style="width: 200px;"
+    type="button"
+  >
+    <span
+      class="pf-v6-c-menu-toggle__text"
+    >
+      Select
+    </span>
+    <span
+      class="pf-v6-c-menu-toggle__controls"
+    >
+      <span
+        class="pf-v6-c-menu-toggle__toggle-icon"
+      >
+        <svg
+          aria-hidden="true"
+          class="pf-v6-svg"
+          fill="currentColor"
+          height="1em"
+          role="img"
+          viewBox="0 0 320 512"
+          width="1em"
+        >
+          <path
+            d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+          />
+        </svg>
+      </span>
+    </span>
+  </button>
+</DocumentFragment>
+`;
+
+exports[`checkbox select with no props snapshot 1`] = `
+<DocumentFragment>
+  <button
+    aria-expanded="false"
+    class="pf-v6-c-menu-toggle"
+    data-ouia-component-id="OUIA-Generated-MenuToggle-12"
+    data-ouia-component-type="PF6/MenuToggle"
+    data-ouia-safe="true"
+    style="width: 200px;"
+    type="button"
+  >
+    <span
+      class="pf-v6-c-menu-toggle__text"
+    >
+      Select a value
+    </span>
+    <span
+      class="pf-v6-c-menu-toggle__controls"
+    >
+      <span
+        class="pf-v6-c-menu-toggle__toggle-icon"
+      >
+        <svg
+          aria-hidden="true"
+          class="pf-v6-svg"
+          fill="currentColor"
+          height="1em"
+          role="img"
+          viewBox="0 0 320 512"
+          width="1em"
+        >
+          <path
+            d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+          />
+        </svg>
+      </span>
+    </span>
+  </button>
+</DocumentFragment>
+`;

package/src/components/Select/__tests__/__snapshots__/TypeaheadSelect.test.tsx.snap

@@ -0,0 +1,97 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Matches snapshot 1`] = `
+<DocumentFragment>
+  <div
+    class="pf-v6-c-menu-toggle pf-m-expanded pf-m-full-width pf-m-typeahead"
+  >
+    <div
+      class="pf-v6-c-text-input-group pf-m-plain"
+    >
+      <div
+        autocomplete="off"
+        class="pf-v6-c-text-input-group__main"
+      >
+        <span
+          class="pf-v6-c-text-input-group__text"
+        >
+          <input
+            aria-controls="select-typeahead-listbox"
+            aria-expanded="true"
+            aria-label="Type to filter"
+            class="pf-v6-c-text-input-group__text-input"
+            placeholder="Select an option"
+            role="combobox"
+            type="text"
+            value=""
+          />
+        </span>
+      </div>
+      <div
+        class="pf-v6-c-text-input-group__utilities"
+        style="display: none;"
+      >
+        <button
+          aria-disabled="false"
+          aria-label="Clear input value"
+          class="pf-v6-c-button pf-m-plain"
+          data-ouia-component-id="OUIA-Generated-Button-plain-17"
+          data-ouia-component-type="PF6/Button"
+          data-ouia-safe="true"
+          type="button"
+        >
+          <span
+            class="pf-v6-c-button__icon pf-m-start"
+          >
+            <svg
+              aria-hidden="true"
+              class="pf-v6-svg"
+              fill="currentColor"
+              height="1em"
+              role="img"
+              viewBox="0 0 352 512"
+              width="1em"
+            >
+              <path
+                d="M242.72 256l100.07-100.07c12.28-12.28 12.28-32.19 0-44.48l-22.24-22.24c-12.28-12.28-32.19-12.28-44.48 0L176 189.28 75.93 89.21c-12.28-12.28-32.19-12.28-44.48 0L9.21 111.45c-12.28 12.28-12.28 32.19 0 44.48L109.28 256 9.21 356.07c-12.28 12.28-12.28 32.19 0 44.48l22.24 22.24c12.28 12.28 32.2 12.28 44.48 0L176 322.72l100.07 100.07c12.28 12.28 32.2 12.28 44.48 0l22.24-22.24c12.28-12.28 12.28-32.19 0-44.48L242.72 256z"
+              />
+            </svg>
+          </span>
+        </button>
+      </div>
+    </div>
+    <button
+      aria-expanded="true"
+      aria-label="Typeahead menu toggle"
+      class="pf-v6-c-menu-toggle__button"
+      data-ouia-component-id="OUIA-Generated-MenuToggle-typeahead-17"
+      data-ouia-component-type="PF6/MenuToggle"
+      data-ouia-safe="true"
+      tabindex="-1"
+      type="button"
+    >
+      <span
+        class="pf-v6-c-menu-toggle__controls"
+      >
+        <span
+          class="pf-v6-c-menu-toggle__toggle-icon"
+        >
+          <svg
+            aria-hidden="true"
+            class="pf-v6-svg"
+            fill="currentColor"
+            height="1em"
+            role="img"
+            viewBox="0 0 320 512"
+            width="1em"
+          >
+            <path
+              d="M31.3 192h257.3c17.8 0 26.7 21.5 14.1 34.1L174.1 354.8c-7.8 7.8-20.5 7.8-28.3 0L17.2 226.1C4.6 213.5 13.5 192 31.3 192z"
+            />
+          </svg>
+        </span>
+      </span>
+    </button>
+  </div>
+</DocumentFragment>
+`;

package/src/components/Select/examples/CheckboxSelectDemo.tsx

@@ -4,7 +4,7 @@ import { CheckboxSelect, CheckboxSelectOption } from '@patternfly/react-template
 export const SelectBasic: React.FunctionComponent = () => {
   const initialOptions: CheckboxSelectOption[] = [
     { content: 'Option 1', value: 'option-1' },
-    { content: 'Option 2', value: 'option-2' },
+    { content: 'Option 2', value: 'option-2', description: 'Option with description' },
     { content: 'Option 3', value: 'option-3', isDisabled: true },
     { content: 'Option 4', value: 'option-4' }
   ];