Skip to content

Fix(gatsby-plugin-image): Render LayoutWrapper prior to loading of lazy-hydrate #28841

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

Merged
merged 2 commits into from
Jan 7, 2021
Merged

Fix(gatsby-plugin-image): Render LayoutWrapper prior to loading of lazy-hydrate #28841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d796884
add layoutwrapper to intial render when lazy-hydrate hasn't yet run
Jan 4, 2021
b1567ac
calculate sizer string
Jan 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/gatsby-plugin-image/src/components/gatsby-image.browser.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
import { PlaceholderProps } from "./placeholder"
import { MainImageProps } from "./main-image"
import { Layout } from "../image-utils"
import { getSizer } from "./layout-wrapper"

// eslint-disable-next-line @typescript-eslint/interface-name-prefix
export interface GatsbyImageProps
Expand Down Expand Up @@ -194,6 +195,8 @@ export const GatsbyImageHydrator: FunctionComponent<GatsbyImageProps> = function
props,
])

const sizer = getSizer(layout, width, height)

return (
<Type
{...wrapperProps}
Expand All @@ -204,7 +207,9 @@ export const GatsbyImageHydrator: FunctionComponent<GatsbyImageProps> = function
}}
className={`${wClass}${className ? ` ${className}` : ``}`}
ref={root}
dangerouslySetInnerHTML={{ __html: `` }}
dangerouslySetInnerHTML={{
__html: sizer,
}}
suppressHydrationWarning
/>
)
Expand Down
18 changes: 17 additions & 1 deletion packages/gatsby-plugin-image/src/components/layout-wrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ if (hasNativeLazyLoadSupport) {
/>
)

export function getSizer(
layout: Layout,
width: number,
height: number
): string {
let sizer: string | null = null
if (layout === `fluid`) {
sizer = `<div aria-hidden="true" style="padding-top: ${
(height / width) * 100
}%;"></div>`
}
if (layout === `constrained`) {
sizer = `<div style="max-width: ${width}px; display: block;"><img alt="" role="presentation" aria-hidden="true" src="data:image/svg+xml;charset=utf-8,%3Csvg height='${height}' width='${width}' xmlns='http://www.w3.org/2000/svg' version='1.1'%3E%3C/svg%3E" style="max-width: 100%; display: block; position: static;"></div>`
}
return sizer
}

export const LayoutWrapper: FunctionComponent<ILayoutWrapperProps> = function LayoutWrapper({
layout,
width,
Expand Down Expand Up @@ -68,7 +85,6 @@ export const LayoutWrapper: FunctionComponent<ILayoutWrapperProps> = function La
</div>
)
}

return (
<Fragment>
{sizer}
Expand Down