🌀React Utils: Handy utilities for React
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook
docs
scripts
src
stories
.babelrc
.eslintignore
.eslintrc
.gitignore
.npmignore
.nvmrc
.prettierignore
.prettierrc.yml
.travis.yml
LICENSE
README.md
SUMMARY.md
jest.config.js
package-lock.json
package.json
tsconfig.json

README.md

🌀 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.