Add Checkbox Component with Storybook Integration and Tests #19
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // | ||
| // This source file is part of the Stanford Biodesign Digital Health Spezi Web Design System open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import { type Meta, type StoryObj } from '@storybook/react' | ||
| import { fn } from '@storybook/test' | ||
| import { useState } from 'react' | ||
| import { SideLabel } from '@/components/SideLabel' | ||
| import { Checkbox } from './Checkbox' | ||
|
|
||
| const meta: Meta<typeof Checkbox> = { | ||
| title: 'Components/Checkbox', | ||
| component: Checkbox, | ||
| args: { | ||
| onCheckedChange: fn(), | ||
| }, | ||
| } | ||
|
|
||
| export default meta | ||
|
|
||
| type Story = StoryObj<typeof Checkbox> | ||
|
|
||
| export const Unchecked: Story = { args: { checked: false } } | ||
|
|
||
| export const Chekced: Story = { args: { checked: true } } | ||
|
|
||
| export const Functional = () => { | ||
| const [checked, setChecked] = useState<boolean | 'indeterminate'>(false) | ||
| return <Checkbox checked={checked} onCheckedChange={setChecked} /> | ||
| } | ||
|
|
||
| export const Labeled = () => ( | ||
| <SideLabel label="Show unread only"> | ||
| <Checkbox checked /> | ||
| </SideLabel> | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,31 @@ | ||||||||
| // | ||||||||
| // This source file is part of the Stanford Biodesign Digital Health Spezi Web Design System open-source project | ||||||||
| // | ||||||||
| // SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||||||||
| // | ||||||||
| // SPDX-License-Identifier: MIT | ||||||||
| // | ||||||||
|
|
||||||||
| import { fireEvent, render, screen } from '@testing-library/react' | ||||||||
| import { vitest } from 'vitest' | ||||||||
| import { Checkbox } from '.' | ||||||||
|
|
||||||||
| describe('Checkbox', () => { | ||||||||
| it('renders functional Checkbox element', () => { | ||||||||
| const onCheckedChange = vitest.fn() | ||||||||
|
|
||||||||
| render( | ||||||||
| <Checkbox | ||||||||
| checked={true} | ||||||||
| onCheckedChange={onCheckedChange} | ||||||||
| aria-label="Checkbox" | ||||||||
| />, | ||||||||
| ) | ||||||||
|
|
||||||||
| const element = screen.getByLabelText('Checkbox') | ||||||||
| fireEvent.click(element) | ||||||||
|
|
||||||||
| const newCheckedValue = false | ||||||||
| expect(onCheckedChange).toHaveBeenCalledWith(newCheckedValue) | ||||||||
|
Comment on lines
+28
to
+29
There was a problem hiding this comment. It seems like
Suggested change
|
||||||||
| }) | ||||||||
| }) | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // | ||
| // This source file is part of the Stanford Biodesign Digital Health Spezi Web Design System open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import * as CheckboxPrimitives from '@radix-ui/react-checkbox' | ||
| import { | ||
| type ComponentPropsWithoutRef, | ||
| type ElementRef, | ||
| forwardRef, | ||
| } from 'react' | ||
| import { cn } from '../../utils/className' | ||
| import { CheckIcon } from 'lucide-react' | ||
|
|
||
| export const Checkbox = forwardRef< | ||
|
There was a problem hiding this comment. It needs |
||
| ElementRef<typeof CheckboxPrimitives.Root>, | ||
| ComponentPropsWithoutRef<typeof CheckboxPrimitives.Root> | ||
| >(({ className, ...props }, ref) => ( | ||
| <CheckboxPrimitives.Root | ||
| className={cn( | ||
| 'hover:bg-violet3 flex size-[25px] appearance-none items-center justify-center rounded bg-white shadow-[0_0_0_2px_black] outline-none', | ||
|
There was a problem hiding this comment. I have not run this yet, but it seems like we need a bit more work here. Components have to rely on the standard Tailwind's design tokens and design system custom color tokens. This enables consumers to modify the theme. Focus states have to be properly handled. |
||
| className, | ||
| )} | ||
| {...props} | ||
| ref={ref} | ||
| > | ||
| <CheckboxPrimitives.Indicator> | ||
| <CheckIcon /> | ||
| </CheckboxPrimitives.Indicator> | ||
| </CheckboxPrimitives.Root> | ||
| )) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| // | ||
| // This source file is part of the Stanford Biodesign Digital Health Spezi Web Design System open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| export * from './Checkbox' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
./components/Checkboxneeds to be added here. It enables consumers of the package to importCheckboxdirectly: