@indico-data/design-system 2.8.0 → 2.10.0

package/src/components/forms/passwordInput/PasswordInput.stories.tsx

@@ -0,0 +1,269 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { PasswordInput, PasswordInputProps } from './PasswordInput';
+import { SetStateAction, useEffect, useState } from 'react';
+import { iconNames } from 'build/generated/iconTypes';
+
+const meta: Meta = {
+  title: 'Forms/PasswordInput',
+  component: PasswordInput,
+  argTypes: {
+    hasShowPassword: {
+      control: 'boolean',
+      description: 'Toggles the visibility of the password',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: true },
+    },
+    onChange: {
+      control: false,
+      description: 'onChange event handler',
+      table: {
+        category: 'Callbacks',
+        type: {
+          summary: '(e: React.ChangeEvent<HTMLInputElement>) => void',
+        },
+      },
+      action: 'onChange',
+    },
+    label: {
+      control: 'text',
+      description: 'The label for the password field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+    },
+    name: {
+      control: 'text',
+      description: 'The name for the password field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+    },
+    placeholder: {
+      control: 'text',
+      description: 'The placeholder for the password field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+    },
+    value: {
+      control: 'text',
+      description: 'The value for the password field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+    },
+    isRequired: {
+      control: 'boolean',
+      description: 'Toggles the required astherisk on the label',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    isDisabled: {
+      control: 'boolean',
+      description: 'Toggles the disabled state of the input',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    errorList: {
+      control: false,
+      description: 'An array of error messages',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string[]',
+        },
+      },
+      defaultValue: { summary: '[]' },
+    },
+    helpText: {
+      control: 'text',
+      description: 'The help text for the password field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+    },
+    hasHiddenLabel: {
+      control: 'boolean',
+      description: 'Hides the label visually (retains it for screen readers)',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    ref: {
+      table: {
+        disable: true,
+      },
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof PasswordInput>;
+
+const defaultArgs = {
+  label: 'Enter your name',
+  name: 'first_name',
+  placeholder: 'Please enter a value',
+} as PasswordInputProps;
+
+export const Default: Story = {
+  args: {
+    isRequired: false,
+    helpText: 'This Is Help Text',
+    label: 'Label Name',
+    name: 'first_name',
+    placeholder: 'Please enter a value',
+    hasHiddenLabel: false,
+    hasShowPassword: true,
+    isDisabled: false,
+    errorList: [],
+    value: '',
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const Errors: Story = {
+  args: {
+    ...defaultArgs,
+    errorList: ['You require a password value.'],
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const HiddenLabel: Story = {
+  args: {
+    ...defaultArgs,
+    hasHiddenLabel: true,
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const HelpText: Story = {
+  args: {
+    ...defaultArgs,
+    helpText: 'In order to submit the form, this field is required.',
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const Required: Story = {
+  args: {
+    ...defaultArgs,
+    isRequired: true,
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const NoTogglePasswordVisibility: Story = {
+  args: {
+    ...defaultArgs,
+    hasShowPassword: false,
+  },
+  render: (args) => {
+    const [value, setValue] = useState('');
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <PasswordInput {...args} value={value} onChange={handleChange} />;
+  },
+};

package/src/components/forms/passwordInput/PasswordInput.tsx

@@ -0,0 +1,82 @@
+import React, { useState } from 'react';
+import { Icon } from '@/components/icons';
+import { Label } from '../subcomponents/Label';
+import { ErrorList } from '../subcomponents/ErrorList';
+
+export interface PasswordInputProps {
+  ref?: React.LegacyRef<HTMLInputElement>;
+  label: string;
+  name: string;
+  placeholder: string;
+  value: string;
+  onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+  isRequired?: boolean;
+  isDisabled?: boolean;
+  errorList?: string[];
+  helpText?: string;
+  hasHiddenLabel?: boolean;
+  hasShowPassword?: boolean;
+}
+
+export const PasswordInput = ({
+  label,
+  name,
+  placeholder,
+  value,
+  onChange,
+  isRequired,
+  isDisabled,
+  errorList,
+  helpText,
+  hasHiddenLabel,
+  hasShowPassword = true,
+  ...rest
+}: PasswordInputProps) => {
+  const hasErrors = errorList && errorList.length > 0;
+
+  const [showPassword, setShowPassword] = useState(false);
+
+  const handleShowPassword = () => {
+    setShowPassword((prevShowPassword) => !prevShowPassword);
+  };
+
+  return (
+    <div className="form-control">
+      <Label label={label} name={name} isRequired={isRequired} hasHiddenLabel={hasHiddenLabel} />
+      <div className="password-input-wrapper">
+        <Icon name="lock" data-testid={`${name}-embedded-icon`} className="embedded-icon" />
+        <input
+          data-testid={`form-password-input-${name}`}
+          name={name}
+          type={showPassword ? 'text' : 'password'}
+          disabled={isDisabled}
+          required={isRequired}
+          placeholder={placeholder}
+          value={value}
+          onChange={onChange}
+          className={`password-input ${hasErrors ? 'error' : ''} password-input--has-icon`}
+          aria-invalid={hasErrors}
+          aria-describedby={hasErrors || helpText ? `${name}-helper` : undefined}
+          aria-required={isRequired}
+          aria-label={label}
+          {...rest}
+        />
+        {hasShowPassword && (
+          <Icon
+            name={showPassword ? 'fa-eye-slash' : 'eye'}
+            data-testid={`${name}-${showPassword ? 'hide' : 'show'}-password-icon`}
+            size="md"
+            onClick={handleShowPassword}
+            className="toggle-show-password-icon"
+          />
+        )}
+      </div>
+      {hasErrors && <ErrorList errorList={errorList} name={name} />}
+      {helpText && (
+        <div data-testid={`${name}-help-text`} className="help-text" id={`${name}-helper`}>
+          {helpText}
+        </div>
+      )}
+    </div>
+  );
+};

package/src/components/forms/passwordInput/__tests__/PasswordInput.test.tsx

@@ -0,0 +1,129 @@
+import { render, screen, act } from '@testing-library/react';
+import { PasswordInput } from '@/components/forms/passwordInput/PasswordInput';
+import { ChangeEvent } from 'react';
+import userEvent from '@testing-library/user-event';
+
+const handleOnChange = jest.fn();
+const handleShowPassword = jest.fn();
+
+describe('Input', () => {
+  it('renders the input field', () => {
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        helpText="In order to submit the form, this field is required."
+        name="name"
+        placeholder="Please enter a value"
+        value={''}
+        onChange={handleOnChange}
+      />,
+    );
+    expect(screen.getByText('Enter your name')).toBeInTheDocument();
+  });
+
+  it('clicking on the eye changes the password input to a text input and back and changes the icon from a show icon to hide icon and back', async () => {
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        helpText="In order to submit the form, this field is required."
+        name="name"
+        placeholder="Please enter a value"
+        value={'test'}
+        onChange={handleOnChange}
+      />,
+    );
+    const input = screen.getByTestId('form-password-input-name');
+    const showPasswordIcon = screen.getByTestId('name-show-password-icon');
+    expect(input).toHaveValue('test');
+    await userEvent.click(showPasswordIcon);
+    expect(input).toHaveAttribute('type', 'text');
+    const hidePasswordIcon = screen.getByTestId('name-hide-password-icon');
+    await userEvent.click(hidePasswordIcon);
+    expect(input).toHaveAttribute('type', 'password');
+  });
+
+  it('adds the error class when errors exist', () => {
+    render(
+      <PasswordInput
+        isRequired
+        errorList={['You require a username value.']}
+        label="Enter your name"
+        helpText="In order to submit the form, this field is required."
+        name="name"
+        placeholder="Please enter a value"
+        value={'test'}
+        onChange={handleOnChange}
+      />,
+    );
+    const input = screen.getByTestId('form-password-input-name');
+    expect(input).toHaveClass('error');
+  });
+
+  it('does not highlight the input when no errors exist', () => {
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        helpText="In order to submit the form, this field is required."
+        name="name"
+        placeholder="Please enter a value"
+        value={'test'}
+        onChange={handleOnChange}
+      />,
+    );
+    const input = screen.getByTestId('form-password-input-name');
+    expect(input).not.toHaveClass('error');
+  });
+
+  it('renders help text when help text exists', () => {
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        helpText="In order to submit the form, this field is required."
+        name="name"
+        placeholder="Please enter a value"
+        value={'test'}
+        onChange={handleOnChange}
+      />,
+    );
+    const helpText = screen.getByText('In order to submit the form, this field is required.');
+    expect(helpText).toBeInTheDocument();
+    expect(helpText).toBeVisible();
+  });
+
+  it('does not render help text when help text does not exist', () => {
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        name="name"
+        placeholder="Please enter a value"
+        value={'test'}
+        onChange={handleOnChange}
+      />,
+    );
+    const helpText = screen.queryByTestId('name-help-text');
+    expect(helpText).not.toBeInTheDocument();
+    expect(helpText).toBeNull();
+  });
+
+  it('emits the value when user types', async () => {
+    const handleOnChange = jest.fn();
+    render(
+      <PasswordInput
+        isRequired
+        label="Enter your name"
+        name="name"
+        placeholder="Please enter a value"
+        value={''}
+        onChange={handleOnChange}
+      />,
+    );
+    const input = screen.getByTestId('form-password-input-name');
+    await userEvent.type(input, 't');
+    expect(handleOnChange).toHaveBeenCalled();
+  });
+});

package/src/components/forms/passwordInput/index.ts

@@ -0,0 +1 @@
+export { PasswordInput } from './PasswordInput';

package/src/components/forms/passwordInput/styles/PasswordInput.scss

@@ -0,0 +1,120 @@
+// Common Variables
+:root,
+:root [data-theme='light'],
+:root [data-theme='dark'] {
+  // Typography
+  --pf-password-input-background-color: var(--pf-white-color);
+  --pf-password-input-border-color: var(--pf-gray-color);
+  --pf-password-input-text-color: var(--pf-gray-color);
+  --pf-password-input-placeholder-text-color: var(--pf-gray-color-300);
+  --pf-password-input-help-text-color: var(--pf-gray-color-400);
+  --pf-password-input-disabled-background-color: var(--pf-gray-color-100);
+  --pf-password-input-border-color: var(--pf-gray-color);
+  --pf-password-input-disabled-color: var(--pf-gray-color-400);
+  --pf-password-input-border-color: var(--pf-gray-color);
+
+  // input Radius
+  --pf-password-input-rounded: var(--pf-rounded);
+}
+
+// Dark Theme Specific Variables
+:root [data-theme='dark'] {
+  --pf-password-input-background-color: var(--pf-primary-color);
+  --pf-password-input-border-color: var(--pf-gray-color-100);
+  --pf-password-input-text-color: var(--pf-gray-color-100);
+  --pf-password-input-placeholder-text-color: var(--pf-gray-color);
+  --pf-password-input-help-text-color: var(--pf-gray-color-200);
+  --pf-password-input-disabled-background-color: var(--pf-primary-color-200);
+  --pf-password-input-disabled-border-color: var(--pf-gray-color-300);
+  --pf-password-input-disabled-color: var(--pf-gray-color-400);
+}
+
+.password-input {
+  background-color: var(--pf-password-input-background-color);
+  border: 1px solid var(--pf-password-input-border-color);
+  border-radius: var(--pf-password-input-rounded);
+  color: var(--pf-password-input-text-color);
+  padding: 10px;
+  width: 100%;
+  box-sizing: border-box;
+  height: 36px;
+  &::placeholder {
+    color: var(--pf-password-input-placeholder-text-color);
+  }
+
+  &:focus {
+    border-color: var(--pf-primary-color);
+  }
+
+  &.error {
+    border-color: var(--pf-error-color);
+  }
+
+  &.success {
+    border-color: var(--pf-success-color);
+  }
+
+  &.warning {
+    border-color: var(--pf-warning-color);
+  }
+
+  &.info {
+    border-color: var(--pf-info-color);
+  }
+
+  &:disabled {
+    background-color: var(--pf-password-input-disabled-background-color);
+    border-color: var(--pf-password-input-disabled-border-color);
+    color: var(--pf-password-input-disabled-color);
+  }
+  &--has-icon {
+    padding-left: var(--pf-padding-7);
+  }
+}
+
+.form-control {
+  .error-list {
+    list-style: none;
+    padding: 0;
+    margin: 0;
+    margin-top: var(--pf-margin-2);
+    margin-bottom: var(--pf-margin-2);
+    color: var(--pf-error-color);
+  }
+  .help-text {
+    margin-top: var(--pf-margin-2);
+    margin-bottom: var(--pf-margin-2);
+    color: var(--pf-password-input-help-text-color);
+    font-size: var(--pf-font-size-subtitle2);
+  }
+  .password-input-wrapper {
+    position: relative;
+    .embedded-icon {
+      position: absolute;
+      top: 10px;
+      left: var(--pf-margin-2);
+      color: var(--pf-password-input-text-color);
+    }
+    .toggle-show-password-icon {
+      position: absolute;
+      top: var(--pf-margin-3);
+      right: var(--pf-margin-2);
+      color: var(--pf-password-input-text-color);
+      cursor: pointer;
+    }
+  }
+  .is-visually-hidden {
+    position: absolute;
+    width: 1px;
+    height: 1px;
+    padding: 0;
+    margin: -1px;
+    overflow: hidden;
+    clip: rect(0, 0, 0, 0);
+    white-space: nowrap;
+    border: 0;
+  }
+  .form-label {
+    margin-bottom: var(--pf-margin-2);
+  }
+}

package/src/components/forms/textarea/Textarea.mdx

@@ -0,0 +1,19 @@
+import { Canvas, Meta, Controls } from '@storybook/blocks';
+import * as Textarea from './Textarea.stories';
+
+<Meta title="Forms/Textarea" name="Textarea" />
+
+# Textarea
+
+The Textarea component is the building block of any form. Below you will find the accepted properties for this component. It is encouraged to build forms utilizing [React Hook Form](https://react-hook-form.com/) library in your application. This will facilitate form state management and enforce best practices. (***Our components are compatible with but do not provide the plugin***)
+
+<Canvas
+  of={Textarea.Default}
+  source={{
+    code: `
+    <Textarea name="first_name" isRequired helpText="This Is Help Text" placeholder="This is a placeholder" value="''" onChange={handleChange} label="Label Name"  />
+    `,
+  }}
+/>
+
+<Controls of={Textarea.Default} />