{"_id":"@bro95-hooks/use-fullscreen","name":"@bro95-hooks/use-fullscreen","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bro95-hooks/use-fullscreen","version":"1.0.0","description":"React Hook to make any element go Fullscreen","main":"index.js","repository":{"type":"git","url":"git+https://github.com/kimbro95/React-Hooks.git#main"},"keywords":["react","hooks","fullscreen"],"author":{"name":"kimbro95"},"license":"MIT","bugs":{"url":"https://github.com/kimbro95/React-Hooks/tree/main/hooks/useFullScreen/issues"},"homepage":"https://github.com/kimbro95/React-Hooks/tree/main/hooks/useFullScreen#readme","peerDependencies":{"react":"^18.1.0","react-dom":"^18.1.0"},"gitHead":"8472da7485711c738a31944a4bf68f59682c5da2","_id":"@bro95-hooks/use-fullscreen@1.0.0","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-IeKz67kccPQyq+/1Ir1ckvm1pa2fOnBBkmGkkmEEnlEylbOILLMuSuh0TzGPgLAyylbYK1BozBOMwgtG2VhSwg==","shasum":"b7f9846657880759a44fa64495479a34ad838416","tarball":"https://registry.npmjs.org/@bro95-hooks/use-fullscreen/-/use-fullscreen-1.0.0.tgz","fileCount":4,"unpackedSize":2895,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBPGF4h6RvdFGhZCHyyXcJgfrYmM/X5EMWqukEZg9952AiANn6jz2E9nl0x1o5uiUdNWV5xLnR5B9QD5qM/TtOj7wA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiqBXUACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqQ3g/9H2Z71IyOitjR0PGv78tVjzr0kMFUkvLIW8fgOwFpsJG/KnMa\r\nv4wRSuvFXtkEYG2ANKrLTczATTPhOpmfXVtkYK1txTHNT+lvs4uFkDkRCyJR\r\nU4OhDXCSLeYW/8pyxpn9KTyMzWe5Zq6wLvcSwjb4dGuVoqLrDVNH4FB0nnSI\r\nbibQPrAS24A8LhHQBmLcSh8UHg+9pZoNEoL2hfbQkg8tRsq0bUs8sSuWSRct\r\nJhudqYbTX26mZszUqXt7Mv0JWvUY4utTESkHI9P3dp49L+iDGAv5hmUx4Tvd\r\n95riAH3BSwoKuBM6LYaItRHRrSjAULVarQqniuGn0gILObrlscFF9EUrfzj0\r\nEmDm3HKqo4CKoB8lR+5u0d2dz1YjaCApVTcvCIPcV1Qbt4gB49/CmfmRqVfC\r\nKghc2iiSmIRKsqbjZB2pilC6C/+ogx7+zqA6BFJF3ppbmbL8Glm/QZesk6ol\r\noIFIs6QHud1vb2jlMTwUiKI8F5srOztxpvU20Nn8os6HLxTbHPOrUDXWyfRN\r\nxjnqey945DzuutxfUuoVkPeegEY/pcXDrdhIqk7x3LAj2RVrR1zBnNiSe2ja\r\nuANeuqcEYh4/2mQtVd1LY2neOeVFNudkIIUnpanx5Lmgajtf9qVIJ7jeB0AQ\r\nP8pxs+NeXXSf/0GrnsUwcbcWX8GFOEQ5Pn8=\r\n=/X6D\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"kimbro95","email":"gudgudgud714@naver.com"},"directories":{},"maintainers":[{"name":"kimbro95","email":"gudgudgud714@naver.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-fullscreen_1.0.0_1655182803843_0.06751625665774652"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-14T05:00:03.793Z","1.0.0":"2022-06-14T05:00:04.051Z","modified":"2022-06-14T05:00:04.207Z"},"maintainers":[{"name":"kimbro95","email":"gudgudgud714@naver.com"}],"description":"React Hook to make any element go Fullscreen","homepage":"https://github.com/kimbro95/React-Hooks/tree/main/hooks/useFullScreen#readme","keywords":["react","hooks","fullscreen"],"repository":{"type":"git","url":"git+https://github.com/kimbro95/React-Hooks.git#main"},"author":{"name":"kimbro95"},"bugs":{"url":"https://github.com/kimbro95/React-Hooks/tree/main/hooks/useFullScreen/issues"},"license":"MIT","readme":"# @bro95-hooks/use-fullscreen\r\n\r\n📌React Hook to make any element go Fullscreen\r\n\r\n## Installation\r\n\r\n#### npm\r\n\r\n`npm i @bro95-hooks/use-fullscreen`\r\n\r\n## Usage\r\n\r\n```js\r\nimport React from \"react\";\r\nimport useFullscreen from \"@bro95-hooks/use-fullscreen\";\r\n\r\nfunction App() {\r\n  const onChange = isFull =>\r\n    console.log(isFull ? \"We are in Fullscreen\" : \"We are not in Fullscreen\");\r\n  const { element, triggerFull, exitFull } = useFullscreen(onChange);\r\n  return (\r\n    <div ref={element}>\r\n      <h1>Hello</h1>\r\n      <button onClick={triggerFull}>Make this Fullscreen</button>\r\n      <button onClick={exitFull}>Exit Fullscreen</button>\r\n    </div>\r\n  );\r\n}\r\n```\r\n\r\n### Arguments\r\n\r\n| Argument | Type     | Description                                                       | Arguments        | Required |\r\n| -------- | -------- | ----------------------------------------------------------------- | ---------------- | -------- |\r\n| onChange | function | Function to be called when the screen goes Fullscreen or exits is | isFull : Boolean | no       |\r\n\r\n### Return\r\n\r\n`useFullscreen` returns an object containing the following:\r\n\r\n| Return value | Type      | Description                                                |\r\n| ------------ | --------- | ---------------------------------------------------------- |\r\n| element      | React Ref | Ref to add to the element that you want to make fullscreen |\r\n| triggerFull  | Function  | Function to make the element enter fullscreen              |\r\n| exitFull     | Function  | Function to make the document exit fullscreen              |","readmeFilename":"README.md"}