From af575907c254d3233c3fd5904afc87c1db0bdcf3 Mon Sep 17 00:00:00 2001
From: Armand Philippot <git@armandphilippot.com>
Date: Sat, 9 Apr 2022 19:14:03 +0200
Subject: chore: add a Checkbox component

---
 src/components/atoms/forms/checkbox.stories.tsx | 96 +++++++++++++++++++++++++
 src/components/atoms/forms/checkbox.test.tsx    | 28 ++++++++
 src/components/atoms/forms/checkbox.tsx         | 46 ++++++++++++
 3 files changed, 170 insertions(+)
 create mode 100644 src/components/atoms/forms/checkbox.stories.tsx
 create mode 100644 src/components/atoms/forms/checkbox.test.tsx
 create mode 100644 src/components/atoms/forms/checkbox.tsx

(limited to 'src')

diff --git a/src/components/atoms/forms/checkbox.stories.tsx b/src/components/atoms/forms/checkbox.stories.tsx
new file mode 100644
index 0000000..7faf343
--- /dev/null
+++ b/src/components/atoms/forms/checkbox.stories.tsx
@@ -0,0 +1,96 @@
+import { ComponentMeta, ComponentStory } from '@storybook/react';
+import { useState } from 'react';
+import CheckboxComponent from './checkbox';
+
+export default {
+  title: 'Atoms/Forms',
+  component: CheckboxComponent,
+  argTypes: {
+    'aria-labelledby': {
+      control: {
+        type: 'text',
+      },
+      description: 'One or more ids that refers to the checkbox name.',
+      table: {
+        category: 'Accessibility',
+      },
+      type: {
+        name: 'string',
+        required: false,
+      },
+    },
+    className: {
+      control: {
+        type: 'text',
+      },
+      description: 'Set additional classnames to the checkbox.',
+      table: {
+        category: 'Styles',
+      },
+      type: {
+        name: 'string',
+        required: false,
+      },
+    },
+    id: {
+      control: {
+        type: 'text',
+      },
+      description: 'The checkbox id.',
+      type: {
+        name: 'string',
+        required: true,
+      },
+    },
+    name: {
+      control: {
+        type: 'text',
+      },
+      description: 'The checkbox name.',
+      type: {
+        name: 'string',
+        required: true,
+      },
+    },
+    setValue: {
+      control: {
+        type: null,
+      },
+      description: 'A callback function to handle checkbox state.',
+      type: {
+        name: 'function',
+        required: true,
+      },
+    },
+    value: {
+      control: {
+        type: null,
+      },
+      description:
+        'The checkbox state: either checked (true) or unchecked (false).',
+      type: {
+        name: 'boolean',
+        required: true,
+      },
+    },
+  },
+} as ComponentMeta<typeof CheckboxComponent>;
+
+const Template: ComponentStory<typeof CheckboxComponent> = ({
+  value,
+  setValue: _setValue,
+  ...args
+}) => {
+  const [isChecked, setIsChecked] = useState<boolean>(value);
+
+  return (
+    <CheckboxComponent value={isChecked} setValue={setIsChecked} {...args} />
+  );
+};
+
+export const Checkbox = Template.bind({});
+Checkbox.args = {
+  id: 'storybook-checkbox',
+  name: 'storybook-checkbox',
+  value: false,
+};
diff --git a/src/components/atoms/forms/checkbox.test.tsx b/src/components/atoms/forms/checkbox.test.tsx
new file mode 100644
index 0000000..3b54549
--- /dev/null
+++ b/src/components/atoms/forms/checkbox.test.tsx
@@ -0,0 +1,28 @@
+import { render, screen } from '@test-utils';
+import Checkbox from './checkbox';
+
+describe('Checkbox', () => {
+  it('renders an unchecked checkbox', () => {
+    render(
+      <Checkbox
+        id="jest-checkbox"
+        name="jest-checkbox"
+        value={false}
+        setValue={() => null}
+      />
+    );
+    expect(screen.getByRole('checkbox')).not.toBeChecked();
+  });
+
+  it('renders a checked checkbox', () => {
+    render(
+      <Checkbox
+        id="jest-checkbox"
+        name="jest-checkbox"
+        value={true}
+        setValue={() => null}
+      />
+    );
+    expect(screen.getByRole('checkbox')).toBeChecked();
+  });
+});
diff --git a/src/components/atoms/forms/checkbox.tsx b/src/components/atoms/forms/checkbox.tsx
new file mode 100644
index 0000000..8babcc8
--- /dev/null
+++ b/src/components/atoms/forms/checkbox.tsx
@@ -0,0 +1,46 @@
+import { SetStateAction, VFC } from 'react';
+
+export type CheckboxProps = {
+  /**
+   * One or more ids that refers to the checkbox name.
+   */
+  'aria-labelledby'?: string;
+  /**
+   * Add classnames to the checkbox.
+   */
+  className?: string;
+  /**
+   * Checkbox id attribute.
+   */
+  id: string;
+  /**
+   * Checkbox name attribute.
+   */
+  name: string;
+  /**
+   * Callback function to set checkbox value.
+   */
+  setValue: (value: SetStateAction<boolean>) => void;
+  /**
+   * Checkbox value.
+   */
+  value: boolean;
+};
+
+/**
+ * Checkbox component
+ *
+ * Render a checkbox type input.
+ */
+const Checkbox: VFC<CheckboxProps> = ({ value, setValue, ...props }) => {
+  return (
+    <input
+      type="checkbox"
+      checked={value}
+      onChange={() => setValue(!value)}
+      {...props}
+    />
+  );
+};
+
+export default Checkbox;
-- 
cgit v1.2.3