@indico-data/design-system 2.5.0 → 2.6.0

package/lib/src/components/forms/radio/Radio.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+export interface RadioProps {
+    ref?: React.LegacyRef<HTMLInputElement>;
+    id: string;
+    label: string;
+    name: string;
+    value?: string;
+    onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    isDisabled?: boolean;
+}
+export declare const Radio: ({ ref, id, label, name, value, onChange, isDisabled, ...rest }: RadioProps) => import("react/jsx-runtime").JSX.Element;

package/lib/src/components/forms/radio/Radio.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Radio } from './Radio';
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj<typeof Radio>;
+export declare const Default: Story;

package/lib/src/components/forms/radio/__tests__/Radio.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/components/forms/radio/index.d.ts

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

package/lib/src/components/index.d.ts

@@ -3,3 +3,4 @@ export { Button } from './button';
 export { Icon } from './icons';
 export { Table } from './table';
 export { Input } from './forms/input';
+export { Radio } from './forms/radio';

package/lib/src/index.d.ts

@@ -7,3 +7,5 @@ export { Container, Row, Col } from './components/grid';
 export { Button } from './components/button';
 export { Icon } from './components/icons';
 export { Table } from './components/table';
+export { Input } from './components/forms/input';
+export { Radio as RadioInput } from './components/forms/radio';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indico-data/design-system",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "",
   "author": "",
   "main": "lib/index.js",

package/src/components/forms/radio/Radio.mdx

@@ -0,0 +1,83 @@
+import { Canvas, Meta, Controls } from '@storybook/blocks';
+import * as Radio from './Radio.stories';
+
+<Meta title="Forms/Radio" name="Radio" />
+
+# Radio
+This component is intended to use as part of a group. You would apply multiple radio button components and they share the same ID field to form a group.
+
+<Canvas of={Radio.Default} source={{
+    code: `
+    const radioList = [
+  { id: 'one', label: 'Radio Label One', name: 'radio', value: 'radio' },
+  { id: 'two', label: 'Radio Label Two', name: 'radio', value: 'radio' },
+  { id: 'three', label: 'Radio Label Three', name: 'radio', value: 'radio' },
+];
+ <h2 className="mb-2">Radio Buttons</h2>
+  {radioList.map((radio) => (
+    <Radio
+      key={radio.id}
+      onChange={handleChange}
+      id={radio.id}
+      label={radio.label}
+      name={radio.name}
+      value={radio.value}
+      isDisabled={args.isDisabled}
+    />
+  ))}
+    `,
+  }} />
+<Controls of={Radio.Default} />
+
+## Handling Required State
+The radio component does not have a required state. If you need to enforce a required state. This will be managed in a parent component or wrapper element which handles the state. You will need to verify against a value that matches the ID group for the radio buttons and make sure it is not null.
+
+### Rough code example
+This is a temporary measure until we build our own component to manage this state.
+
+```
+const RadioGroupForm = () => {
+  const [selectedValue, setSelectedValue] = useState('');
+  const [isSubmittedWithoutSelection, setIsSubmittedWithoutSelection] = useState(false);
+
+  const handleSubmit = (e) => {
+    e.preventDefault();
+    if (!selectedValue) {
+      setIsSubmittedWithoutSelection(true);
+    } else {
+      setIsSubmittedWithoutSelection(false);
+      console.log('Form submitted with selected value:', selectedValue);
+    }
+  };
+  
+  const radioList = [
+  { id: 'one', label: 'Radio Label One', name: 'radio', value: 'radio' },
+  { id: 'two', label: 'Radio Label Two', name: 'radio', value: 'radio' },
+  { id: 'three', label: 'Radio Label Three', name: 'radio', value: 'radio' },
+];
+
+  const handleChange = (e) => {
+    setSelectedValue(e.target.value);
+    if (isSubmittedWithoutSelection) {
+      setIsSubmittedWithoutSelection(false);
+    }
+  };
+
+  return (
+    <form onSubmit={handleSubmit}>
+      {radioList.map((radio) => (
+          <Radio
+            key={radio.id}
+            onChange={handleChange}
+            id={radio.id}
+            label={radio.label}
+            name={radio.name}
+            value={radio.value}
+            isDisabled={args.isDisabled}
+          />
+        ))}
+      <button type="submit">Submit</button>
+    </form>
+  );
+};
+```

package/src/components/forms/radio/Radio.stories.tsx

@@ -0,0 +1,121 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Radio, RadioProps } from './Radio';
+import { SetStateAction, useState } from 'react';
+
+const meta: Meta = {
+  title: 'Forms/Radio',
+  component: Radio,
+  argTypes: {
+    ref: {
+      table: {
+        disable: 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 Radio field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    name: {
+      control: 'text',
+      description: 'The name for the Radio field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    value: {
+      control: 'text',
+      description: 'This holds the value that will be emitted when the radio is selected',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: null },
+    },
+    id: {
+      control: 'text',
+      description: 'This explains what button group this radio belongs to.',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'string',
+        },
+      },
+      defaultValue: { summary: '' },
+    },
+    isDisabled: {
+      control: 'boolean',
+      description: 'Toggles the disabled state of the Radio field',
+      table: {
+        category: 'Props',
+        type: {
+          summary: 'boolean',
+        },
+      },
+      defaultValue: { summary: false },
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof Radio>;
+
+const radioList = [
+  { id: 'one', label: 'Radio Label One', name: 'radio', value: 'radio' },
+  { id: 'two', label: 'Radio Label Two', name: 'radio', value: 'radio' },
+  { id: 'three', label: 'Radio Label Three', name: 'radio', value: 'radio' },
+];
+export const Default: Story = {
+  args: {
+    id: 'one',
+    label: 'Radio Label',
+    name: 'radio',
+    value: 'radio',
+    isDisabled: false,
+  },
+  render: (args) => {
+    const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+      console.log(e.target.value);
+    };
+    return (
+      <div>
+        <h2 className="mb-2">Radio Buttons</h2>
+        {radioList.map((radio) => (
+          <Radio
+            key={radio.id}
+            onChange={handleChange}
+            id={radio.id}
+            label={radio.label}
+            name={radio.name}
+            value={radio.value}
+            isDisabled={args.isDisabled}
+          />
+        ))}
+      </div>
+    );
+  },
+};

package/src/components/forms/radio/Radio.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+
+export interface RadioProps {
+  ref?: React.LegacyRef<HTMLInputElement>;
+  id: string;
+  label: string;
+  name: string;
+  value?: string;
+  onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+  isDisabled?: boolean;
+}
+
+export const Radio = ({
+  ref,
+  id,
+  label,
+  name,
+  value,
+  onChange,
+  isDisabled,
+  ...rest
+}: RadioProps) => {
+  return (
+    <div className="form-control">
+      <div className="radio-wrapper">
+        <input
+          data-testid={`form-radio-input-${name}`}
+          {...rest}
+          className="radio-input"
+          type="radio"
+          id={id}
+          name={name}
+          value={value}
+          disabled={isDisabled}
+          ref={ref}
+          onChange={onChange}
+          tabIndex={0}
+          aria-describedby={id}
+          aria-label={label}
+        />
+        <label htmlFor={id} className="radio-input-label" data-testid={`label-radio-input-${name}`}>
+          {label}
+        </label>
+      </div>
+    </div>
+  );
+};

package/src/components/forms/radio/__tests__/Radio.test.tsx

@@ -0,0 +1,35 @@
+import { render, screen, act } from '@testing-library/react';
+import { Radio } from '@/components/forms/radio/Radio';
+import userEvent from '@testing-library/user-event';
+
+const handleOnChange = jest.fn();
+
+describe('radio', () => {
+  it('renders the radio input field', () => {
+    render(
+      <Radio
+        label="Option 1"
+        name="name"
+        ref={undefined}
+        onChange={handleOnChange}
+        id={'ButtonGroup'}
+      />,
+    );
+    expect(screen.getByLabelText('Option 1')).toBeInTheDocument();
+  });
+
+  it('calls the onChange function when the radio input is clicked', async () => {
+    render(
+      <Radio
+        label="Option 1"
+        name="name"
+        ref={undefined}
+        onChange={handleOnChange}
+        id={'ButtonGroup'}
+      />,
+    );
+    expect(handleOnChange).toHaveBeenCalledTimes(0);
+    await userEvent.click(screen.getByLabelText('Option 1'));
+    expect(handleOnChange).toHaveBeenCalledTimes(1);
+  });
+});

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

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

package/src/components/forms/radio/styles/Radio.scss

@@ -0,0 +1,98 @@
+// Common Variables
+:root,
+:root [data-theme='light'],
+:root [data-theme='dark'] {
+  --pf-radio-background-color: var(--pf-white-color);
+  --pf-radio-check-color: var(--pf-primary-color);
+  --pf-radio-border-color: var(--pf-gray-color);
+  --pf-radio-disabled-color: var(--pf-gray-color-400);
+}
+
+// Dark Theme Specific Variables
+:root [data-theme='dark'] {
+  --pf-radio-background-color: transparent;
+  --pf-radio-check-color: var(--pf-white-color);
+  --pf-radio-border-color: var(--pf-white-color);
+  --pf-radio-disabled-color: var(--pf-gray-color-300);
+}
+
+.form-control {
+  .radio-wrapper {
+    display: flex;
+    margin-bottom: var(--pf-margin-2);
+    align-items: center;
+  }
+  .radio-input {
+    margin: 0;
+    margin-right: var(--pf-margin-2);
+    cursor: pointer;
+  }
+  .radio-input-label {
+    cursor: pointer;
+  }
+  [type='radio']:checked,
+  [type='radio']:not(:checked) {
+    position: absolute;
+    left: -9999px;
+  }
+  [type='radio']:checked + label,
+  [type='radio']:not(:checked) + label {
+    position: relative;
+    padding-left: var(--pf-padding-7);
+    cursor: pointer;
+    line-height: 20px;
+    display: inline-block;
+  }
+  [type='radio']:checked + label:before,
+  [type='radio']:not(:checked) + label:before {
+    content: '';
+    position: absolute;
+    left: 0;
+    top: 0;
+    width: 18px;
+    height: 18px;
+    border: 1px solid var(--pf-radio-border-color);
+    border-radius: 100%;
+    background: var(--pf-radio-background-color);
+  }
+  [type='radio']:checked + label:after,
+  [type='radio']:not(:checked) + label:after {
+    content: '';
+    width: 12px;
+    height: 12px;
+    background: var(--pf-radio-check-color);
+    position: absolute;
+    top: 4px;
+    left: 4px;
+    border-radius: 100%;
+    -webkit-transition: all 0.2s ease;
+    transition: all 0.2s ease;
+  }
+  [type='radio']:not(:checked) + label:after {
+    opacity: 0;
+    -webkit-transform: scale(0);
+    transform: scale(0);
+  }
+  [type='radio']:checked + label:after {
+    opacity: 1;
+    -webkit-transform: scale(1);
+    transform: scale(1);
+  }
+  [type='radio']:disabled,
+  [type='radio']:disabled + label {
+    cursor: not-allowed;
+  }
+
+  [type='radio']:disabled + label {
+    color: var(--pf-radio-disabled-color);
+    opacity: 0.5;
+  }
+
+  [type='radio']:disabled + label:before {
+    border-color: var(--pf-radio-disabled-color);
+  }
+
+  [type='radio']:disabled + label:after {
+    background: var(--pf-radio-disabled-color);
+  }
+}

package/src/components/index.ts

@@ -3,3 +3,4 @@ export { Button } from './button';
 export { Icon } from './icons';
 export { Table } from './table';
 export { Input } from './forms/input';
+export { Radio } from './forms/radio';

package/src/index.ts

@@ -61,3 +61,5 @@ export { Container, Row, Col } from './components/grid';
 export { Button } from './components/button';
 export { Icon } from './components/icons';
 export { Table } from './components/table';
+export { Input } from './components/forms/input';
+export { Radio as RadioInput } from './components/forms/radio';

package/src/styles/index.scss

@@ -7,6 +7,7 @@
 @import '../components/grid/styles/Grid.scss';
 @import '../components/table/styles/Table.scss';
 @import '../components/forms/input/styles/Input.scss';
+@import '../components/forms/radio/styles/Radio.scss';
 
 @import 'typography';
 @import 'colors';

package/src/styles/storybook.scss

@@ -0,0 +1,15 @@
+:root [data-theme='light'],
+:root {
+  --storybook-bg-color: var(--pf-white-color);
+  --storybook-font-color: var(--pf-gray-color);
+}
+
+:root [data-theme='dark'] {
+  --storybook-bg-color: var(--pf-primary-color-300);
+  --storybook-font-color: var(--pf-white-color);
+}
+
+.sb__story {
+  background-color: var(--storybook-bg-color);
+  color: var(--storybook-font-color);
+}