useFullscreen
Display an element full-screen.
Usage
import { useFullscreen } from "@reactuses/core";
import { useRef } from "react";
const Demo = () => {
const ref = useRef(null);
const [isFullscreen, { enterFullscreen, exitFullscreen, toggleFullscreen }]
= useFullscreen(ref);
return (
<div ref={ref}>
<div style={{ marginBottom: 16 }}>
{isFullscreen ? "Fullscreen" : "Not fullscreen"}
</div>
<div>
<button type="button" onClick={enterFullscreen}>
enterFullscreen
</button>
<button
type="button"
onClick={exitFullscreen}
style={{ margin: "0 8px" }}
>
exitFullscreen
</button>
<button type="button" onClick={toggleFullscreen}>
toggleFullscreen
</button>
</div>
</div>
);
};
Example
Not fullscreen
Type Declarations
export interface UseFullScreenOptions {
onExit?: () => void
onEnter?: () => void
}
export default function useFullscreen(
target: BasicTarget,
options?: UseFullScreenOptions
): readonly [
boolean,
{
readonly enterFullscreen: () => void
readonly exitFullscreen: () => void
readonly toggleFullscreen: () => void
readonly isEnabled: boolean
}
]