diff --git a/README.md b/README.md index c6fc390..196c373 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# React Scroll Trigger +# react-scroll-trigger React component that monitors `scroll` events to trigger callbacks when it enters, exits and progresses through the viewport. All callback include the `progress` and @@ -8,25 +8,20 @@ those values. ## Install Via [npm](https://npmjs.com/package/react-scroll-trigger) -``` + +```sh npm install react-scroll-trigger ``` Via [Yarn](http://yarn.fyi/react-scroll-trigger) -``` + +```sh yarn add react-scroll-trigger ``` -### Requirements - -* [react](https://npmjs.com/package/react) -* [react-dom](https://npmjs.com/package/react-dom) -* [prop-types](https://npmjs.com/package/prop-types) -* [lodash](https://npmjs.com/package/lodash) - ## How to use -``` +```js import ScrollTrigger from 'react-scroll-trigger'; ... @@ -59,14 +54,14 @@ import ScrollTrigger from 'react-scroll-trigger'; The `ScrollTrigger` is intended to be used as a composable element, allowing you to either use it standalone within a page (ie. no children). -``` +```js ``` Or, pass in children to receive events and `progress` based on the dimensions of those elements within the DOM. -``` +```js [...list items...] diff --git a/package.json b/package.json index 2c298ed..aab04e0 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,9 @@ "repository": "ryanhefner/react-scroll-trigger", "author": "Ryan Hefner (https://www.ryanhefner.com)", "files": [ - "index.js", "es", + "index.js", + "src", "umd" ], "directories": { @@ -31,6 +32,7 @@ }, "dependencies": { "clean-react-props": "^0.1.1", + "lodash.omit": "^4.5.0", "lodash.throttle": "^4.1.1", "prop-types": "^15.5.10", "react-dom": "^15.6.1" diff --git a/src/index.js b/src/index.js index 35033dd..4a7de69 100644 --- a/src/index.js +++ b/src/index.js @@ -1,6 +1,7 @@ import React, {Component} from 'react'; import PropTypes from 'prop-types'; import ReactDOM from 'react-dom'; +import omit from 'lodash.omit'; import throttle from 'lodash.throttle'; import cleanProps from 'clean-react-props'; @@ -125,7 +126,7 @@ class ScrollTrigger extends Component { return (
{ this.element = element; }} diff --git a/yarn.lock b/yarn.lock index 21ef515..d10ff2a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1948,6 +1948,10 @@ locate-path@^2.0.0: p-locate "^2.0.0" path-exists "^3.0.0" +lodash.omit@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.omit/-/lodash.omit-4.5.0.tgz#6eb19ae5a1ee1dd9df0b969e66ce0b7fa30b5e60" + lodash.throttle@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/lodash.throttle/-/lodash.throttle-4.1.1.tgz#c23e91b710242ac70c37f1e1cda9274cc39bf2f4"