Docs: Add CSF 4 (experimental) snippets #30269
Conversation
| @@ -1,3 +1,93 @@ | |||
| ```js filename="Button.stories.js" renderer="common" language="js" tabTitle="CSF 3" | |||
There was a problem hiding this comment.
This diff is unfortunately hard to read. There are two required steps that aren't react-specific:
commonsnippets must be placed before thereactones- Add
tabTitle="CSF 3"tocommonsnippets
There was a problem hiding this comment.
The tags-in-preview.md diff is much easier to understand.
| ``` | ||
|
|
||
| ```js filename="Button.stories.js" renderer="svelte" language="js" tabTitle="CSF" | ||
| import Button from './Button.svelte'; | ||
| <!-- js & ts-4-9 (when applicable) still needed while providing both CSF 3 & 4 --> |
There was a problem hiding this comment.
For the time being, we will need react versions of whatever languages are available for other renderers. In this case that means js, ts, and ts-4-9.
I left this comment in there for an easy find/replace once we only have CSF 4 snippets.
There was a problem hiding this comment.
If you think this is too much of a burden, I can try to adjust the snippets logic to only require one language for the CSF 4 snippets. But I anticipate that being quite tricky, and I'd rather do the "dumb" solution.
kylegach
force-pushed
the
docs-csf-4-snippets
branch
from
d0371d2 to
6825384
Compare
|
View your CI Pipeline Execution ↗ for commit 5d7b457.
☁️ Nx Cloud last updated this comment at |
* docs-csf-4: (45 commits) Improve clarity Stylistic preferences Stylistic preferences Remove unrelated CSF factory changes Docs: Fix syntax issues in documentation snippets Fix formatting Update yarn lock file Fix indentation Bump version from "8.6.0-alpha.0" to "8.6.0-alpha.1" [skip ci] Write changelog for 8.6.0-alpha.1 [skip ci] Replace `interaction test` -> `component test` Remove redundant browser configuration Update Vitest dependencies Add missing comma Addon Test: Support Vitest 3 Angular: Fix typings disable flaky test-runner tests Revert "Refactor Vitest browser configuration" Fix tests RNWVite: Support for requires in rnw for images/fonts ...
kylegach
force-pushed
the
docs-csf-4-snippets
branch
from
dd306eb to
5d7b457
Compare
What I did
Add CSF 4 (experimental) versions of code snippets when
reactis the active renderer, using tabs:Checklist for Contributors
Testing
Manual testing
reactand non-reactrenderers and for all languages (js,ts,ts-4-9)Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.