@instructure/ui-checkbox 8.8.1-snapshot.3 → 8.9.0

package/lib/CheckboxGroup/index.js

@@ -2,8 +2,6 @@
 
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -11,14 +9,6 @@ exports.CheckboxGroup = exports.default = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
-
-var _Children = require("@instructure/ui-prop-types/lib/Children.js");
-
-var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
-
 var _FormFieldGroup = require("@instructure/ui-form-field/lib/FormFieldGroup");
 
 var _uid = require("@instructure/uid");
@@ -35,6 +25,8 @@ var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _Checkbox = require("../Checkbox");
 
+var _props = require("./props");
+
 var _dec, _class, _class2, _temp;
 
 /**
@@ -129,50 +121,11 @@ let CheckboxGroup = (_dec = (0, _testable.testable)(), _dec(_class = (_temp = _c
     );
   }
 
-}, _class2.displayName = "CheckboxGroup", _class2.componentId = 'CheckboxGroup', _class2.propTypes = {
-  name: _propTypes.default.string.isRequired,
-  description: _propTypes.default.node.isRequired,
-
-  /**
-   * value to set on initial render
-   */
-  defaultValue: _propTypes.default.array,
-
-  /**
-   * the selected values (must be accompanied by an `onChange` prop)
-   */
-  value: (0, _controllable.controllable)(_propTypes.default.array),
-
-  /**
-   * when used with the `value` prop, the component will not control its own state
-   */
-  onChange: _propTypes.default.func,
-  disabled: _propTypes.default.bool,
-  readOnly: _propTypes.default.bool,
-
-  /**
-  * object with shape: `{
-  text: PropTypes.string,
-  type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-    }`
-  */
-  messages: _propTypes.default.arrayOf(_FormPropTypes.FormPropTypes.message),
-
-  /**
-   * children of type `Checkbox`
-   */
-  children: _Children.Children.oneOf([_Checkbox.Checkbox]),
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-  layout: _propTypes.default.oneOf(['stacked', 'columns', 'inline'])
-}, _class2.defaultProps = {
+}, _class2.displayName = "CheckboxGroup", _class2.componentId = 'CheckboxGroup', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   disabled: false,
   readOnly: false,
   size: 'medium',
   layout: 'stacked',
-  defaultValue: void 0,
-  messages: void 0,
-  value: void 0,
-  onChange: void 0,
   children: null
 }, _temp)) || _class);
 exports.CheckboxGroup = CheckboxGroup;

package/lib/CheckboxGroup/props.js

@@ -0,0 +1,81 @@
+"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"));
+
+var _FormPropTypes = require("@instructure/ui-form-field/lib/FormPropTypes.js");
+
+var _controllable = require("@instructure/ui-prop-types/lib/controllable.js");
+
+var _Children = require("@instructure/ui-prop-types/lib/Children.js");
+
+var _Checkbox = require("../Checkbox");
+
+/*
+ * 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 = {
+  name: _propTypes.default.string.isRequired,
+  description: _propTypes.default.node.isRequired,
+
+  /**
+   * value to set on initial render
+   */
+  defaultValue: _propTypes.default.array,
+
+  /**
+   * the selected values (must be accompanied by an `onChange` prop)
+   */
+  value: (0, _controllable.controllable)(_propTypes.default.array),
+
+  /**
+   * when used with the `value` prop, the component will not control its own state
+   */
+  onChange: _propTypes.default.func,
+  disabled: _propTypes.default.bool,
+  readOnly: _propTypes.default.bool,
+
+  /**
+   * object with shape: `{
+    text: PropTypes.string,
+    type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
+      }`
+   */
+  messages: _propTypes.default.arrayOf(_FormPropTypes.FormPropTypes.message),
+
+  /**
+   * children of type `Checkbox`
+   */
+  children: _Children.Children.oneOf([_Checkbox.Checkbox]),
+  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
+  layout: _propTypes.default.oneOf(['stacked', 'columns', 'inline'])
+};
+exports.propTypes = propTypes;
+const allowedProps = ['name', 'description', 'defaultValue', 'value', 'onChange', 'disabled', 'readOnly', 'messages', 'children', 'size', 'layout'];
+exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-checkbox",
-  "version": "8.8.1-snapshot.3+d5d6d4cd8",
+  "version": "8.9.0",
   "description": " styled HTML input type='checkbox' component.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,28 +25,28 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/emotion": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-dom-utils": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-form-field": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-icons": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-prop-types": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-svg-images": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-testable": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-utils": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-view": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/uid": "8.8.1-snapshot.3+d5d6d4cd8",
+    "@instructure/console": "8.9.0",
+    "@instructure/emotion": "8.9.0",
+    "@instructure/shared-types": "8.9.0",
+    "@instructure/ui-dom-utils": "8.9.0",
+    "@instructure/ui-form-field": "8.9.0",
+    "@instructure/ui-icons": "8.9.0",
+    "@instructure/ui-prop-types": "8.9.0",
+    "@instructure/ui-react-utils": "8.9.0",
+    "@instructure/ui-svg-images": "8.9.0",
+    "@instructure/ui-testable": "8.9.0",
+    "@instructure/ui-utils": "8.9.0",
+    "@instructure/ui-view": "8.9.0",
+    "@instructure/uid": "8.9.0",
     "keycode": "^2",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/shared-types": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-color-utils": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-test-locator": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.3+d5d6d4cd8",
-    "@instructure/ui-themes": "8.8.1-snapshot.3+d5d6d4cd8"
+    "@instructure/ui-babel-preset": "8.9.0",
+    "@instructure/ui-color-utils": "8.9.0",
+    "@instructure/ui-test-locator": "8.9.0",
+    "@instructure/ui-test-utils": "8.9.0",
+    "@instructure/ui-themes": "8.9.0"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -54,6 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "d5d6d4cd8f300e8635c69248f5d794c002269e08"
+  "sideEffects": false
 }

package/src/Checkbox/CheckboxFacade/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { SVGIcon } from '@instructure/ui-svg-images'
 import { IconCheckMarkSolid } from '@instructure/ui-icons'
@@ -33,7 +32,9 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { CheckboxFacadeProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { CheckboxFacadeProps } from './props'
 
 /**
 ---
@@ -44,22 +45,8 @@ parent: Checkbox
 class CheckboxFacade extends Component<CheckboxFacadeProps> {
   static readonly componentId = 'CheckboxFacade'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    children: PropTypes.node.isRequired,
-    checked: PropTypes.bool,
-    focused: PropTypes.bool,
-    hovered: PropTypes.bool,
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    /**
-     * Visual state showing that child checkboxes are a combination of checked and unchecked
-     */
-    indeterminate: PropTypes.bool
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     checked: false,
     focused: false,
@@ -98,11 +85,11 @@ class CheckboxFacade extends Component<CheckboxFacadeProps> {
     const { children, styles } = this.props
 
     return (
-      <span css={styles.checkboxFacade}>
-        <span css={styles.facade} aria-hidden="true">
+      <span css={styles?.checkboxFacade}>
+        <span css={styles?.facade} aria-hidden="true">
           {this.renderIcon()}
         </span>
-        <span css={styles.label}>{children}</span>
+        <span css={styles?.label}>{children}</span>
       </span>
     )
   }

package/src/Checkbox/CheckboxFacade/props.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 PropTypes from 'prop-types'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type CheckboxFacadeOwnProps = {
+  children: React.ReactNode
+  checked?: boolean
+  focused?: boolean
+  hovered?: boolean
+  size?: 'small' | 'medium' | 'large'
+  indeterminate?: boolean
+}
+
+type PropKeys = keyof CheckboxFacadeOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type CheckboxFacadeProps = CheckboxFacadeOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  children: PropTypes.node.isRequired,
+  checked: PropTypes.bool,
+  focused: PropTypes.bool,
+  hovered: PropTypes.bool,
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Visual state showing that child checkboxes are a combination of checked and unchecked
+   */
+  indeterminate: PropTypes.bool
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'checked',
+  'focused',
+  'hovered',
+  'size',
+  'indeterminate'
+]
+
+export type { CheckboxFacadeProps }
+export { propTypes, allowedProps }

package/src/Checkbox/CheckboxFacade/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { CheckboxFacadeTheme } from '@instructure/shared-types'
-import { CheckboxFacadeProps } from './types'
+import { CheckboxFacadeProps } from './props'
 
 /**
  * ---

package/src/Checkbox/ToggleFacade/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { IconCheckSolid, IconXSolid } from '@instructure/ui-icons'
 
@@ -32,7 +31,9 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { ToggleFacadeProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { ToggleFacadeProps } from './props'
 
 /**
 ---
@@ -43,20 +44,8 @@ parent: Checkbox
 class ToggleFacade extends Component<ToggleFacadeProps> {
   static readonly componentId = 'ToggleFacade'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    children: PropTypes.node.isRequired,
-    checked: PropTypes.bool,
-    disabled: PropTypes.bool,
-    readOnly: PropTypes.bool,
-    focused: PropTypes.bool,
-    size: PropTypes.oneOf(['small', 'medium', 'large']),
-    labelPlacement: PropTypes.oneOf(['top', 'start', 'end'])
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     checked: false,
     focused: false,
@@ -81,28 +70,28 @@ class ToggleFacade extends Component<ToggleFacadeProps> {
     const { styles, checked } = this.props
 
     if (checked) {
-      return <IconCheckSolid css={styles.iconSVG} />
+      return <IconCheckSolid css={styles?.iconSVG} />
     } else {
-      return <IconXSolid css={styles.iconSVG} />
+      return <IconXSolid css={styles?.iconSVG} />
     }
   }
 
   renderLabel() {
     const { children, styles } = this.props
 
-    return <span css={styles.label}>{children}</span>
+    return <span css={styles?.label}>{children}</span>
   }
 
   render() {
     const { labelPlacement, styles } = this.props
 
     return (
-      <span css={styles.toggleFacade}>
+      <span css={styles?.toggleFacade}>
         {(labelPlacement === 'top' || labelPlacement === 'start') &&
           this.renderLabel()}
-        <span css={styles.facade} aria-hidden="true">
-          <span css={styles.icon}>
-            <span css={styles.iconToggle}>{this.renderIcon()}</span>
+        <span css={styles?.facade} aria-hidden="true">
+          <span css={styles?.icon}>
+            <span css={styles?.iconToggle}>{this.renderIcon()}</span>
           </span>
         </span>
         {labelPlacement === 'end' && this.renderLabel()}

package/src/Checkbox/ToggleFacade/{types.ts → props.ts}

@@ -22,9 +22,13 @@
  * SOFTWARE.
  */
 
-export type ToggleFacadeProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
+import PropTypes from 'prop-types'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type ToggleFacadeOwnProps = {
+  children: React.ReactNode
   checked?: boolean
   disabled?: boolean
   readOnly?: boolean
@@ -32,3 +36,32 @@ export type ToggleFacadeProps = {
   size?: 'small' | 'medium' | 'large'
   labelPlacement?: 'top' | 'start' | 'end'
 }
+
+type PropKeys = keyof ToggleFacadeOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type ToggleFacadeProps = ToggleFacadeOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  children: PropTypes.node.isRequired,
+  checked: PropTypes.bool,
+  disabled: PropTypes.bool,
+  readOnly: PropTypes.bool,
+  focused: PropTypes.bool,
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+  labelPlacement: PropTypes.oneOf(['top', 'start', 'end'])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'checked',
+  'disabled',
+  'readOnly',
+  'focused',
+  'size',
+  'labelPlacement'
+]
+
+export type { ToggleFacadeProps }
+export { propTypes, allowedProps }