Skip to content

web: Add config option to hide message when Ruffle restores from bfcache #22226

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+39 −2
Open

web: Add config option to hide message when Ruffle restores from bfcache #22226

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
31a7bf3
web: Add config option to hide message when Ruffle restores from bfcache
danielhjacobs Nov 13, 2025
a59fcc2
web: Change config to bfcacheBehavior enum (inform, restore, reload)
danielhjacobs Nov 13, 2025
7d976a9
web: Address nit by renaming CacheBehavior to BFCacheBehavior
danielhjacobs Nov 13, 2025
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
12 changes: 10 additions & 2 deletions web/packages/core/src/internal/player/inner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
UnmuteOverlay,
URLLoadOptions,
WindowMode,
BFCacheBehavior,
} from "../../public/config";
import { MovieMetadata, ReadyState } from "../../public/player";
import { ruffleShadowTemplate } from "../ui/shadow-template";
Expand Down Expand Up @@ -2134,8 +2135,15 @@ export class InnerPlayer {
* Inform the user that the browser restored the file from the back/forward cache.
*/
protected displayRestoredFromBfcacheMessage(): void {
// Do not display the message if another one is already shown.
if (this.container.querySelector("#message-overlay") !== null) {
// Do not display the message if another one is already shown or website opted out.
if (
this.container.querySelector("#message-overlay") !== null ||
this.loadedConfig?.bfcacheBehavior === BFCacheBehavior.Restore
) {
return;
}
if (this.loadedConfig?.bfcacheBehavior === BFCacheBehavior.Reload) {
this.reload();
return;
}
const message = textAsParagraphs("message-restored-from-bfcache");
Expand Down
2 changes: 2 additions & 0 deletions web/packages/core/src/public/config/default.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
UnmuteOverlay,
WindowMode,
ScrollingBehavior,
BFCacheBehavior,
} from "./load-options";

export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
Expand All @@ -22,6 +23,7 @@ export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
upgradeToHttps: true,
compatibilityRules: true,
favorFlash: true,
bfcacheBehavior: BFCacheBehavior.Inform,
warnOnUnsupportedContent: true,
logLevel: LogLevel.Error,
showSwfDownload: false,
Expand Down
27 changes: 27 additions & 0 deletions web/packages/core/src/public/config/load-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,26 @@ export enum GamepadButton {
DPadRight = "dpad-right",
}

/**
* The behavior when the bfcache takes effect
*/
export enum BFCacheBehavior {
/**
* Inform the user that the content was restore from the bfcache.
*/
Inform = "inform",

/**
* Restore the content from the bfcache without a message.
*/
Restore = "restore",

/**
* Reload the content so it starts fresh if the bfcache takes effect.
*/
Reload = "reload",
}

/**
* Any options used for loading a movie.
*/
Expand Down Expand Up @@ -450,6 +470,13 @@ export interface BaseLoadOptions {
*/
favorFlash?: boolean;

/**
* Behavior when the bfcache takes effect
*
* @default BFCacheBehavior.Inform
*/
bfcacheBehavior?: BFCacheBehavior;

/**
* This is no longer used and does not affect anything.
* It is only kept for backwards compatibility.
Expand Down