@instructure/ui-focusable 8.8.1-snapshot.8 → 8.9.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.9.1](https://github.com/instructure/instructure-ui/compare/v8.9.0...v8.9.1) (2021-09-16)
+
+**Note:** Version bump only for package @instructure/ui-focusable
+
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+**Note:** Version bump only for package @instructure/ui-focusable
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 **Note:** Version bump only for package @instructure/ui-focusable

package/es/Focusable/index.js

@@ -22,9 +22,9 @@
  * SOFTWARE.
  */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { addInputModeListener, addEventListener, containsActiveElement, findFocusable } from '@instructure/ui-dom-utils';
 import { logWarn as warn } from '@instructure/console';
+import { propTypes, allowedProps } from './props';
 
 /**
 ---
@@ -230,23 +230,10 @@ class Focusable extends Component {
 }
 
 Focusable.displayName = "Focusable";
-Focusable.propTypes = {
-  /**
-   * @param {Object} renderProps
-   * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
-   * @param {HTMLElement} renderProps.focusable - The focusable element
-   * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
-   */
-  children: PropTypes.func,
-
-  /**
-   * Identical to children
-   */
-  render: PropTypes.func
-};
+Focusable.propTypes = propTypes;
+Focusable.allowedProps = allowedProps;
 Focusable.defaultProps = {
-  children: null,
-  render: void 0
+  children: null
 };
 Focusable.inputTypes = {
   text: true,

package/{src/Focusable/types.ts → es/Focusable/props.js}

@@ -21,7 +21,20 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+import PropTypes from 'prop-types';
+const propTypes = {
+  /**
+   * @param {Object} renderProps
+   * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
+   * @param {HTMLElement} renderProps.focusable - The focusable element
+   * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
+   */
+  children: PropTypes.func,
 
-export type FocusableProps = {
-  render?: (...args: any[]) => any
-}
+  /**
+   * Identical to children
+   */
+  render: PropTypes.func
+};
+const allowedProps = ['children', 'render'];
+export { propTypes, allowedProps };

package/lib/Focusable/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,8 +7,6 @@ exports.Focusable = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _addInputModeListener = require("@instructure/ui-dom-utils/lib/addInputModeListener.js");
 
 var _addEventListener = require("@instructure/ui-dom-utils/lib/addEventListener.js");
@@ -21,6 +17,8 @@ var _findFocusable = require("@instructure/ui-dom-utils/lib/findFocusable.js");
 
 var _console = require("@instructure/console");
 
+var _props = require("./props");
+
 /*
  * The MIT License (MIT)
  *
@@ -250,23 +248,10 @@ class Focusable extends _react.Component {
 
 exports.Focusable = Focusable;
 Focusable.displayName = "Focusable";
-Focusable.propTypes = {
-  /**
-   * @param {Object} renderProps
-   * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
-   * @param {HTMLElement} renderProps.focusable - The focusable element
-   * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
-   */
-  children: _propTypes.default.func,
-
-  /**
-   * Identical to children
-   */
-  render: _propTypes.default.func
-};
+Focusable.propTypes = _props.propTypes;
+Focusable.allowedProps = _props.allowedProps;
 Focusable.defaultProps = {
-  children: null,
-  render: void 0
+  children: null
 };
 Focusable.inputTypes = {
   text: true,

package/lib/Focusable/props.js

@@ -0,0 +1,51 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const propTypes = {
+  /**
+   * @param {Object} renderProps
+   * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
+   * @param {HTMLElement} renderProps.focusable - The focusable element
+   * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
+   */
+  children: _propTypes.default.func,
+
+  /**
+   * Identical to children
+   */
+  render: _propTypes.default.func
+};
+exports.propTypes = propTypes;
+const allowedProps = ['children', 'render'];
+exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-focusable",
-  "version": "8.8.1-snapshot.8+7b83164f4",
+  "version": "8.9.1",
   "description": "A utility used to identify when an element receives focus.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,16 +24,16 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.8+7b83164f4"
+    "@instructure/ui-babel-preset": "8.9.1",
+    "@instructure/ui-test-utils": "8.9.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-dom-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-view": "8.8.1-snapshot.8+7b83164f4",
+    "@instructure/console": "8.9.1",
+    "@instructure/ui-dom-utils": "8.9.1",
+    "@instructure/ui-react-utils": "8.9.1",
+    "@instructure/ui-utils": "8.9.1",
+    "@instructure/ui-view": "8.9.1",
     "prop-types": "^15"
   },
   "peerDependencies": {
@@ -42,6 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "7b83164f4c5872f3a217e010563f59bf584ae4fc"
+  "sideEffects": false
 }

package/src/Focusable/index.tsx

@@ -23,7 +23,6 @@
  */
 
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import {
   addInputModeListener,
@@ -32,7 +31,9 @@ import {
   findFocusable
 } from '@instructure/ui-dom-utils'
 import { logWarn as warn } from '@instructure/console'
-import { FocusableProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FocusableProps } from './props'
 
 /**
 ---
@@ -40,23 +41,10 @@ category: components/utilities
 ---
 **/
 class Focusable extends Component<FocusableProps> {
-  static propTypes = {
-    /**
-     * @param {Object} renderProps
-     * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
-     * @param {HTMLElement} renderProps.focusable - The focusable element
-     * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
-     */
-    children: PropTypes.func,
-    /**
-     * Identical to children
-     */
-    render: PropTypes.func
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
-    children: null,
-    render: undefined
+    children: null
   }
 
   static inputTypes = {

package/src/Focusable/props.ts

@@ -0,0 +1,56 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import type { PropValidators } from '@instructure/shared-types'
+import PropTypes from 'prop-types'
+
+type FocusableOwnProps = {
+  children?: (...args: any[]) => any
+  render?: (...args: any[]) => any
+}
+
+type PropKeys = keyof FocusableOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FocusableProps = FocusableOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * @param {Object} renderProps
+   * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
+   * @param {HTMLElement} renderProps.focusable - The focusable element
+   * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
+   */
+  children: PropTypes.func,
+  /**
+   * Identical to children
+   */
+  render: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = ['children', 'render']
+
+export type { FocusableProps }
+export { propTypes, allowedProps }

package/src/index.ts

@@ -22,4 +22,4 @@
  * SOFTWARE.
  */
 export { Focusable } from './Focusable'
-export type { FocusableProps } from './Focusable/types'
+export type { FocusableProps } from './Focusable/props'

package/types/Focusable/index.d.ts

@@ -1,28 +1,21 @@
 import { Component } from 'react';
-import PropTypes from 'prop-types';
-import { FocusableProps } from './types';
+import type { FocusableProps } from './props';
 /**
 ---
 category: components/utilities
 ---
 **/
 declare class Focusable extends Component<FocusableProps> {
-    static propTypes: {
-        /**
-         * @param {Object} renderProps
-         * @param {Boolean} renderProps.focused - Is the element focused (via keyboard only)?
-         * @param {HTMLElement} renderProps.focusable - The focusable element
-         * @param {Boolean} renderProps.focusVisible - Whether the focus state should be visible or not
-         */
-        children: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * Identical to children
-         */
-        render: PropTypes.Requireable<(...args: any[]) => any>;
-    };
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        children?: ((...args: any[]) => any) | undefined;
+        render?: ((...args: any[]) => any) | undefined;
+    }>;
+    static allowedProps: readonly (keyof {
+        children?: ((...args: any[]) => any) | undefined;
+        render?: ((...args: any[]) => any) | undefined;
+    })[];
     static defaultProps: {
         children: null;
-        render: undefined;
     };
     static inputTypes: {
         text: boolean;

package/types/Focusable/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Focusable/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,SAAS,MAAM,YAAY,CAAA;AASlC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,SAAS;QACd;;;;;WAKG;;QAEH;;WAEG;;MAEJ;IAED,MAAM,CAAC,YAAY;;;MAGlB;IAED,MAAM,CAAC,UAAU;;;;;;;;;;;;;;MAchB;IAED,cAAc,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAChD,aAAa,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAC/C,kBAAkB,EAAE;QAClB,cAAc,IAAI,OAAO,CAAA;QACzB,MAAM,IAAI,IAAI,CAAA;KACf,GAAG,IAAI,CAAO;IAEf,KAAK;;;MAGJ;IAED,iBAAiB;IAajB,uBAAuB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA;IAU5C,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA;IA0BvC,oBAAoB;IASpB,qBAAqB,CAAC,SAAS,KAAA,EAAE,OAAO,KAAA;IAoBxC,wBAAwB;IAKxB,mBAAmB;IAOnB,kBAAkB;IAOlB,qBAAqB,aAEpB;IAGD,WAAW,uBAGV;IAGD,UAAU,uBAGT;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,sBAkBZ;IAED,IAAI,YAAY,YAGf;IAED,KAAK;IASL,cAAc,CAAC,SAAS,KAAA,EAAE,OAAO,KAAA;IAyBjC,MAAM;CAcP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Focusable/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,SAAS;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;SAAe;IAClC,MAAM,CAAC,YAAY;;MAElB;IAED,MAAM,CAAC,UAAU;;;;;;;;;;;;;;MAchB;IAED,cAAc,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAChD,aAAa,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAC/C,kBAAkB,EAAE;QAClB,cAAc,IAAI,OAAO,CAAA;QACzB,MAAM,IAAI,IAAI,CAAA;KACf,GAAG,IAAI,CAAO;IAEf,KAAK;;;MAGJ;IAED,iBAAiB;IAajB,uBAAuB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA;IAU5C,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA;IA0BvC,oBAAoB;IASpB,qBAAqB,CAAC,SAAS,KAAA,EAAE,OAAO,KAAA;IAoBxC,wBAAwB;IAKxB,mBAAmB;IAOnB,kBAAkB;IAOlB,qBAAqB,aAEpB;IAGD,WAAW,uBAGV;IAGD,UAAU,uBAGT;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,sBAkBZ;IAED,IAAI,YAAY,YAGf;IAED,KAAK;IASL,cAAc,CAAC,SAAS,KAAA,EAAE,OAAO,KAAA;IAyBjC,MAAM;CAcP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/types/Focusable/props.d.ts

@@ -0,0 +1,13 @@
+import type { PropValidators } from '@instructure/shared-types';
+declare type FocusableOwnProps = {
+    children?: (...args: any[]) => any;
+    render?: (...args: any[]) => any;
+};
+declare type PropKeys = keyof FocusableOwnProps;
+declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
+declare type FocusableProps = FocusableOwnProps;
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { FocusableProps };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map

package/types/Focusable/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Focusable/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAG/D,aAAK,iBAAiB,GAAG;IACvB,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACjC,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,iBAAiB,CAAA;AAEvC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,cAAc,GAAG,iBAAiB,CAAA;AAEvC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAYvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAAwC,CAAA;AAE5D,YAAY,EAAE,cAAc,EAAE,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/index.d.ts

@@ -1,3 +1,3 @@
 export { Focusable } from './Focusable';
-export type { FocusableProps } from './Focusable/types';
+export type { FocusableProps } from './Focusable/props';
 //# sourceMappingURL=index.d.ts.map

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions.**
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/es/Focusable/types.js

@@ -1 +0,0 @@
-export {};

package/lib/Focusable/types.js

@@ -1 +0,0 @@
-"use strict";

package/types/Focusable/types.d.ts

@@ -1,4 +0,0 @@
-export declare type FocusableProps = {
-    render?: (...args: any[]) => any;
-};
-//# sourceMappingURL=types.d.ts.map

package/types/Focusable/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/Focusable/types.ts"],"names":[],"mappings":"AAwBA,oBAAY,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACjC,CAAA"}