Skip to content

Conversation

@kylegach
Copy link
Contributor

@kylegach kylegach commented Jan 15, 2025

What I did

Add CSF factory (experimental) versions of code snippets when react is the active renderer, using tabs:

CodeSnippet component with CSF 3 & CSF 4 (experimental) tabs

Checklist for Contributors

Testing

Manual testing

  1. Sync this branch with locally running docs site
  2. Manually confirm all updated snippets display as expected for both react and non-react renderers and for all languages (js, ts, ts-4-9)

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make 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.

@@ -1,3 +1,93 @@
```js filename="Button.stories.js" renderer="common" language="js" tabTitle="CSF 3"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This diff is unfortunately hard to read. There are two required steps that aren't react-specific:

  1. common snippets must be placed before the react ones
  2. Add tabTitle="CSF 3" to common snippets

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tags-in-preview.md diff is much easier to understand.

@kylegach kylegach force-pushed the docs-csf-4-snippets branch from d0371d2 to 6825384 Compare January 15, 2025 20:46
@nx-cloud
Copy link

nx-cloud bot commented Jan 15, 2025

View your CI Pipeline Execution ↗ for commit 66c95e3.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 6s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-11 21:13:59 UTC

@kylegach kylegach self-assigned this Jan 15, 2025
* 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 kylegach force-pushed the docs-csf-4-snippets branch from dd306eb to 5d7b457 Compare January 22, 2025 17:13
@kylegach kylegach changed the title Docs: Add CSF 4 (experimental) snippets Docs: Add CSF factory (experimental) snippets Jan 22, 2025
@kylegach
Copy link
Contributor Author

Closing in favor of #32357

@kylegach kylegach closed this Sep 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants