focus-trap-react 8.6.0 → 8.8.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 8.8.1
+
+### Patch Changes
+
+- a2806a0: Fix SSR issues when accessing `document` object (#482)
+
+## 8.8.0
+
+### Minor Changes
+
+- c8e46c2: Support new `document` option introduced in focus-trap v6.7.0 (#460)
+- 5ee587c: Bump focus-trap dependency to v6.7.1
+
+## 8.7.1
+
+### Patch Changes
+
+- 111a27f: Update focus-trap to v6.6.1, to get tabbable at v5.2.1, to get bug fix for disabled fieldsets.
+
+## 8.7.0
+
+### Minor Changes
+
+- 7fbe8ca: Update to support new features in `focus-trap@6.6.0` including `initialFocus` which can now be false to prevent initial focus, and `escapeDeactivates` which can now alternately be a function that returns a boolean instead of a straight boolean.
+
 ## 8.6.0
 
 ### Minor Changes

package/README.md

@@ -1,7 +1,7 @@
 # focus-trap-react [![CI](https://github.com/focus-trap/focus-trap-react/workflows/CI/badge.svg?branch=master&event=push)](https://github.com/focus-trap/focus-trap-react/actions?query=workflow:CI+branch:master) [![Codecov](https://img.shields.io/codecov/c/github/focus-trap/focus-trap-react)](https://codecov.io/gh/focus-trap/focus-trap-react) [![license](https://badgen.now.sh/badge/license/MIT)](./LICENSE)
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 A React component that traps focus.
@@ -203,7 +203,9 @@ In alphabetical order:
     <td align="center"><a href="https://recollectr.io"><img src="https://avatars2.githubusercontent.com/u/6835891?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Slapbox</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/commits?author=Slapbox" title="Documentation">📖</a></td>
     <td align="center"><a href="https://stefancameron.com/"><img src="https://avatars3.githubusercontent.com/u/2855350?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stefan Cameron</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/commits?author=stefcameron" title="Code">💻</a> <a href="https://github.com/focus-trap/focus-trap-react/issues?q=author%3Astefcameron" title="Bug reports">🐛</a> <a href="#infra-stefcameron" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/focus-trap/focus-trap-react/commits?author=stefcameron" title="Tests">⚠️</a> <a href="https://github.com/focus-trap/focus-trap-react/commits?author=stefcameron" title="Documentation">📖</a> <a href="#maintenance-stefcameron" title="Maintenance">🚧</a></td>
     <td align="center"><a href="http://tylerhawkins.info/201R/"><img src="https://avatars0.githubusercontent.com/u/13806458?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tyler Hawkins</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/commits?author=thawkin3" title="Documentation">📖</a> <a href="#example-thawkin3" title="Examples">💡</a> <a href="https://github.com/focus-trap/focus-trap-react/commits?author=thawkin3" title="Tests">⚠️</a> <a href="#tool-thawkin3" title="Tools">🔧</a></td>
+    <td align="center"><a href="https://github.com/wandroll"><img src="https://avatars.githubusercontent.com/u/4492317?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wandrille Verlut</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/commits?author=wandroll" title="Code">💻</a> <a href="https://github.com/focus-trap/focus-trap-react/commits?author=wandroll" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/krikienoid"><img src="https://avatars3.githubusercontent.com/u/8528227?v=4?s=100" width="100px;" alt=""/><br /><sub><b>krikienoid</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/issues?q=author%3Akrikienoid" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/syntactic-salt"><img src="https://avatars.githubusercontent.com/u/9385662?v=4?s=100" width="100px;" alt=""/><br /><sub><b>syntactic-salt</b></sub></a><br /><a href="https://github.com/focus-trap/focus-trap-react/issues?q=author%3Asyntactic-salt" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 

package/dist/focus-trap-react.js

@@ -14,7 +14,7 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
 
 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; }
 
@@ -129,8 +129,11 @@ var FocusTrap = /*#__PURE__*/function (_React$Component) {
   }, {
     key: "updatePreviousElement",
     value: function updatePreviousElement() {
-      if (typeof document !== 'undefined') {
-        this.previouslyFocusedElement = document.activeElement;
+      // SSR: careful to check if `document` exists before accessing it as a variable
+      var currentDocument = this.props.focusTrapOptions.document || (typeof document !== 'undefined' ? document : undefined);
+
+      if (currentDocument) {
+        this.previouslyFocusedElement = currentDocument.activeElement;
       }
     }
   }, {
@@ -283,15 +286,16 @@ FocusTrap.propTypes = {
   active: PropTypes.bool,
   paused: PropTypes.bool,
   focusTrapOptions: PropTypes.shape({
+    document: PropTypes.object,
     onActivate: PropTypes.func,
     onPostActivate: PropTypes.func,
     checkCanFocusTrap: PropTypes.func,
     onDeactivate: PropTypes.func,
     onPostDeactivate: PropTypes.func,
     checkCanReturnFocus: PropTypes.func,
-    initialFocus: PropTypes.oneOfType([PropTypes.instanceOf(ElementType), PropTypes.string, PropTypes.func]),
+    initialFocus: PropTypes.oneOfType([PropTypes.instanceOf(ElementType), PropTypes.string, PropTypes.func, PropTypes.bool]),
     fallbackFocus: PropTypes.oneOfType([PropTypes.instanceOf(ElementType), PropTypes.string, PropTypes.func]),
-    escapeDeactivates: PropTypes.bool,
+    escapeDeactivates: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
     clickOutsideDeactivates: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
     returnFocusOnDeactivate: PropTypes.bool,
     setReturnFocus: PropTypes.oneOfType([PropTypes.instanceOf(ElementType), PropTypes.string, PropTypes.func]),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "focus-trap-react",
-  "version": "8.6.0",
+  "version": "8.8.1",
   "description": "A React component that traps focus.",
   "main": "dist/focus-trap-react.js",
   "types": "index.d.ts",
@@ -55,43 +55,43 @@
   },
   "homepage": "https://github.com/focus-trap/focus-trap-react#readme",
   "devDependencies": {
-    "@babel/cli": "^7.14.5",
-    "@babel/core": "^7.14.6",
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.5",
     "@babel/plugin-proposal-class-properties": "^7.12.13",
-    "@babel/preset-env": "^7.14.5",
+    "@babel/preset-env": "^7.15.6",
     "@babel/preset-react": "^7.14.5",
-    "@changesets/cli": "^2.16.0",
-    "@testing-library/cypress": "^7.0.6",
-    "@testing-library/dom": "^7.31.2",
+    "@changesets/cli": "^2.17.0",
+    "@testing-library/cypress": "^8.0.1",
+    "@testing-library/dom": "^8.5.0",
     "@testing-library/jest-dom": "^5.14.1",
-    "@testing-library/react": "^11.2.7",
-    "@testing-library/user-event": "^13.1.9",
-    "@types/jquery": "^3.5.5",
+    "@testing-library/react": "^12.1.0",
+    "@testing-library/user-event": "^13.2.1",
+    "@types/jquery": "^3.5.6",
     "all-contributors-cli": "^6.20.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^27.0.2",
+    "babel-jest": "^27.2.1",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
     "budo": "^11.6.4",
-    "cypress": "^7.5.0",
+    "cypress": "^8.4.1",
     "cypress-plugin-tab": "^1.0.5",
-    "eslint": "^7.28.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-cypress": "^2.11.3",
-    "eslint-plugin-react": "^7.24.0",
-    "jest": "^27.0.4",
+    "eslint-plugin-cypress": "^2.12.1",
+    "eslint-plugin-react": "^7.26.0",
+    "jest": "^27.2.1",
     "jest-watch-typeahead": "^0.6.4",
     "onchange": "^7.1.0",
-    "prettier": "^2.3.1",
+    "prettier": "^2.4.1",
     "prop-types": "^15.7.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
-    "regenerator-runtime": "^0.13.7",
-    "start-server-and-test": "^1.12.5",
-    "typescript": "^4.3.2"
+    "regenerator-runtime": "^0.13.9",
+    "start-server-and-test": "^1.14.0",
+    "typescript": "^4.4.3"
   },
   "dependencies": {
-    "focus-trap": "^6.5.1"
+    "focus-trap": "^6.7.1"
   },
   "peerDependencies": {
     "prop-types": "^15.7.2",

package/src/focus-trap-react.js

@@ -87,8 +87,12 @@ class FocusTrap extends React.Component {
 
   /** Update the previously focused element with the currently focused element. */
   updatePreviousElement() {
-    if (typeof document !== 'undefined') {
-      this.previouslyFocusedElement = document.activeElement;
+    // SSR: careful to check if `document` exists before accessing it as a variable
+    const currentDocument =
+      this.props.focusTrapOptions.document ||
+      (typeof document !== 'undefined' ? document : undefined);
+    if (currentDocument) {
+      this.previouslyFocusedElement = currentDocument.activeElement;
     }
   }
 
@@ -241,6 +245,7 @@ FocusTrap.propTypes = {
   active: PropTypes.bool,
   paused: PropTypes.bool,
   focusTrapOptions: PropTypes.shape({
+    document: PropTypes.object,
     onActivate: PropTypes.func,
     onPostActivate: PropTypes.func,
     checkCanFocusTrap: PropTypes.func,
@@ -251,13 +256,14 @@ FocusTrap.propTypes = {
       PropTypes.instanceOf(ElementType),
       PropTypes.string,
       PropTypes.func,
+      PropTypes.bool,
     ]),
     fallbackFocus: PropTypes.oneOfType([
       PropTypes.instanceOf(ElementType),
       PropTypes.string,
       PropTypes.func,
     ]),
-    escapeDeactivates: PropTypes.bool,
+    escapeDeactivates: PropTypes.oneOfType([PropTypes.bool, PropTypes.func]),
     clickOutsideDeactivates: PropTypes.oneOfType([
       PropTypes.bool,
       PropTypes.func,