# @lchooks/use-fullscreen

> React Hook to update your document's title

Latest version **1.0.1** (published 2020-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lchooks/use-fullscreen
pnpm add @lchooks/use-fullscreen
yarn add @lchooks/use-fullscreen
bun add @lchooks/use-fullscreen
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-02-12 |
| First published | 2020-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Changho Lee |
| Maintainers | nnagman |
| Keywords | react, hooks, title |

## Links

- npm: https://www.npmjs.com/package/@lchooks/use-fullscreen
- Repository: https://github.com/Nnagman/looks
- Homepage: https://github.com/Nnagman/looks#readme
- Issues: https://github.com/Nnagman/looks/issues
- npm.io page: https://npm.io/package/@lchooks/use-fullscreen

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-02-12
- 1.0.0 — 2020-02-11

## README

# @lchooks/use-fullscreen

React Hook to make any element go Fullscreen

노마드코더 수업을 들으면서 클론코딩했습니다.
Thank you nomadcoders!!
https://academy.nomadcoders.co/p/introduction-to-react-hooks

## Installation

#### yarn

`yarn add @lchooks/use-fullscreen`

#### npm

`npm i @lchooks/use-fullscreen`

## Usage

```js
import React from "react";
import useFullscreen from "@lchooks/use-fullscreen";

function App() {
  const onChange = isFull =>
    console.log(isFull ? "Nomadcoders are in Fullscreen" : "Nomadcoders are not in Fullscreen");
  const { element, triggerFull, exitFull } = useFullscreen(onChange);
  return (
    <div ref={element}>
      <h1>Hello</h1>
      <button onClick={triggerFull}>Make this Fullscreen</button>
      <button onClick={exitFull}>Exit Fullscreen</button>
    </div>
  );
}
```

### Arguments

| Argument | Type     | Description                                                       | Arguments        | Required |
| -------- | -------- | ----------------------------------------------------------------- | ---------------- | -------- |
| onChange | function | Function to be called when the screen goes Fullscreen or exits is | isFull : Boolean | no       |

### Return

`useFullscreen` returns an object containing the following:

| Return value | Type      | Description                                                |
| ------------ | --------- | ---------------------------------------------------------- |
| element      | React Ref | Ref to add to the element that you want to make fullscreen |
| triggerFull  | Function  | Function to make the element enter fullscreen              |
| exitFull     | Function  | Function to make the document exit fullscreen              |

---
_Source: https://npm.io/package/@lchooks/use-fullscreen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._