@indico-data/design-system 2.7.0 → 2.9.0

package/src/components/forms/textarea/Textarea.stories.tsx

@@ -0,0 +1,363 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Textarea, TextareaProps } from './Textarea';
+import { SetStateAction, useEffect, useState } from 'react';
+
+const meta: Meta = {
+  title: 'Forms/Textarea',
+  component: Textarea,
+  argTypes: {
+    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 textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    name: {
+      control: 'text',
+      description: 'The name for the textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    placeholder: {
+      control: 'text',
+      description: 'The placeholder for the textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    value: {
+      control: 'text',
+      description: 'The value for the textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    isRequired: {
+      control: 'boolean',
+      description: 'Toggles the required astherisc on the label',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    isDisabled: {
+      control: 'boolean',
+      description: 'Toggles the disabled state of the textarea field',
+      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 textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    hasHiddenLabel: {
+      control: 'boolean',
+      description: 'Hides the label visually (retains it for screen readers)',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    autofocus: {
+      control: 'boolean',
+      description: '	Specifies that a text area should automatically get focus when the page loads',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    rows: {
+      control: 'number',
+      description: 'The number of rows for the textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'number',
+        },
+      },
+      defaultValue: { summary: undefined },
+    },
+    cols: {
+      control: 'number',
+      description: 'Specifies the visible width of a text area',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'number',
+        },
+      },
+      defaultValue: { summary: undefined },
+    },
+    readonly: {
+      control: 'boolean',
+      description: 'Sets the textarea field to readonly',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: 'false' },
+    },
+    wrap: {
+      control: 'text',
+      description: 'Sets the wrap attribute for the textarea field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: 'soft' },
+    },
+    form: {
+      control: 'text',
+      description: 'Specifies which form the text area belongs to',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    maxLength: {
+      control: 'number',
+      description: 'Specifies the maximum number of characters allowed in the text area',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'number',
+        },
+      },
+      defaultValue: { summary: undefined },
+    },
+    ref: {
+      table: {
+        disable: true,
+      },
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof Textarea>;
+
+export const Default: Story = {
+  args: {
+    isRequired: true,
+    helpText: 'This Is Help Text',
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    hasHiddenLabel: false,
+    isDisabled: false,
+    errorList: [],
+    value: '',
+    readonly: false,
+    cols: 0,
+    rows: 0,
+    wrap: 'soft',
+    form: '',
+    maxLength: 200,
+    autofocus: false,
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const Errors: Story = {
+  args: {
+    isRequired: true,
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    hasHiddenLabel: false,
+    isDisabled: false,
+    errorList: ['This Is An Error', 'This Is Another Error'],
+    value: '',
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const HiddenLabel: Story = {
+  args: {
+    isRequired: true,
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    hasHiddenLabel: true,
+    isDisabled: false,
+    value: '',
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const HelpText: Story = {
+  args: {
+    helpText: 'This Is Help Text',
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    isDisabled: false,
+    value: '',
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const Disabled: Story = {
+  args: {
+    helpText: 'This Is Help Text',
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    isDisabled: true,
+    value: '',
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};
+
+export const Readonly: Story = {
+  args: {
+    helpText: 'This Is Help Text',
+    label: 'Label Name',
+    name: 'textarea',
+    placeholder: 'Please enter a value',
+    value: '',
+    readonly: true,
+  },
+  render: (args) => {
+    const [value, setValue] = useState(args.value);
+
+    useEffect(() => {
+      setValue(args.value);
+    }, [args.value]);
+
+    const handleChange = (e: { target: { value: SetStateAction<string> } }) => {
+      setValue(e.target.value);
+    };
+
+    return <Textarea {...args} value={value} onChange={handleChange} />;
+  },
+};

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

@@ -0,0 +1,85 @@
+import React from 'react';
+import { Label } from '../subcomponents/Label';
+import { ErrorList } from '../subcomponents/ErrorList';
+
+export interface TextareaProps {
+  ref?: React.LegacyRef<HTMLTextAreaElement>;
+  label: string;
+  name: string;
+  placeholder: string;
+  value: string;
+  onChange: (e: React.ChangeEvent<HTMLTextAreaElement>) => void;
+  isRequired?: boolean;
+  isDisabled?: boolean;
+  errorList?: string[];
+  helpText?: string;
+  hasHiddenLabel?: boolean;
+  rows?: number;
+  cols?: number;
+  readonly?: boolean;
+  wrap?: 'hard' | 'soft';
+  form?: string;
+  maxLength?: number;
+  autofocus?: boolean;
+}
+
+export const Textarea = ({
+  ref,
+  label,
+  name,
+  placeholder,
+  value,
+  onChange,
+  isRequired,
+  isDisabled,
+  errorList,
+  helpText,
+  hasHiddenLabel,
+  rows,
+  cols,
+  readonly,
+  wrap,
+  form,
+  maxLength,
+  autofocus,
+  ...rest
+}: TextareaProps) => {
+  const hasErrors = errorList && errorList.length > 0;
+
+  return (
+    <div className="form-control">
+      <Label label={label} name={name} isRequired={isRequired} hasHiddenLabel={hasHiddenLabel} />
+      <div className="textarea-wrapper">
+        <textarea
+          ref={ref}
+          rows={rows}
+          cols={cols}
+          autoFocus={autofocus}
+          wrap={wrap}
+          form={form}
+          value={value}
+          maxLength={maxLength}
+          readOnly={readonly}
+          data-testid={`form-textarea-${name}`}
+          name={name}
+          disabled={isDisabled}
+          required={isRequired}
+          placeholder={placeholder}
+          onChange={onChange}
+          className={`textarea ${hasErrors ? 'error' : ''}`}
+          aria-invalid={hasErrors}
+          aria-describedby={hasErrors || helpText ? `${name}-helper` : undefined}
+          aria-required={isRequired}
+          aria-label={label}
+          {...rest}
+        />
+      </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/textarea/__tests__/Textarea.test.tsx

@@ -0,0 +1,103 @@
+import { render, screen, act } from '@testing-library/react';
+import { Textarea } from '@/components/forms/textarea/Textarea';
+import { ChangeEvent } from 'react';
+import userEvent from '@testing-library/user-event';
+
+const handleOnChange = jest.fn();
+
+describe('Textarea', () => {
+  it('renders the input field', () => {
+    render(
+      <Textarea
+        isRequired={true}
+        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('adds the error class when errors exist', () => {
+    render(
+      <Textarea
+        isRequired={true}
+        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 textareaElement = screen.getByTestId('form-textarea-name');
+    expect(textareaElement).toHaveClass('error');
+  });
+  it('does not highlight the Textarea when no errors exist', () => {
+    render(
+      <Textarea
+        isRequired={true}
+        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 textareaElement = screen.getByTestId('form-textarea-name');
+    expect(textareaElement).not.toHaveClass('error');
+  });
+  it('renders help text when help text exists', () => {
+    render(
+      <Textarea
+        isRequired={true}
+        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(
+      <Textarea
+        isRequired={true}
+        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(
+      <Textarea
+        isRequired={true}
+        label="Enter your name"
+        name="name"
+        placeholder="Please enter a value"
+        value={''}
+        onChange={handleOnChange}
+      />,
+    );
+    const textareaElement = screen.getByTestId('form-textarea-name');
+    await userEvent.type(textareaElement, 't');
+    expect(handleOnChange).toHaveBeenCalled();
+  });
+});

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

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

package/src/components/forms/textarea/styles/Textarea.scss

@@ -0,0 +1,102 @@
+// Common Variables
+:root,
+:root [data-theme='light'],
+:root [data-theme='dark'] {
+  // Typography
+  --pf-textarea-background-color: var(--pf-white-color);
+  --pf-textarea-border-color: var(--pf-gray-color);
+  --pf-textarea-text-color: var(--pf-gray-color);
+  --pf-textarea-placeholder-text-color: var(--pf-gray-color-300);
+  --pf-textarea-help-text-color: var(--pf-gray-color-400);
+  --pf-textarea-disabled-background-color: var(--pf-gray-color-100);
+  --pf-textarea-border-color: var(--pf-gray-color);
+  --pf-textarea-disabled-color: var(--pf-gray-color-400);
+
+  // textarea Radius
+  --pf-textarea-rounded: var(--pf-rounded);
+}
+
+// Dark Theme Specific Variables
+:root [data-theme='dark'] {
+  --pf-textarea-background-color: var(--pf-primary-color);
+  --pf-textarea-border-color: var(--pf-gray-color-100);
+  --pf-textarea-text-color: var(--pf-gray-color-100);
+  --pf-textarea-placeholder-text-color: var(--pf-gray-color);
+  --pf-textarea-help-text-color: var(--pf-gray-color-200);
+  --pf-textarea-disabled-background-color: var(--pf-primary-color-200);
+  --pf-textarea-disabled-border-color: var(--pf-gray-color-300);
+  --pf-textarea-disabled-color: var(--pf-gray-color-400);
+}
+
+.textarea {
+  background-color: var(--pf-textarea-background-color);
+  border: 1px solid var(--pf-textarea-border-color);
+  border-radius: var(--pf-textarea-rounded);
+  color: var(--pf-textarea-text-color);
+  padding: 10px;
+  width: 100%;
+  box-sizing: border-box;
+  &::placeholder {
+    color: var(--pf-textarea-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-textarea-disabled-background-color);
+    border-color: var(--pf-textarea-disabled-border-color);
+    color: var(--pf-textarea-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-textarea-help-text-color);
+    font-size: var(--pf-font-size-subtitle2);
+  }
+  .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/toggle/Toggle.mdx

@@ -0,0 +1,15 @@
+import { Canvas, Meta, Controls } from '@storybook/blocks';
+import * as Toggle from './Toggle.stories';
+
+<Meta title="Forms/Toggle" name="Toggle" />
+
+# Toggle
+
+Under the hood, Toggle component works the same as a regular Checkbox. Through CSS, we style the checkbox to resemble an on/off switch. 
+
+<Canvas of={Toggle.Default} source={{
+  }} />
+<Controls of={Toggle.Default} />
+
+## Note
+Because of storybook limitations, the "isChecked" prop is not working in the storybook. In addition, neither is the on click. Please refer to the [default](http://localhost:6006/?path=/story/forms-toggle--default) example on the forms section.