[UI v2] Setup Storybook #16003
Merged
[UI v2] Setup Storybook #16003
Conversation
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
evan-liu
requested review from
aaazzam,
cicdw,
desertaxle and
zzstoatzz
as code owners
evan-liu
force-pushed
the
ui-v2-storybook
branch
from
65bac82
to
c93f420
Compare
desertaxle
reviewed
Nov 14, 2024
Comment on lines
+43
to
+66
| export const TestAddRemove: Story = { | ||
| name: "Test: Add and remove", | ||
| play: async ({ canvasElement, step }) => { | ||
| const canvas = within(canvasElement); | ||
| const tagsInput: HTMLInputElement = canvas.getByRole("textbox"); | ||
|
|
||
| await step("Add testTag", async () => { | ||
| await userEvent.type(tagsInput, "testTag"); | ||
| await expect(tagsInput.value).toBe("testTag"); | ||
| await userEvent.type(tagsInput, "{enter}"); | ||
| await expect(tagsInput.value).toBe(""); | ||
| await expect(canvas.queryByText("testTag")).not.toBeNull(); | ||
| }); | ||
|
|
||
| await step("Add testTag2", async () => { | ||
| await userEvent.type(tagsInput, "testTag2{enter}"); | ||
| }); | ||
|
|
||
| await step("Delete testTag", async () => { | ||
| await userEvent.click(canvas.getAllByRole("button")[0]); | ||
| await expect(canvas.queryByText("testTag")).toBeNull(); | ||
| }); | ||
| }, | ||
| }; |
There was a problem hiding this comment.
This is neat! I haven't seen tests written with Storybook before. Does this have any advantages over our current vitest + testing-library setup?
There was a problem hiding this comment.
I didn't set up the test runner for it on CI (I can add it to this PR or another PR if you're interested), so it is more for development than testing.
- The play function further reduces the feedback loop on local-dev
- The time travel feature helps with debugging
Please see the live version here.
There was a problem hiding this comment.
As the Storybook test also uses vitest + testing-library, here’s one potential workflow without a test runner for the Storybook tests:
- Use the Storybook play function to facilitate local development.
- Once development is completed, copy the Storybook test into the test suite.
- Clean up the Storybook stories and tests, keep only the stories/tests for documentation purposes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #15998
Checklist
<link to issue>"mint.json.