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.

Sign up for GitHub

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

Jump to bottom

feat(container): document new way to load renderers #8428

Merged
merged 6 commits into from
Jun 5, 2024
Merged

feat(container): document new way to load renderers #8428

merged 6 commits into from
Jun 5, 2024

Conversation

ematipico
Copy link
Member

Description (required)

This PR updates the container API, and documents the new way to load renderers.

For Astro version: 4.10.0. See astro PR #11144.

@vercel Vercel
Copy link

vercel bot commented Jun 4, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 5, 2024 10:32pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Jun 5, 2024 10:32pm

@ematipico ematipico mentioned this pull request Jun 4, 2024
Merged
@astrobot-houston
Copy link
Contributor

astrobot-houston commented Jun 4, 2024 •
edited
Loading

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en reference/container-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

sasoria
sasoria reviewed Jun 4, 2024
View reviewed changes
Copy link
Contributor

@sasoria sasoria left a comment

Choose a reason for hiding this comment

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

Awesome, I think I found two typos though I'm not sure if that really is the case. I added some suggestions for you.

src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
sarah11918
sarah11918 reviewed Jun 4, 2024
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks @ematipico ! Exposing these is going to make this much easier, for sure! 🙌

Most of my comments are questions, not edits, to make sure we are guiding people in the most helpful way!

src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/container-reference.mdx Outdated
A list of client renderers required by the component. Use this if your `.astro` component renders any [UI framework components](/en/guides/framework-components/) using an official Astro integration (e.g. React, Vue, etc.). For each framework rendered, you must provide an object stating the integration package `name`, as well as both its client and server rendering script
A list of client renderers required by the component. Use this if your `.astro` component renders any [UI framework components](/en/guides/framework-components/) using an official Astro integration (e.g. React, Vue, etc.). For each framework rendered, you must provide an object stating the integration package `name`, as well as both its client and server rendering script.

In a vite-full environment, renderers should be loaded by using the function `loadRenderers`, from the virtual module `astro:container`.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure "a vite-full environment" is clear enough to be helpful. I'm not sure what specific conditions this does or doesn't include. Can you be more descriptive here? (Even to me, then I can put it into words if you like!)

src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) labels Jun 4, 2024
@sarah11918 sarah11918 added this to the 4.10.0 milestone Jun 4, 2024
sarah11918
sarah11918 reviewed Jun 4, 2024
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Some polishing thoughts here. See what you think!

src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/container-reference.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 added minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Jun 5, 2024
@sarah11918 sarah11918 changed the base branch from main to 4.10.0 June 5, 2024 22:15
@sarah11918 sarah11918 mentioned this pull request Jun 5, 2024
Merged
@sarah11918 sarah11918 merged commit 3a9a47a into 4.10.0 Jun 5, 2024
2 of 3 checks passed
@sarah11918 sarah11918 deleted the feat/container-renderer branch June 5, 2024 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarah11918 sarah11918 sarah11918 left review comments

@sasoria sasoria sasoria left review comments

Assignees
No one assigned
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Milestone
4.10.0
Development

Successfully merging this pull request may close these issues.
4 participants
@ematipico @astrobot-houston @sarah11918 @sasoria