Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RNW-Vite: Document framework options #30380

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

dannyhw
Copy link
Member

@dannyhw dannyhw commented Jan 24, 2025

Closes #

What I did

Updating the getting started guide for react native web vite to include the options that are available

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR enhances the documentation for React Native Web Vite framework in Storybook, adding comprehensive configuration options and requirements for better developer guidance.

  • Added Vite ≥4.0 as a new requirement in /docs/get-started/frameworks/react-native-web-vite.mdx
  • Added detailed configuration examples for pluginReactOptions and pluginBabelOptions in framework options
  • Added TypeScript type definitions in /code/frameworks/react-native-web-vite/src/types.ts for framework configuration
  • Added API configuration section with builder options documentation
  • Added migration guidance for projects using addon-react-native-web

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +141 to +143
jsxRuntime: 'automatic' | 'classic', // default: 'automatic'
jsxImportSource: string, // default: 'react'
babel:{
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: The type syntax here is incorrect for a code example. Should show actual string literals instead of TypeScript types

Copy link

nx-cloud bot commented Jan 24, 2025

View your CI Pipeline Execution ↗ for commit a0d6c9f.

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

☁️ Nx Cloud last updated this comment at 2025-01-26 16:23:25 UTC

@dannyhw dannyhw added the ci:docs Run the CI jobs for documentation checks only. label Jan 24, 2025
@dannyhw dannyhw requested a review from shilman January 24, 2025 22:46
@shilman shilman changed the title RNWVite: Options documentation for react native web vite RNW-Vite: Document framework options Jan 25, 2025
@shilman
Copy link
Member

shilman commented Jan 25, 2025

@dannyhw I think this is a great start. We should probably also add specific example configurations for reanimated and nativewind

@neso123456
Copy link

No problrm

@dannyhw
Copy link
Member Author

dannyhw commented Jan 26, 2025

@shilman added those example configs

@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 26, 2025
@jonniebigodes jonniebigodes self-assigned this Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants