@integreat-app/react-sticky-headroom 1.1.0 → 1.2.2

package/README.md

@@ -27,16 +27,16 @@ render () {
 
 ## Demo
 
-Go to [https://integreat.github.io/react-sticky-headroom/](https://integreat.github.io/react-sticky-headroom/) to view a demo:
+Go to [https://digitalfabrik.github.io/react-sticky-headroom/](https://digitalfabrik.github.io/react-sticky-headroom/) to view a demo:
 
-[![Demo](https://raw.githubusercontent.com/Integreat/react-sticky-headroom/main/demo.gif)](https://integreat.github.io/react-sticky-headroom/)
+[![Demo](https://raw.githubusercontent.com/digitalfabrik/react-sticky-headroom/main/demo.gif)](https://digitalfabrik.github.io/react-sticky-headroom/)
 
 
 ## API
 You can pass the following props to ReactStickyHeadroom:
 * `children: React.Node` The header component, that should be hidden and revealed
 * `scrollHeight: number` The maximum amount of px the header should move up when scrolling
-* `pinStart: number` The minimum scrollTop position where the transform should start
+* `pinStart: number` (Default: `0`) The minimum scrollTop position where the transform should start
 * `height?: number` (Optional) The height of the `children` node. Used for calculating the stickyTop position for a sticky ancestor in `onStickyTopChanged`
 * `onStickyTopChanged?: (number) => void` Fired, when Headroom changes its state and `height` is provided. Passes the calculated stickyTop position of an ancestor node.
 * `positionStickyDisabled?: boolean` (Optional, Default: `false`) If true, the header will stay static (e.g. for edge 16 support)
@@ -45,10 +45,6 @@ You can pass the following props to ReactStickyHeadroom:
 * `className?: string` (Optional) A classname for applying custom styles to the wrapper. Use at your own risk.
 
 
-Edge 16 has had issues with css property `position: sticky` together with `direction: rtl`.
-This has been fixed in Edge 17.
-If you need Edge 16 as well as right-to-left support, you should use `positionStickyDisabled: true`, when detecting Edge 16.
-
 ## Support
 The component generally supports:
 * Internet Explorer 11
@@ -61,4 +57,6 @@ For hiding and revealing the header, the browser needs to support the css-proper
 You can read about the browser support for that on [caniuse.com](https://caniuse.com/#feat=css-sticky).
 'Partial-Support' is enough for ReactStickyHeadroom to work in most cases.
 
+ReactStickyHeadroom offers types for both TypeScript and FlowJS which should work out of the box.
+
 If there are any problems, please don't hesitate to open an issue on GitHub.

package/index.d.ts

@@ -0,0 +1,18 @@
+import React, { ReactNode } from 'react'
+
+declare type PropsType = {
+    children: ReactNode,
+    scrollHeight: number,
+    pinStart?: number,
+    height?: number,
+    onStickyTopChanged?: (number) => void,
+    positionStickyDisabled?: boolean,
+    parent?: HTMLElement,
+    zIndex?: number,
+    className?: string
+}
+
+declare class Headroom extends React.Component<PropsType> {
+}
+
+export default Headroom

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -11,27 +11,27 @@ var React = _interopRequireWildcard(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
 
 function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
 
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
@@ -134,11 +134,11 @@ var Headroom = /*#__PURE__*/function (_React$PureComponent) {
 
   _createClass(Headroom, [{
     key: "getScrollTop",
-
+    value:
     /**
      * @returns {number} the current scrollTop position of the window
      */
-    value: function getScrollTop() {
+    function getScrollTop() {
       var parent = this.props.parent;
 
       if (parent && parent.scrollTop !== undefined && parent !== document.documentElement) {

package/index.js.flow

@@ -20,7 +20,7 @@ type ModeType = 'pinned' | 'unpinned' | 'static'
 type DirectionType = 'up' | 'down'
 type TransitionType = 'none' | 'normal' | 'pinned-to-static'
 
-type PropsType = {|
+type PropsType = $ReadOnly<{|
   /** The child node to be displayed as a header */
   children: Node,
   /** The maximum amount of px the header should move up when scrolling */
@@ -39,13 +39,13 @@ type PropsType = {|
   zIndex?: number,
   /** A classname for applying custom styles to the wrapper. Use at your own risk. */
   className?: string
-|}
+|}>
 
-type StateType = {|
+type StateType = $ReadOnly<{|
   mode: ModeType,
   transition: TransitionType,
   animateUpFrom: ?number
-|}
+|}>
 
 const HeaderWrapper: StyledComponent<{|
   positionStickyDisabled: boolean,
@@ -61,10 +61,13 @@ const HeaderWrapper: StyledComponent<{|
   animation-duration: 0.2s;
   animation-timing-function: ease-out;
   ${props => props.transition === NORMAL_TRANSITION && !props.static
-    ? 'transition: transform 0.2s ease-out;' : ''}
-  ${props => props.transition === PINNED_TO_STATIC ? css`
+  ? 'transition: transform 0.2s ease-out;'
+  : ''}
+  ${props => props.transition === PINNED_TO_STATIC
+  ? css`
     animation-name: ${keyframesMoveUpFrom(props.animateUpFrom)};
-  ` : ''}
+  `
+  : ''}
   ${props => props.static ? 'transition: none;' : ''}
 `
 
@@ -85,7 +88,11 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
     parent: window.document.documentElement
   }
 
-  state: StateType = { mode: STATIC, transition: NO_TRANSITION, animateUpFrom: null }
+  state: StateType = {
+    mode: STATIC,
+    transition: NO_TRANSITION,
+    animateUpFrom: null
+  }
 
   /** the very last scrollTop which we know about (to determine direction changes) */
   lastKnownScrollTop: number = 0
@@ -158,7 +165,7 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
    */
   shouldSetStatic (scrollTop: number, direction: DirectionType): boolean {
     if (this.state.mode === STATIC || (this.state.mode === PINNED && direction ===
-        DOWNWARDS)) {
+      DOWNWARDS)) {
       return this.props.pinStart + this.props.scrollHeight >= scrollTop
     } else {
       return this.props.pinStart >= scrollTop
@@ -182,8 +189,7 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
   /**
    * @returns {TransitionType} determines the kind of transition
    */
-  determineTransition (mode: ModeType,
-    direction: DirectionType): TransitionType {
+  determineTransition (mode: ModeType, direction: DirectionType): TransitionType {
     // Handle special case: If we're pinned and going to static, we need a special transition using css animation
     if (this.state.mode === PINNED && mode === STATIC) {
       return PINNED_TO_STATIC
@@ -191,12 +197,14 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
     // If mode is static, then no transition, because we're already in the right spot
     // (and want to change transform and top properties seamlessly)
     if (mode === STATIC) {
-      return this.state.transition === NO_TRANSITION ? NO_TRANSITION
+      return this.state.transition === NO_TRANSITION
+        ? NO_TRANSITION
         : PINNED_TO_STATIC
     }
     // mode is not static, transition when moving upwards or when we've lastly did the transition
     return direction === UPWARDS || this.state.transition === NORMAL_TRANSITION
-      ? NORMAL_TRANSITION : NO_TRANSITION
+      ? NORMAL_TRANSITION
+      : NO_TRANSITION
   }
 
   /**
@@ -208,12 +216,18 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
     if (currentScrollTop === this.lastKnownScrollTop) {
       return
     }
-    const direction = this.lastKnownScrollTop < currentScrollTop ? DOWNWARDS
+    const direction = this.lastKnownScrollTop < currentScrollTop
+      ? DOWNWARDS
       : UPWARDS
     newState.mode = this.determineMode(currentScrollTop, direction)
     newState.transition = this.determineTransition(newState.mode, direction)
 
-    const { onStickyTopChanged, height, scrollHeight, pinStart } = this.props
+    const {
+      onStickyTopChanged,
+      height,
+      scrollHeight,
+      pinStart
+    } = this.props
     if (this.state.mode === PINNED && newState.mode === STATIC) {
       // animation in the special case from pinned to static
       newState.animateUpFrom = currentScrollTop - pinStart
@@ -245,7 +259,11 @@ class Headroom extends React.PureComponent<PropsType, StateType> {
       zIndex,
       className
     } = this.props
-    const { mode, transition, animateUpFrom } = this.state
+    const {
+      mode,
+      transition,
+      animateUpFrom
+    } = this.state
     const transform = mode === UNPINNED ? -scrollHeight : 0
     const ownStickyTop = mode === STATIC ? -scrollHeight : 0
     return <HeaderWrapper

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@integreat-app/react-sticky-headroom",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "engines": {
     "node": ">=6.9",
     "npm": ">=3.8"
@@ -18,7 +18,8 @@
   "repository": "https://github.com/integreat/react-sticky-headroom",
   "files": [
     "index.js",
-    "index.js.flow"
+    "index.js.flow",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"
@@ -29,7 +30,9 @@
     "react",
     "hide",
     "header",
-    "styled-components"
+    "styled-components",
+    "typescript",
+    "flow"
   ],
   "module": "index.js",
   "scripts": {
@@ -48,60 +51,63 @@
     "prepublishOnly": "yarn build && yarn build:demo && yarn test && yarn lint && yarn flow:check-now"
   },
   "peerDependencies": {
-    "react": "16.x.x || 17.x.x",
+    "react": "16.x.x || 17.x.x || 18.x.x",
     "styled-components": "4.x.x || 5.x.x"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-do-expressions": "^7.8.3",
-    "@babel/plugin-proposal-export-default-from": "^7.8.3",
-    "@babel/plugin-proposal-export-namespace-from": "^7.8.3",
-    "@babel/plugin-proposal-json-strings": "^7.8.3",
-    "@babel/plugin-proposal-logical-assignment-operators": "^7.8.3",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.8.3",
-    "@babel/plugin-proposal-numeric-separator": "^7.8.3",
-    "@babel/plugin-proposal-optional-chaining": "^7.9.0",
-    "@babel/plugin-proposal-pipeline-operator": "^7.8.3",
-    "@babel/plugin-proposal-throw-expressions": "^7.8.3",
+    "@babel/cli": "^7.17.6",
+    "@babel/core": "^7.17.8",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-do-expressions": "^7.16.7",
+    "@babel/plugin-proposal-export-default-from": "^7.16.7",
+    "@babel/plugin-proposal-export-namespace-from": "^7.16.7",
+    "@babel/plugin-proposal-json-strings": "^7.16.7",
+    "@babel/plugin-proposal-logical-assignment-operators": "^7.16.7",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7",
+    "@babel/plugin-proposal-numeric-separator": "^7.16.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
+    "@babel/plugin-proposal-pipeline-operator": "^7.17.6",
+    "@babel/plugin-proposal-throw-expressions": "^7.16.7",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-import-meta": "^7.8.3",
-    "@babel/plugin-transform-react-jsx": "^7.9.4",
-    "@babel/plugin-transform-runtime": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
-    "@babel/preset-flow": "^7.9.0",
-    "@babel/preset-react": "^7.9.4",
-    "@babel/runtime": "^7.9.2",
-    "@integreat-app/eslint-config-babel": "^0.6.0",
-    "@integreat-app/eslint-config-flow": "^0.6.0",
-    "@integreat-app/eslint-config-jest": "^0.6.0",
-    "@integreat-app/eslint-config-node": "^0.6.0",
-    "@integreat-app/eslint-config-react": "^0.6.1",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-eslint": "^10.1.0",
-    "babel-jest": "^26.6.3",
-    "babel-loader": "^8.1.0",
-    "babel-plugin-styled-components": "^1.10.7",
+    "@babel/plugin-syntax-import-meta": "^7.10.4",
+    "@babel/plugin-transform-react-jsx": "^7.17.3",
+    "@babel/plugin-transform-runtime": "^7.17.0",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-flow": "^7.16.7",
+    "@babel/preset-react": "^7.16.7",
+    "@babel/runtime": "^7.17.8",
+    "babel-jest": "^27.5.1",
+    "babel-loader": "^8.2.4",
+    "babel-plugin-styled-components": "^2.0.6",
+    "browserslist": "^4.20.2",
     "enzyme": "^3.11.0",
-    "enzyme-adapter-react-16": "^1.15.2",
-    "enzyme-to-json": "^3.4.4",
-    "eslint": "^7.14.0",
-    "flow-bin": "~0.134.0",
+    "enzyme-adapter-react-16": "^1.15.6",
+    "enzyme-to-json": "^3.6.2",
+    "eslint": "^8.11.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-flowtype": "^8.0.3",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.1.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.29.4",
+    "flow-bin": "~0.174.1",
     "flow-copy-source": "^2.0.9",
-    "flow-typed": "^3.2.1",
-    "jest": "^26.6.3",
-    "jest-junit": "^12.0.0",
-    "jest-styled-components": "^7.0.3",
+    "flow-typed": "^3.7.0",
+    "jest": "^27.5.1",
+    "jest-junit": "^13.0.0",
+    "jest-styled-components": "^7.0.8",
     "raf": "^3.4.1",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
     "rimraf": "^3.0.2",
-    "styled-components": "^5.1.0",
-    "stylelint": "^13.8.0",
-    "stylelint-config-recommended": "^3.0.0",
+    "styled-components": "^5.3.3",
+    "stylelint": "^14.6.0",
+    "stylelint-config-recommended": "^7.0.0",
     "stylelint-config-styled-components": "^0.1.1",
     "stylelint-processor-styled-components": "^1.10.0",
-    "webpack": "^5.9.0"
-  }
+    "webpack": "^5.70.0"
+  },
+  "packageManager": "yarn@3.2.0"
 }