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

Handle removal of transformTemplate #1415

Merged
merged 3 commits into from Jan 12, 2022
Merged

Handle removal of transformTemplate #1415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f998c83
Fixing removal of transform template
mattgperry Jan 11, 2022
6657b70
Updating test
mattgperry Jan 11, 2022
9af1444
Fixing tests
mattgperry Jan 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Expand Up @@ -2,6 +2,12 @@

Framer Motion adheres to [Semantic Versioning](http://semver.org/).

## [5.5.8] 2022-01-12

### Fixed

- Removing `transformTemplate` prop correctly rerenders element.

## [5.5.7] 2022-01-11

### Fixed
Expand Down
55 changes: 0 additions & 55 deletions src/motion/__tests__/component.test.tsx
View file
Open in desktop
Expand Up @@ -257,68 +257,13 @@ describe("motion component rendering and styles", () => {
expect(container.firstChild).toHaveStyle("background-color: #f00")
})

it("applies transformTemplate on initial render", () => {
const { container } = render(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) =>
`translateY(${x}) ${generated}`
}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(10px) translateX(10px) translateZ(0)"
)
})

it("renders transform", () => {
const { container } = render(
<motion.div style={{ transform: "translateX(10px)" }} />
)
expect(container.firstChild).toHaveStyle("transform: translateX(10px)")
})

it("applies updated transformTemplate", () => {
const { container, rerender } = render(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) =>
`translateY(${x}) ${generated}`
}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(10px) translateX(10px) translateZ(0)"
)

rerender(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) => {
const newX = typeof x === "string" ? parseFloat(x) : x
return `translateY(${(newX as number) * 2}px) ${generated}`
}}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(20px) translateX(10px) translateZ(0)"
)
})

it("renders transform with transformTemplate", () => {
const { container } = render(
<motion.div
transformTemplate={(_, generated) =>
`translateY(20px) ${generated}`
}
style={{ x: 10 }}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(20px) translateX(10px) translateZ(0)"
)
})

it("filters MotionProps from the DOM", () => {
const { container } = render(<motion.div initial={{ opacity: 0 }} />)
expect(container.firstChild).not.toHaveAttribute("initial")
Expand Down
114 changes: 114 additions & 0 deletions src/motion/__tests__/transformTemplate.test.tsx
View file
Open in desktop
@@ -0,0 +1,114 @@
import { render } from "../../../jest.setup"
import { motion } from "../../"
import * as React from "react"
import sync from "framesync"

describe("transformTemplate", () => {
it("applies transformTemplate on initial render", () => {
const { container } = render(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) =>
`translateY(${x}) ${generated}`
}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(10px) translateX(10px) translateZ(0)"
)
})

it("applies updated transformTemplate", () => {
const { container, rerender } = render(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) =>
`translateY(${x}) ${generated}`
}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(10px) translateX(10px) translateZ(0)"
)

rerender(
<motion.div
initial={{ x: 10 }}
transformTemplate={({ x }, generated) => {
const newX = typeof x === "string" ? parseFloat(x) : x
return `translateY(${(newX as number) * 2}px) ${generated}`
}}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(20px) translateX(10px) translateZ(0)"
)
})

it("renders transform with transformTemplate", () => {
const { container } = render(
<motion.div
transformTemplate={(_, generated) =>
`translateY(20px) ${generated}`
}
style={{ x: 10 }}
/>
)
expect(container.firstChild).toHaveStyle(
"transform: translateY(20px) translateX(10px) translateZ(0)"
)
})

it("renders transformTemplate without any transform", () => {
const { container } = render(
<motion.div transformTemplate={() => `translateY(20px)`} />
)
expect(container.firstChild).toHaveStyle("transform: translateY(20px)")
})

it("removes transformTemplate if prop is removed and transform is changed", async () => {
const { container, rerender } = render(
<motion.div
transformTemplate={() => `translateY(20px)`}
style={{ x: 10 }}
/>
)
expect(container.firstChild).toHaveStyle("transform: translateY(20px)")
rerender(<motion.div style={{ x: 20 }} />)

await new Promise((resolve) => sync.postRender(resolve))

expect(container.firstChild).toHaveStyle(
"transform: translateX(20px) translateZ(0)"
)
})

it("removes transformTemplate if prop is removed and transform is not changed", async () => {
const { container, rerender } = render(
<motion.div
transformTemplate={() => `translateY(20px)`}
style={{ x: 10 }}
/>
)
expect(container.firstChild).toHaveStyle("transform: translateY(20px)")
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm probably being thick, but why doesn't this have transform: translateY(20px) translateX(10px)?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh I am, because the template doesn't pass through the transforms 🤦

rerender(<motion.div style={{ x: 10 }} />)

await new Promise((resolve) => sync.postRender(resolve))

expect(container.firstChild).toHaveStyle(
"transform: translateX(10px) translateZ(0)"
)
})

it("removes transformTemplate if prop is removed", async () => {
const { container, rerender } = render(
<motion.div transformTemplate={() => `translateY(20px)`} />
)
expect(container.firstChild).toHaveStyle("transform: translateY(20px)")
rerender(<motion.div />)

await new Promise((resolve) => sync.postRender(resolve))

expect(container.firstChild).toHaveStyle("transform: none")
})
})
2 changes: 2 additions & 0 deletions src/render/html/utils/build-styles.ts
View file
Open in desktop
Expand Up @@ -79,6 +79,8 @@ export function buildHTMLStyles(
)
} else if (transformTemplate) {
style.transform = transformTemplate({}, "")
} else if (!latestValues.transform && style.transform) {
style.transform = "none"
}

if (hasTransformOrigin) {
Expand Down
4 changes: 4 additions & 0 deletions src/render/index.ts
View file
Open in desktop
Expand Up @@ -449,6 +449,10 @@ export const visualElement =
* added to our map, old ones removed, and listeners updated.
*/
setProps(newProps) {
if (newProps.transformTemplate || props.transformTemplate) {
element.scheduleRender()
}

props = newProps
lifecycles.updatePropListeners(newProps)

Expand Down