@helpscout/react-utils

Handy utilities for React

Usage no npm install needed!

<script type="module">
  import helpscoutReactUtils from 'https://cdn.skypack.dev/@helpscout/react-utils';
</script>

README

🌀 React Utils

npm version Build Status Coverage Status npm version node npm

A collection of handy utilities for React.

Table of contents

🔧 Installation

npm install --save @helpscout/react-utils

This library has a peerDependencies listing of react (version 15 or 16).

🕹 Usage

This library comes with a handful of useful functions. Below is an example of how you can use the getDocumentFromComponent function to retrieve the actual document the component is mounted to (rather than assuming window.document).

import React from 'react'
import getDocumentFromComponent from '@helpscout/react-utils/dist/getDocumentFromComponent'

class Napoleon extends React.Component {
  ...
  componentDidMount () {
    this.doc = getDocumentFromComponent(this)
    // document
  }
  ...
}

Check out the documentation for more details.