Package Exports

use-ssr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (use-ssr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

useSSR

☯️ React hook to determine if you are on the server or browser

Need to know when you're on the server or in the browser in your components? This simple hook makes it easy. 🔥

Features

SSR (server side rendering) support
TypeScript support
Zero dependencies

Examples

Example - Next.js - codesandbox container (sometimes containers are buggy, if so try this example)

Installation

yarn add use-ssr      or     npm i -S use-ssr

Usage

import useSSR from 'use-ssr'

const App = () => {
  var { isBrowser, isServer } = useSSR()
  
  // Want array destructuring? You can do that too!
  var [isBrowser, isServer] = useSSR()
  
  /*
   * In your browser's chrome devtools console you should see
   * > IS BROWSER: 👍
   * > IS SERVER: 👎
   *
   * AND, in your terminal where your server is running you should see
   * > IS BROWSER: 👎
   * > IS SERVER: 👍
   */
  console.log('IS BROWSER: ', isBrowser ? '👍' : '👎')
  console.log('IS SERVER: ', isServer ? '👍' : '👎')
  return (
    <>
      Is in browser? {isBrowser ? '👍' : '👎'}
      <br />
      Is on server? {isServer ? '👍' : '👎'}
    </>
  )
}

Options

const {
  isBrowser,
  isServer,
  canUseWorkers,
  canUseEventListeners,
  canUseViewport,
} = useSSR()
// OR
const [
  isBrowser,
  isServer,
  canUseWorkers,
  canUseEventListeners,
  canUseViewport,
] = useSSR()

Todos

tests
optimize badges see awesome badge list
codesandbox examples
continuous integration
greenkeeper