useFullscreen
A Hook for handling dom full screen.
API is consistent with ahooks.
Examples
Basic usage
Pass in function
API
const [isFullscreen, { setFull, exitFull, toggleFull }] = useFullScreen(target, options?:Options);
Params
| Property | Description | Type | Default |
|---|
| target | DOM element or Ref Object | HTMLElement | () => HTMLElement | |
| options | setting(optional) | Options | - |
Options
| Property | Description | Type | Default |
|---|
| onExitFull | listen for exit full screen events | ()=>void | - |
| onFull | listen for full screen events | ()=>void | - |
Result
| Property | Description | Type |
|---|
| isFullscreen | is full screen | boolean |
| setFull | set full screen | ()=>void |
| exitFull | exit full screen | ()=>void |
| toggleFull | toggle full screen | ()=>void |