rename to onAnimationFrame

sveltejs · Rich-Harris · Dec 6, 2024 · Dec 6, 2024 · Apr 11, 2025 · Apr 12, 2025
commit fbf247d26801977516dbc1fa1803d4e57ad2b87e
diff --git a/packages/svelte/src/index-client.js b/packages/svelte/src/index-client.js
@@ -199,15 +199,15 @@ export function afterUpdate(fn) {
 }
 
 /**
- * The `onFrame` function schedules a callback to run on `requestAnimationFrame`. It must be called inside an effect (e.g. during component initialisation).
+ * The `onAnimationFrame` function schedules a callback to run on `requestAnimationFrame`. It must be called inside an effect (e.g. during component initialisation).
  *
- * `onFrame` does not run inside [server-side components](https://svelte.dev/docs/svelte/svelte-server#render).
+ * `onAnimationFrame` does not run inside [server-side components](https://svelte.dev/docs/svelte/svelte-server#render).
  *
  * @template T
  * @param {() => NotFunction<T> | Promise<NotFunction<T>> | (() => any)} fn
  * @returns {void}
  */
-export function onFrame(fn) {
+export function onAnimationFrame(fn) {
 	onMount(() => {
 		let frame = -1;
 

diff --git a/packages/svelte/src/index-server.js b/packages/svelte/src/index-server.js
@@ -12,7 +12,7 @@ export function onDestroy(fn) {
 export {
 	noop as beforeUpdate,
 	noop as afterUpdate,
-	noop as onFrame,
+	noop as onAnimationFrame,
 	noop as onMount,
 	noop as flushSync,
 	run as untrack

diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts
@@ -411,12 +411,12 @@ declare module 'svelte' {
 	 * */
 	export function afterUpdate(fn: () => void): void;
 	/**
-	 * The `onFrame` function schedules a callback to run on `requestAnimationFrame`. It must be called inside an effect (e.g. during component initialisation).
+	 * The `onAnimationFrame` function schedules a callback to run on `requestAnimationFrame`. It must be called inside an effect (e.g. during component initialisation).
 	 *
-	 * `onFrame` does not run inside [server-side components](https://svelte.dev/docs/svelte/svelte-server#render).
+	 * `onAnimationFrame` does not run inside [server-side components](https://svelte.dev/docs/svelte/svelte-server#render).
 	 *
 	 * */
-	export function onFrame<T>(fn: () => NotFunction<T> | Promise<NotFunction<T>> | (() => any)): void;
+	export function onAnimationFrame<T>(fn: () => NotFunction<T> | Promise<NotFunction<T>> | (() => any)): void;
 	/**
 	 * Create a snippet programmatically
 	 * */