-
Notifications
You must be signed in to change notification settings - Fork 799
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
Tiled gallery block: Add srcset to images in the editor #12061
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import photon from 'photon'; | ||
| import { format as formatUrl, parse as parseUrl } from 'url'; | ||
| import { isBlobURL } from '@wordpress/blob'; | ||
| import { range } from 'lodash'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { PHOTON_MAX_RESIZE } from '../constants'; | ||
|
|
||
| export function isSquareishLayout( layout ) { | ||
| return [ 'circle', 'square' ].includes( layout ); | ||
| } | ||
|
|
||
| /** | ||
| * Build src and srcSet properties which can be used on an <img /> | ||
| * | ||
| * @param {Object} img Image | ||
| * @param {number} img.height Image height | ||
| * @param {string} img.url Image URL | ||
| * @param {number} img.width Image width | ||
| * | ||
| * @param {Object} galleryAtts Gallery attributes relevant for image optimization. | ||
| * @param {string} galleryAtts.layoutStyle Gallery layout. 'rectangular', 'circle', etc. | ||
| * @param {number} galleryAtts.columns Gallery columns. Not applicable for all layouts. | ||
| * | ||
| * @return {Object} Returns an object. If possible, the object will include `src` and `srcSet` | ||
| * properties {string} for use on an image. | ||
| */ | ||
| export function photonizedImgProps( img, galleryAtts = {} ) { | ||
| if ( ! img.height || ! img.url || ! img.width ) { | ||
| return {}; | ||
| } | ||
|
|
||
| // Do not Photonize images that are still uploading or from localhost | ||
| if ( isBlobURL( img.url ) || /^https?:\/\/localhost/.test( img.url ) ) { | ||
| return { src: img.url }; | ||
| } | ||
|
|
||
| // Drop query args, photon URLs can't handle them | ||
| // This should be the "raw" url, we'll add dimensions later | ||
| const url = img.url.split( '?', 1 )[ 0 ]; | ||
| const { height, width } = img; | ||
| const { layoutStyle } = galleryAtts; | ||
|
|
||
| const photonImplementation = isWpcomFilesUrl( url ) ? photonWpcomImage : photon; | ||
|
|
||
| /** | ||
| * Build the `src` | ||
| * We don't know what the viewport size will be like. Use full size src. | ||
| */ | ||
|
|
||
| let src; | ||
| if ( isSquareishLayout( layoutStyle ) && width && height ) { | ||
| // Layouts with 1:1 width/height ratio should be made square | ||
| const size = Math.min( PHOTON_MAX_RESIZE, width, height ); | ||
| src = photonImplementation( url, { | ||
| resize: `${ size },${ size }`, | ||
| strip: 'all', | ||
| } ); | ||
| } else { | ||
| src = photonImplementation( url, { strip: 'all' } ); | ||
| } | ||
|
|
||
| /** | ||
| * Build a sensible `srcSet` that will let the browser get an optimized image based on | ||
| * viewport width. | ||
| */ | ||
|
|
||
| const step = 300; | ||
| const srcsetMinWith = 600; | ||
|
|
||
| let srcSet; | ||
| if ( isSquareishLayout( layoutStyle ) ) { | ||
| const minWidth = Math.min( srcsetMinWith, width, height ); | ||
| const maxWidth = Math.min( PHOTON_MAX_RESIZE, width, height ); | ||
|
|
||
| srcSet = range( minWidth, maxWidth, step ) | ||
| .map( srcsetWidth => { | ||
| const srcsetSrc = photonImplementation( url, { | ||
| resize: `${ srcsetWidth },${ srcsetWidth }`, | ||
| strip: 'all', | ||
| } ); | ||
| return srcsetSrc ? `${ srcsetSrc } ${ srcsetWidth }w` : null; | ||
| } ) | ||
| .filter( Boolean ) | ||
| .join( ',' ); | ||
| } else { | ||
| const minWidth = Math.min( srcsetMinWith, width ); | ||
| const maxWidth = Math.min( PHOTON_MAX_RESIZE, width ); | ||
|
|
||
| srcSet = range( minWidth, maxWidth, step ) | ||
| .map( srcsetWidth => { | ||
| const srcsetSrc = photonImplementation( url, { | ||
| strip: 'all', | ||
| width: srcsetWidth, | ||
| } ); | ||
| return srcsetSrc ? `${ srcsetSrc } ${ srcsetWidth }w` : null; | ||
| } ) | ||
| .filter( Boolean ) | ||
| .join( ',' ); | ||
| } | ||
|
|
||
| return Object.assign( { src }, srcSet && { srcSet } ); | ||
| } | ||
|
|
||
| function isWpcomFilesUrl( url ) { | ||
| const { host } = parseUrl( url ); | ||
| return /\.files\.wordpress\.com$/.test( host ); | ||
| } | ||
|
|
||
| /** | ||
| * Apply photon arguments to *.files.wordpress.com images | ||
| * | ||
| * This function largely duplicates the functionlity of the photon.js lib. | ||
| * This is necessary because we want to serve images from *.files.wordpress.com so that private | ||
| * WordPress.com sites can use this block which depends on a Photon-like image service. | ||
| * | ||
| * If we pass all images through Photon servers, some images are unreachable. *.files.wordpress.com | ||
| * is already photon-like so we can pass it the same parameters for image resizing. | ||
| * | ||
| * @param {string} url Image url | ||
| * @param {Object} opts Options to pass to photon | ||
| * | ||
| * @return {string} Url string with options applied | ||
| */ | ||
| function photonWpcomImage( url, opts = {} ) { | ||
| // Adhere to the same options API as the photon.js lib | ||
| const photonLibMappings = { | ||
| width: 'w', | ||
| height: 'h', | ||
| letterboxing: 'lb', | ||
| removeLetterboxing: 'ulb', | ||
| }; | ||
|
|
||
| // Discard some param parts | ||
| const { auth, hash, port, query, search, ...urlParts } = parseUrl( url ); | ||
|
|
||
| // Build query | ||
| // This reduction intentionally mutates the query as it is built internally. | ||
| urlParts.query = Object.keys( opts ).reduce( | ||
| ( q, key ) => | ||
| Object.assign( q, { | ||
| [ photonLibMappings.hasOwnProperty( key ) ? photonLibMappings[ key ] : key ]: opts[ key ], | ||
| } ), | ||
| {} | ||
| ); | ||
|
|
||
| return formatUrl( urlParts ); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
BTW you're using a mixture of
srcsetandsrcSetin variable names. Not a biggie, just thought you ought to know. 😜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.
😱 Yeah… I think I was mostly using
srcset, but React wantssrcSetso… 🤷♂️