-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Update framework-components.mdx #11955
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
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.
Thank you for jumping on this issue! I think this is important and helpful! 🙌
See below for my specific comments!
@@ -84,7 +84,7 @@ There are several hydration directives available for UI framework components: `c | |||
|
|||
## Mixing frameworks | |||
|
|||
You can import and render components from multiple frameworks in the same Astro component. | |||
You can import and render components from multiple frameworks in the same Astro component. [Additional configuration](/en/guides/integrations-guide/react/#combining-multiple-jsx-frameworks) is required when mixing JSX frameworks. |
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.
You can import and render components from multiple frameworks in the same Astro component. [Additional configuration](/en/guides/integrations-guide/react/#combining-multiple-jsx-frameworks) is required when mixing JSX frameworks. | |
You can import and render components from multiple frameworks in the same Astro component. |
I think we'd rather not clutter up the basic "here's how it works/what it looks like" before the code snippet, so we can quickly get this major point across.
I'd suggest something between the snippet and the caution, maybe like:
Astro will recognize and render your component based on its file extension. To distinguish between frameworks that use the same file extension, [additional configuration when rendering multiple JSX frameworks](/en/guides/integrations-guide/react/#combining-multiple-jsx-frameworks) (e.g. React and Preact) is required.
(also, one of the reasons for my rewording is thinking about what text is linked: "additional configuration" isn't as revealing about what the link is for as e.g. "additional configuration when rendering multiple JSX framworks" -- I always think about it as, what if the link text were my navigation/table of contents. Does it clearly tell me what is at the link the same way a section header should tell me what content is contained within that section?)
What do you think?
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.
I think that's a great way to think about a link, very purpose driven design 😄
Will update it 👍
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.
@JusticeMatthew Are you still up for updating this? (I don't see another commit)
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.
Yes sorry, fell through the cracks with my computer dying 😅 (PC is repaird now)
Will update it today
Description (required)
Informs users that additional configuration is required when mixing jsx components and provides a link to the related page
See discussion #11742 for more info
Related issues & labels (optional)