react-use/docs/useFullscreen.md
2019-07-17 08:54:01 +02:00

30 lines
694 B
Markdown

# `useFullscreen`
Display an element full-screen, optional fallback for fullscreen video on iOS.
## Usage
```jsx
import {useFullscreen, useToggle} from 'react-use';
const Demo = () => {
const ref = useRef(null)
const [show, toggle] = useToggle(false);
const isFullscreen = useFullscreen(ref, show, {onClose: () => toggle(false)});
return (
<div ref={ref} style={{backgroundColor: 'white'}}>
<div>{isFullscreen ? 'Fullscreen' : 'Not fullscreen'}</div>
<button onClick={() => toggle()}>Toggle</button>
<video src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4" autoPlay />
</div>
);
};
```
## Reference
```ts
useFullscreen(ref, show, {onClose})
```