-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #333 from chromaui/update-ia-for-3.0
Create workflow section
- Loading branch information
Showing
16 changed files
with
233 additions
and
182 deletions.
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
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
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 was deleted.
Oops, something went wrong.
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,63 @@ | ||
--- | ||
layout: "../../layouts/Layout.astro" | ||
title: In development | ||
description: How Chromatic helps teams develop applications | ||
sidebar: { order: 1 } | ||
--- | ||
|
||
# In development workflow | ||
|
||
Chromatic automates UI development so you can build features faster, with less manual work. Follow along with our recommended workflow to see how it fits into your development process. | ||
|
||
### Develop UIs with Storybook | ||
|
||
Chromatic automatically turns stories into tests. So the more coverage of your UI with stories, the more time you'll save your team with our automation. | ||
|
||
If you're just getting started with Storybook, we recommend you incrementally adopt Storybook to help develop discrete parts of your UI and then expand usage from there. For example, start by using Storybook to develop a new feature. This gives you the chance to write your first stories and see how it fits into your workflow. | ||
|
||
![Develop with Storybook](../../images/interaction-test-storybook-passed-test.png) | ||
|
||
If you're a seasoned Storybook user, most teams choose a [Component-Driven](https://componentdriven.org/) approach to UI development. UIs are built from the “bottom up” starting with basic components that are progressively combined to assemble pages. | ||
|
||
![Component-Driven UI](../../images/component-driven.jpg) | ||
|
||
1. Build each component in isolation and write stories for its variations. | ||
2. Compose small components together to enable more complex functionality. | ||
3. Assemble pages by combining composite components. | ||
4. Integrate pages into your project by hooking up data and business logic. | ||
|
||
<!-- Uncomment when E2EVT lands <details> | ||
<summary>Chromatic also integrates with Playwright and Cypress</summary> | ||
Developers test user flows end-to-end by navigating between pages with Playwright or Cypress. This methodology allows you to simulate how users behave. Chromatic uses these E2E tests as visual test cases by automatically snapshotting key moments in the test. | ||
[TK Learn how to setup Playwright](/docs/) | ||
[TK Learn how to setup Cypress](/docs/) | ||
</details> --> | ||
|
||
### Verify each story in multiple dimensions | ||
|
||
Once key UI states are captured as stories, verify how each story renders in different environments and with different user preferences to see how real users experience the UI. | ||
|
||
| Dimension | What to test | | ||
| -------------------------------------- | ----------------------------------------- | | ||
| [Browsers](/docs/browsers) | Chrome, Safari, Edge, Firefox | | ||
| [Viewports](/docs/viewports) | Mobile, tablet, desktop | | ||
| [Themes](/docs/themes) | Dark mode, light mode, and custom themes | | ||
| [Locales](/docs/custom-decorators) | Languages, text direction | | ||
| [Media features](/docs/media-features) | `forced-colors`, `prefers-reduced-motion` | | ||
|
||
### Create a library of test cases | ||
|
||
In the steps above, you developed UI and manually verified each story's appearance and functionality. Chromatic is designed to automate this manual verification process by creating a library of test cases from your stories. Once you create a story, you don't need to go back to check each story by hand to confirm that it looks correct. Instead, your library is automatically tested for changes every time you push code. | ||
|
||
![Component library](../../images/library.png) | ||
|
||
--- | ||
|
||
## Next: In pull request workflow | ||
|
||
Now that you've developed UI in Storybook, see how Chromatic speeds up your pull request workflow. Learn how to collect feedback, manage change requests, and get stakeholder sign-off. | ||
|
||
<a class="btn primary round" href="/docs/in-pull-request">Read next chapter</a> |
Oops, something went wrong.
fdf9304
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.
🎉 Published on https://docs.chromatic.com as production
🚀 Deployed on https://657b7a54890aec30e6da57f6--chromatic-docs.netlify.app