Skip to content

Commit

Permalink
Finalize View Transition event names (#8181)
Browse files Browse the repository at this point in the history
* Finalize View Transition event names

* Use hyphenated names
  • Loading branch information
matthewp authored Aug 24, 2023
1 parent d87837e commit a8f3577
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .changeset/proud-fans-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': minor
---

Finalize View Transition event names
10 changes: 5 additions & 5 deletions packages/astro/components/ViewTransitions.astro
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ const { fallback = 'animate' } = Astro.props as Props;
index: number;
scrollY: number;
};
type Events = 'astro:load' | 'astro:beforeload';
type Events = 'astro:page-load' | 'astro:after-swap';

const persistState = (state: State) => history.replaceState(state, '');
const supportsViewTransitions = !!document.startViewTransition;
const transitionEnabledOnThisPage = () =>
!!document.querySelector('[name="astro-view-transitions-enabled"]');
const triggerEvent = (name: Events) => document.dispatchEvent(new Event(name));
const onload = () => triggerEvent('astro:load');
const onPageLoad = () => triggerEvent('astro:page-load');
const PERSIST_ATTR = 'data-astro-transition-persist';

// The History API does not tell you if navigation is forward or back, so
Expand Down Expand Up @@ -193,7 +193,7 @@ const { fallback = 'animate' } = Astro.props as Props;
scrollTo(0, state.scrollY); // usings default scrollBehavior
}

triggerEvent('astro:beforeload');
triggerEvent('astro:after-swap');
};

// Wait on links to finish, to prevent FOUC
Expand Down Expand Up @@ -263,7 +263,7 @@ const { fallback = 'animate' } = Astro.props as Props;
// document.documentElement.removeAttribute('data-astro-transition');
await runScripts();
markScriptsExec();
onload();
onPageLoad();
}
}

Expand Down Expand Up @@ -383,7 +383,7 @@ const { fallback = 'animate' } = Astro.props as Props;
{ passive: true, capture: true }
);
});
addEventListener('load', onload);
addEventListener('load', onPageLoad);
// There's not a good way to record scroll position before a back button.
// So the way we do it is by listening to scroll and just continuously recording it.
addEventListener(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
}

toggle();
document.addEventListener('astro:beforeload', () => {
document.addEventListener('astro:after-swap', () => {
toggle();
})
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import Layout from '../components/Layout.astro';
<article id="twoarticle"></article>
</Layout>
<script>
document.addEventListener('astro:load', () => {
document.addEventListener('astro:page-load', () => {
document.getElementById('twoarticle')!.textContent = 'works';
}, { once: true });
</script>
6 changes: 3 additions & 3 deletions packages/astro/e2e/view-transitions.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ test.describe('View Transitions', () => {
await expect(p, 'imported CSS updated').toHaveCSS('font-size', '24px');
});

test('astro:load event fires when navigating to new page', async ({ page, astro }) => {
test('astro:page-load event fires when navigating to new page', async ({ page, astro }) => {
// Go to page 1
await page.goto(astro.resolveUrl('/one'));
const p = page.locator('#one');
Expand All @@ -193,14 +193,14 @@ test.describe('View Transitions', () => {
await expect(article, 'should have script content').toHaveText('works');
});

test('astro:load event fires when navigating directly to a page', async ({ page, astro }) => {
test('astro:page-load event fires when navigating directly to a page', async ({ page, astro }) => {
// Go to page 2
await page.goto(astro.resolveUrl('/two'));
const article = page.locator('#twoarticle');
await expect(article, 'should have script content').toHaveText('works');
});

test('astro:beforeload event fires right before the swap', async ({ page, astro }) => {
test('astro:after-swap event fires right after the swap', async ({ page, astro }) => {
// Go to page 1
await page.goto(astro.resolveUrl('/one'));
let p = page.locator('#one');
Expand Down

0 comments on commit a8f3577

Please sign in to comment.