Skip to content

Update JSX documentation - #3064

Merged
Jake Bailey (jakebailey) merged 7 commits into
microsoft:v2from
remcohaszing:update-jsx-docs
Jul 8, 2024
Merged

Update JSX documentation#3064
Jake Bailey (jakebailey) merged 7 commits into
microsoft:v2from
remcohaszing:update-jsx-docs

Conversation

@remcohaszing

@remcohaszingRemco Haszing (remcohaszing) commented Apr 18, 2024

Copy link
Copy Markdown
Contributor

This adds some missing information about using JSX in TypeScript.

  • Add the react-jsx and react-jsxdev modes in the introduction. Also mention they are called the classic and automatic runtime.
  • Specify where frameworks need to specify the JSX namespace.
  • Clarify which jsx options use which type definitions.
  • Specify that JSX runtimes must use package exports in order to support ESM.
  • Fix syntax highlighting in JSX code blocks.
  • Document that users may use the @jsxRuntime comment to override the jsx option on a per-file basis.

@remcohaszing
Update JSX documentation
c287558
This adds some missing information about using JSX in TypeScript.
- Add the `react-jsx` and `react-jsxdev` modes in the introduction. Also
mention they are called the classic and automatic runtime.
- Specify where frameworks need to specify the `JSX` namespace.
- Clarify which `jsx` options use which type definitions.
- Specify that JSX runtimes must use package exports in order to support
ESM.
- Fix syntax highlighting in JSX code blocks.
- Document that users may use the `@jsxRuntime` comment to override the
`jsx` option on a per-file basis.
@jakebaileyJake Bailey (jakebailey) added the deploy-preview Enables automatic deployments to preview environments on a PR label Apr 18, 2024
@jakebailey

Jake Bailey (jakebailey) commented Apr 24, 2024

Copy link
Copy Markdown
Member

Is there anyone who might be able to help verify this? Wesley Wigham (@weswigham) maybe? Daniel Rosenwasser (@DanielRosenwasser)?

@orta

Orta Therox (orta) commented Apr 26, 2024

Copy link
Copy Markdown
Contributor

I can at least confirm that this is how I model the JSX support in my head (I think people are re-looking at this because React 19 is starting to come out) after giving it a look though.

The only bits I'm not certain of are the ESM support docs, because I've not had to interact with that system. Feels reasonable to me though.

@remcohaszing

Remco Haszing (remcohaszing) commented Apr 26, 2024

Copy link
Copy Markdown
ContributorAuthor

Missing package exports are the reason why the automatic runtime in react@<18 didn’t work with ESM.

@jakebaileyJake Bailey (jakebailey) mentioned this pull request Jun 5, 2024
Merged
eps1lon
Sebastian "Sebbie" Silbermann (eps1lon) reviewed Jun 6, 2024
View reviewed changes
Comment threadpackages/documentation/copy/en/reference/JSX.md Outdated
Comment threadpackages/documentation/copy/en/reference/JSX.md Outdated
Comment threadpackages/documentation/copy/en/reference/JSX.md Outdated
Comment threadpackages/documentation/copy/en/reference/JSX.md Outdated
Comment threadpackages/documentation/copy/en/reference/JSX.md Outdated
@remcohaszing@eps1lon
Apply suggestions from code review
9bddf77
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
@remcohaszing
Use less strong words to specify where to define the JSX namespace
3435c68
Since it’s also possible to define the `JSX` namespace globally, `needs
to` is a bit to strong. It was replaced with `should`.
@remcohaszing
Specify ElementType doesn’t specify the props type
0e697b1
@github-actions

github-actionsBot commented Jun 7, 2024

Copy link
Copy Markdown
Contributor

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-plant-05c166c10-3064.centralus.5.azurestaticapps.net

@jakebailey

Jake Bailey (jakebailey) commented Jul 8, 2024

Copy link
Copy Markdown
Member

Gave this a reread, and everything seems to check out to me.

@jakebailey
Jake Bailey (jakebailey) merged commit 57ac2f7 into microsoft:v2Jul 8, 2024
@remcohaszing
Remco Haszing (remcohaszing) deleted the update-jsx-docs branch July 8, 2024 18:05
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jakebaileyJake Bailey (jakebailey)jakebailey approved these changes
+1 more reviewer
@eps1lonSebastian "Sebbie" Silbermann (eps1lon)eps1lon left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

deploy-previewEnables automatic deployments to preview environments on a PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@remcohaszing@jakebailey@orta@eps1lon