Skip to content

responsive images stable #11741

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

responsive images stable #11741

wants to merge 9 commits into from

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented May 22, 2025

Description (required)

Un-experimentalizes responsive images!

Moves the responsive image docs (properties, guide, reference, explanations) to the proper locations throughout the stable docs.

In particular:

  • the component properties are moved to the astro:assets module page
  • the configuration reference properties are no longer named using experimental
  • the Images guide is updated to describe how the image components (and with configuration, images written with Markdown image syntax) behave when given responsive image properties
  • deletes the existing experimental reference page

Additionally, with the addition of new image content, the Image Guide itself has been slightly reorganized and lightly edited with some overall improvements:

  • colocating the "Images in X filetype" sections, since the available image options depend firstly on the type of file in which you want to add an image
  • adding a new **Options:** list at the start of each of these sections so that at a glance, it is easy to tell which image methods are available in that file type
  • creating a new <h2> to group all the "components" (<Image />, <Picture />, SVGs as components, creating a custom component (e.g. <BlogPostImage /> ) for easy reuse of images that share default settings), and removing this content from within the "Images in .astro files" section
    • Note: Originally, this grouping was to emphasize that these are Astro components, for use within .astro files. This draft instead optimizes for quickly identifying your image options based on the file type, but no longer provides all that content within that section. This allows readers to quickly see and compare how different file types work, and find the details later on the page in a dedicated section for components.
  • Updating some section headings:
    • the Image and Picture headings were too long and trying to convey too much information in the section heading
    • in fact, the Picture section heading was now "incorrect" as it was previously described as "for producing responsive images" but now we have a responsive image feature that applies to both image and picture components
    • "Setting default values" was originally worded based on having received questions about whether defaults can be set for the components. Previously, the answer was now. Now, it's "no, except for configured responsive images." Now, the section heading focuses on the solution presented: creating custom components when you want/need consistent, reusable image attributes and styles. This also is in keeping with the section now being focused on "components"
  • improvements and bug fixes

Related issues & labels (optional)

  • Closes #
  • Suggested label:

For Astro version: 5.x. See astro PR #. // will fill in when known

Copy link

netlify bot commented May 22, 2025

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit f7d41a1
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/682f7f7f35806f000822a26f
😎 Deploy Preview https://deploy-preview-11741--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented May 22, 2025

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

File Note
en/guides/images.mdx Source changed, localizations will be marked as outdated.
en/reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/experimental-flags/responsive-images.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-assets.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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants