Skip to content

feat(UseFullscreen): add utility export #396

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
mmamedel wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(UseFullscreen): add utility export #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f6ef899
feat(UseFullscreen): add utility export
mmamedel Dec 22, 2025
1912112
feat(useFullscreen): align implementation to VueUse
mmamedel Dec 22, 2025
b06a035
add docs
mmamedel Dec 22, 2025
0f1f64f
add demo
mmamedel Dec 22, 2025
20cb6dd
improve var naming
mmamedel Dec 22, 2025
cd02a00
docs
mmamedel Dec 22, 2025
a8d4605
add test
mmamedel Dec 23, 2025
b8aaa5b
test(useFullscreen): add ts-ignore comment for fullScreen property
mmamedel Dec 23, 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
1 change: 1 addition & 0 deletions packages/runed/src/lib/utilities/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export * from "./textarea-autosize/index.js";
export * from "./throttled/index.js";
export * from "./use-debounce/index.js";
export * from "./use-event-listener/index.js";
export * from "./use-fullscreen/index.js";
export * from "./use-geolocation/index.js";
export * from "./use-intersection-observer/index.js";
export * from "./use-mutation-observer/index.js";
Expand Down
1 change: 1 addition & 0 deletions packages/runed/src/lib/utilities/use-fullscreen/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "./use-fullscreen.svelte";
179 changes: 179 additions & 0 deletions packages/runed/src/lib/utilities/use-fullscreen/use-fullscreen.svelte.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
import { type ConfigurableDocument, defaultDocument } from "../../internal/configurable-globals.js";
import type { MaybeElementGetter } from "../../internal/types.js";
import { extract } from "../extract/extract.svelte.js";
import { useEventListener } from "../use-event-listener/index.js";

export interface UseFullscreenOptions extends ConfigurableDocument {
/**
* Automatically exit fullscreen when component is unmounted
*
* @default false
*/
autoExit?: boolean;
}

export interface UseFullscreenReturn {
readonly isSupported: boolean;
readonly isFullscreen: boolean;
enter: () => Promise<void>;
exit: () => Promise<void>;
toggle: () => Promise<void>;
}

const eventHandlers = [
"fullscreenchange",
"webkitfullscreenchange",
"webkitendfullscreen",
"mozfullscreenchange",
"MSFullscreenChange",
] as any as "fullscreenchange"[];

/**
* Reactive Fullscreen API.
*
* @see https://runed.dev/docs/utilities/use-fullscreen
* @param targetGetter
* @param options
*/
export function useFullscreen<T extends Element = HTMLElement>(
targetGetter?: MaybeElementGetter<T>,
options: UseFullscreenOptions = {}
): UseFullscreenReturn {
const { document = defaultDocument, autoExit = false } = options;

let target = $derived(extract(targetGetter) ?? document?.documentElement) as T | null | undefined;
let isFullscreen = $state(false);

const requestMethod = $derived.by<"requestFullscreen" | undefined>(() => {
return [
"requestFullscreen",
"webkitRequestFullscreen",
"webkitEnterFullscreen",
"webkitEnterFullScreen",
"webkitRequestFullScreen",
"mozRequestFullScreen",
"msRequestFullscreen",
].find((m) => (document && m in document) || (target && m in target)) as
| "requestFullscreen"
| undefined;
});

const exitMethod = $derived.by<"exitFullscreen" | undefined>(() => {
return [
"exitFullscreen",
"webkitExitFullscreen",
"webkitExitFullScreen",
"webkitCancelFullScreen",
"mozCancelFullScreen",
"msExitFullscreen",
].find((m) => (document && m in document) || (target && m in target)) as
| "exitFullscreen"
| undefined;
});

const fullscreenEnabled = $derived.by<"fullscreenEnabled" | undefined>(() => {
return [
"fullScreen",
"webkitIsFullScreen",
"webkitDisplayingFullscreen",
"mozFullScreen",
"msFullscreenElement",
].find((m) => (document && m in document) || (target && m in target)) as
| "fullscreenEnabled"
| undefined;
});

const fullscreenElementMethod = [
"fullscreenElement",
"webkitFullscreenElement",
"mozFullScreenElement",
"msFullscreenElement",
].find((m) => document && m in document) as "fullscreenElement" | undefined;

const isSupported = $derived(
!!(target && document && requestMethod && exitMethod && fullscreenEnabled)
);

const isCurrentElementFullScreen = (): boolean => {
if (fullscreenElementMethod) return document?.[fullscreenElementMethod] === target;
return false;
};

const isElementFullScreen = (): boolean => {
if (fullscreenEnabled) {
if (document && document[fullscreenEnabled] != null) {
return document[fullscreenEnabled];
} else {
// @ts-expect-error - Fallback for WebKit and iOS Safari browsers
if (target?.[fullscreenEnabled] != null) {
// @ts-expect-error - Fallback for WebKit and iOS Safari browsers
return Boolean(target[fullscreenEnabled]);
}
}
}
return false;
};

async function exit() {
if (!isSupported || !isFullscreen) return;
if (exitMethod) {
if (document?.[exitMethod] != null) {
await document[exitMethod]();
} else {
// @ts-expect-error - Fallback for Safari iOS
if (target?.[exitMethod] != null)
// @ts-expect-error - Fallback for Safari iOS
await target[exitMethod]();
}
}

isFullscreen = false;
}

async function enter() {
if (!isSupported || isFullscreen) return;

if (isElementFullScreen()) await exit();

if (requestMethod && target?.[requestMethod] != null) {
await target[requestMethod]();
isFullscreen = true;
}
}

async function toggle() {
await (isFullscreen ? exit() : enter());
}

const handlerCallback = () => {
const isElementFullScreenValue = isElementFullScreen();
if (!isElementFullScreenValue || (isElementFullScreenValue && isCurrentElementFullScreen()))
isFullscreen = isElementFullScreenValue;
};

const listenerOptions = { capture: false, passive: true };
useEventListener(document, eventHandlers, handlerCallback, listenerOptions);
useEventListener(() => target, eventHandlers, handlerCallback, listenerOptions);

$effect(() => {
handlerCallback();

return () => {
if (autoExit) {
exit();
}
};
});

return {
get isSupported() {
return isSupported;
},
get isFullscreen() {
return isFullscreen;
},
enter,
exit,
toggle,
};
}
Loading