Refactor Listbox stories for improved structure #22
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,163 +1,230 @@ | ||
| /* eslint-disable react/jsx-props-no-spreading */ | ||
| import type { Meta, StoryObj } from '@storybook/react-vite' | ||
|
Check failure on line 2 in src/components/form-field/listbox/listbox.stories.tsx
|
||
| import { FC, useState } from 'react' | ||
| import { FormField } from '../form-field' | ||
|
|
||
| type ListboxStoryArgs = { | ||
| label: string | ||
| description: string | ||
| placeholder: string | ||
| width: number | ||
| disabled: boolean | ||
| } | ||
|
|
||
| const meta: Meta<ListboxStoryArgs> = { | ||
| title: 'Input/Listbox', | ||
| args: { | ||
| label: 'Label', | ||
| description: 'Description', | ||
| placeholder: 'Select...', | ||
| width: 288, | ||
| disabled: false, | ||
| }, | ||
| argTypes: { | ||
| label: { control: 'text' }, | ||
| description: { control: 'text' }, | ||
| placeholder: { control: 'text' }, | ||
| width: { control: { type: 'range', min: 200, max: 360, step: 16 } }, | ||
| disabled: { control: 'boolean' }, | ||
| }, | ||
| } | ||
|
Comment on lines
+14
to
+30
There was a problem hiding this comment. The meta configuration is missing the 'component' property. While using custom args for story controls is valid, the meta object should still include a reference to the component being documented. Add |
||
|
|
||
| export default meta | ||
|
|
||
| type Story = StoryObj<ListboxStoryArgs> | ||
|
|
||
| interface Person { | ||
| id: number | ||
| name: string | ||
| isDead?: boolean | ||
| } | ||
|
|
||
| const people: Person[] = [ | ||
| { id: 1, name: 'John Lennon', isDead: true }, | ||
| { id: 2, name: 'Kenton Towne' }, | ||
| { id: 3, name: 'Therese Wunsch' }, | ||
| { id: 4, name: 'Benedict Kessler' }, | ||
| { id: 5, name: 'Katelyn Rohan' }, | ||
| ] | ||
|
|
||
| const ListboxTextWithHooks = ({ | ||
| label, | ||
| description, | ||
| placeholder, | ||
| }: { | ||
| label: string | ||
| description: string | ||
| placeholder: string | ||
| }) => { | ||
| const [selectedPerson, setSelectedPerson] = useState<null | Person>(null) | ||
|
|
||
| return ( | ||
| <FormField> | ||
| <FormField.LabelGroup> | ||
| <FormField.Label htmlFor='value'>{label}</FormField.Label> | ||
| <FormField.Description id='value-description'> | ||
| {description} | ||
| </FormField.Description> | ||
| </FormField.LabelGroup> | ||
| <FormField.Listbox value={selectedPerson} onChange={setSelectedPerson}> | ||
| <FormField.Listbox.Button> | ||
| <FormField.Listbox.Button.TextValue | ||
| value={selectedPerson?.name ?? null} | ||
| placeholder={placeholder} | ||
| /> | ||
| </FormField.Listbox.Button> | ||
| <FormField.Listbox.Options> | ||
| {people.map((person) => ( | ||
| <FormField.Listbox.Option | ||
| value={person} | ||
| key={person.id} | ||
| disabled={person.isDead} | ||
| > | ||
| <FormField.Listbox.Option.TextOption> | ||
| {person.name} | ||
| </FormField.Listbox.Option.TextOption> | ||
| </FormField.Listbox.Option> | ||
| ))} | ||
| </FormField.Listbox.Options> | ||
| </FormField.Listbox> | ||
| </FormField> | ||
| ) | ||
| } | ||
|
|
||
| const ListboxBadgeWithHooks: FC<{ | ||
| disabled?: boolean | ||
| label: string | ||
| description: string | ||
| placeholder: string | ||
| }> = ({ disabled, label, description, placeholder }) => { | ||
| const [selectedPerson, setSelectedPerson] = useState<null | Person>(null) | ||
|
|
||
| return ( | ||
| <FormField> | ||
| <FormField.LabelGroup> | ||
| <FormField.Label htmlFor='value'>{label}</FormField.Label> | ||
| <FormField.Description id='value-description'> | ||
| {description} | ||
| </FormField.Description> | ||
| </FormField.LabelGroup> | ||
|
|
||
| <FormField.Listbox value={selectedPerson} onChange={setSelectedPerson}> | ||
| <FormField.Listbox.Button disabled={disabled}> | ||
| <FormField.Listbox.Button.BadgeValue | ||
| value={selectedPerson?.name ?? null} | ||
| placeholder={placeholder} | ||
| /> | ||
| </FormField.Listbox.Button> | ||
|
|
||
| <FormField.Listbox.Options> | ||
| {people.map((person) => ( | ||
| <FormField.Listbox.Option value={person} key={person.id}> | ||
| <FormField.Listbox.Option.BadgeOption> | ||
| {person.name} | ||
| </FormField.Listbox.Option.BadgeOption> | ||
| </FormField.Listbox.Option> | ||
| ))} | ||
| </FormField.Listbox.Options> | ||
| </FormField.Listbox> | ||
| </FormField> | ||
| ) | ||
| } | ||
|
|
||
| const ListboxMultiWithHooks = ({ | ||
| label, | ||
| description, | ||
| placeholder, | ||
| }: { | ||
| label: string | ||
| description: string | ||
| placeholder: string | ||
| }) => { | ||
| const [selectedPeople, setSelectedPeople] = useState<Person[]>([]) | ||
| const selectedLabels = selectedPeople.map((person) => person.name).join(', ') | ||
|
|
||
| return ( | ||
| <FormField> | ||
| <FormField.LabelGroup> | ||
| <FormField.Label htmlFor='value'>{label}</FormField.Label> | ||
| <FormField.Description id='value-description'> | ||
| {description} | ||
| </FormField.Description> | ||
| </FormField.LabelGroup> | ||
| <FormField.Listbox | ||
| value={selectedPeople} | ||
| onChange={setSelectedPeople} | ||
| multiple | ||
| > | ||
| <FormField.Listbox.Button> | ||
| <FormField.Listbox.Button.TextValue | ||
| value={selectedLabels || null} | ||
| placeholder={placeholder} | ||
| /> | ||
| </FormField.Listbox.Button> | ||
| <FormField.Listbox.Options> | ||
| {people.map((person) => ( | ||
| <FormField.Listbox.Option | ||
| value={person} | ||
| key={person.id} | ||
| disabled={person.isDead} | ||
| > | ||
| <FormField.Listbox.Option.TextOption> | ||
| {person.name} | ||
| </FormField.Listbox.Option.TextOption> | ||
| </FormField.Listbox.Option> | ||
| ))} | ||
| </FormField.Listbox.Options> | ||
| </FormField.Listbox> | ||
| </FormField> | ||
| ) | ||
| } | ||
|
|
||
| export const Default: Story = { | ||
| render: ({ label, description, placeholder, width }) => ( | ||
| <div style={{ width }}> | ||
| <ListboxTextWithHooks | ||
| label={label} | ||
| description={description} | ||
| placeholder={placeholder} | ||
| /> | ||
| </div> | ||
| ), | ||
| } | ||
|
|
||
| export const Badge: Story = { | ||
| render: ({ label, description, placeholder, width, disabled }) => ( | ||
| <div style={{ width }}> | ||
| <ListboxBadgeWithHooks | ||
| label={label} | ||
| description={description} | ||
| placeholder={placeholder} | ||
| disabled={disabled} | ||
| /> | ||
| </div> | ||
| ), | ||
| } | ||
|
|
||
| export const Disabled: Story = { | ||
| render: ({ label, description, placeholder, width }) => ( | ||
| <div style={{ width }}> | ||
| <ListboxBadgeWithHooks | ||
| label={label} | ||
| description={description} | ||
| placeholder={placeholder} | ||
| disabled | ||
| /> | ||
| </div> | ||
| ), | ||
| } | ||
|
|
||
| export const Multiple: Story = { | ||
| render: ({ label, description, placeholder, width }) => ( | ||
| <div style={{ width }}> | ||
| <ListboxMultiWithHooks | ||
| label={label} | ||
| description={description} | ||
| placeholder={placeholder} | ||
| /> | ||
| </div> | ||
| ), | ||
| } | ||
|
Comment on lines
+2
to
+230
There was a problem hiding this comment. The code uses single quotes for string literals, which is inconsistent with the rest of the codebase that predominantly uses double quotes. Update all string literals to use double quotes to maintain consistency with the project's coding style.
Comment on lines
+2
to
+230
There was a problem hiding this comment. The code omits semicolons at the end of statements, which is inconsistent with the rest of the codebase that uses semicolons. Add semicolons to maintain consistency with the project's coding style. |
||
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.
The import should use '@storybook/react' instead of '@storybook/react-vite' to maintain consistency with all other story files in the codebase. All other story files import from '@storybook/react'.