@instructure/ui-buttons 8.8.1-snapshot.7 → 8.9.1-snapshot.2

package/lib/BaseButton/props.js

@@ -0,0 +1,150 @@
+"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 _emotion = require("@instructure/emotion");
+
+/*
+ * 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 = {
+  /**
+   * Specifies the `Button` children.
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * Specifies the type of the `Button`'s underlying html element.
+   */
+  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
+
+  /**
+   * The size of the `Button`
+   */
+  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * Provides a reference to the `Button`'s underlying html element.
+   */
+  elementRef: _propTypes.default.func,
+
+  /**
+   * The element to render as the component root, `Button` by default.
+   */
+  as: _propTypes.default.elementType,
+
+  /**
+   * Specifies if interaction with the `Button` is enabled, disabled, or readonly.
+   */
+  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
+
+  /**
+   * Specifies the color for the `Button`.
+   */
+  color: _propTypes.default.oneOf(['primary', 'primary-inverse', 'secondary', 'success', 'danger']),
+
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: _propTypes.default.oneOf(['info', 'inverse']),
+
+  /**
+   * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
+   * When set to block, the `Button` expands to fill the width of the container.
+   */
+  display: _propTypes.default.oneOf(['inline-block', 'block']),
+
+  /**
+   * Sets the alignment of the `Button` children and/or icon.
+   */
+  textAlign: _propTypes.default.oneOf(['start', 'center']),
+
+  /**
+   * Specifies if the `Button` shape should be a circle or rectangle.
+   */
+  shape: _propTypes.default.oneOf(['rectangle', 'circle']),
+
+  /**
+   * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: _propTypes.default.bool,
+
+  /**
+   * Specifies if the `Button` should render with a border.
+   */
+  withBorder: _propTypes.default.bool,
+
+  /**
+   * Designates if the `Button` should render without padding. This option should only be set when `withBorder` and
+   * `withBackground` are also set to false.
+   */
+  isCondensed: _propTypes.default.bool,
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin: _emotion.ThemeablePropTypes.spacing,
+
+  /**
+   * Specify a mouse cursor to use when hovering over the button.
+   * The `pointer` cursor is used by default.
+   */
+  cursor: _propTypes.default.string,
+
+  /**
+   * Specifies an href attribute for the `Button`'s underlying html element.
+   */
+  href: _propTypes.default.string,
+
+  /**
+   * Callback fired when the `Button` is clicked.
+   */
+  onClick: _propTypes.default.func,
+
+  /**
+   * Callback fired when the `Button` receives a keydown event.
+   */
+  onKeyDown: _propTypes.default.func,
+
+  /**
+   * An icon, or function that returns an icon.
+   */
+  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * Specifies the tabindex of the `Button`.
+   */
+  tabIndex: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string])
+};
+exports.propTypes = propTypes;
+const allowedProps = ['as', 'children', 'color', 'cursor', 'display', 'elementRef', 'focusColor', 'href', 'interaction', 'isCondensed', 'margin', 'onClick', 'onKeyDown', 'renderIcon', 'shape', 'size', 'tabIndex', 'textAlign', 'type', 'withBackground', 'withBorder'];
+exports.allowedProps = allowedProps;

package/lib/Button/index.js

@@ -13,8 +13,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _testable = require("@instructure/ui-testable/lib/testable.js");
 
 var _getInteraction = require("@instructure/ui-react-utils/lib/getInteraction.js");
@@ -27,6 +25,8 @@ var _theme = _interopRequireDefault(require("./theme"));
 
 var _BaseButton = require("../BaseButton");
 
+var _props = require("./props");
+
 const _excluded = ["children", "type", "size", "as", "color", "focusColor", "display", "textAlign", "withBackground", "margin", "cursor", "href", "renderIcon"];
 
 var _dec, _dec2, _class, _class2, _temp;
@@ -102,102 +102,19 @@ let Button = (_dec = (0, _emotion.withStyle)(null, _theme.default), _dec2 = (0,
     return /*#__PURE__*/_react.default.createElement(_BaseButton.BaseButton, buttonProps, children);
   }
 
-}, _class2.displayName = "Button", _class2.componentId = 'Button', _class2.propTypes = {
-  /**
-   * Specifies the `Button` children.
-   */
-  children: _propTypes.default.node,
-
-  /**
-   * Specifies the type of the `Button`'s underlying html element.
-   */
-  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
-
-  /**
-   * The size of the `Button`
-   */
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Provides a reference to the `Button`'s underlying html element.
-   */
-  elementRef: _propTypes.default.func,
-
-  /**
-   * The element to render as the component root, `Button` by default.
-   */
-  as: _propTypes.default.elementType,
-
-  /**
-   * Specifies if interaction with the `Button` is enabled, disabled, or readonly.
-   */
-  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Specifies the color for the `Button`.
-   */
-  color: _propTypes.default.oneOf(['primary', 'primary-inverse', 'secondary', 'success', 'danger']),
-
-  /**
-   * Override the `Button`'s default focus outline color.
-   */
-  focusColor: _propTypes.default.oneOf(['info', 'inverse']),
-
-  /**
-   * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
-   * When set to block, the `Button` expands to fill the width of the container.
-   */
-  display: _propTypes.default.oneOf(['inline-block', 'block']),
-
-  /**
-   * Sets the alignment of the `Button` children and/or icon.
-   */
-  textAlign: _propTypes.default.oneOf(['start', 'center']),
-
-  /**
-   * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
-   */
-  withBackground: _propTypes.default.bool,
-
-  /**
-   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
-   */
-  margin: _emotion.ThemeablePropTypes.spacing,
-
-  /**
-   * Specify a mouse cursor to use when hovering over the button.
-   * The `pointer` cursor is used by default.
-   */
-  cursor: _propTypes.default.string,
-
-  /**
-   * Specifies an href attribute for the `Button`'s underlying html element.
-   */
-  href: _propTypes.default.string,
-
-  /**
-   * An icon, or function that returns an icon.
-   */
-  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func])
-}, _class2.defaultProps = {
+}, _class2.displayName = "Button", _class2.componentId = 'Button', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   children: null,
   type: 'button',
   size: 'medium',
   elementRef: el => {},
   as: 'button',
   // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-  interaction: void 0,
   color: 'secondary',
-  focusColor: void 0,
   display: 'inline-block',
   textAlign: 'center',
   withBackground: true,
   margin: '0',
-  cursor: 'pointer',
-  href: void 0,
-  renderIcon: void 0
+  cursor: 'pointer'
 }, _temp)) || _class) || _class);
 exports.Button = Button;
 var _default = Button;

package/lib/Button/props.js

@@ -0,0 +1,119 @@
+"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 _emotion = require("@instructure/emotion");
+
+/*
+ * 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 = {
+  /**
+   * Specifies the `Button` children.
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * Specifies the type of the `Button`'s underlying html element.
+   */
+  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
+
+  /**
+   * The size of the `Button`
+   */
+  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * Provides a reference to the `Button`'s underlying html element.
+   */
+  elementRef: _propTypes.default.func,
+
+  /**
+   * The element to render as the component root, `Button` by default.
+   */
+  as: _propTypes.default.elementType,
+
+  /**
+   * Specifies if interaction with the `Button` is enabled, disabled, or readonly.
+   */
+  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
+
+  /**
+   * Specifies the color for the `Button`.
+   */
+  color: _propTypes.default.oneOf(['primary', 'primary-inverse', 'secondary', 'success', 'danger']),
+
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: _propTypes.default.oneOf(['info', 'inverse']),
+
+  /**
+   * The `Button` display property. When set to `inline-block`, the `Button` displays inline with other elements.
+   * When set to block, the `Button` expands to fill the width of the container.
+   */
+  display: _propTypes.default.oneOf(['inline-block', 'block']),
+
+  /**
+   * Sets the alignment of the `Button` children and/or icon.
+   */
+  textAlign: _propTypes.default.oneOf(['start', 'center']),
+
+  /**
+   * Specifies if the `Button` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: _propTypes.default.bool,
+
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin: _emotion.ThemeablePropTypes.spacing,
+
+  /**
+   * Specify a mouse cursor to use when hovering over the button.
+   * The `pointer` cursor is used by default.
+   */
+  cursor: _propTypes.default.string,
+
+  /**
+   * Specifies an href attribute for the `Button`'s underlying html element.
+   */
+  href: _propTypes.default.string,
+
+  /**
+   * An icon, or function that returns an icon.
+   */
+  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func])
+};
+exports.propTypes = propTypes;
+const allowedProps = ['as', 'children', 'color', 'cursor', 'display', 'elementRef', 'focusColor', 'href', 'interaction', 'margin', 'renderIcon', 'size', 'textAlign', 'type', 'withBackground'];
+exports.allowedProps = allowedProps;

package/lib/CloseButton/index.js

@@ -11,8 +11,6 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _IconXSolid = require("@instructure/ui-icons/lib/IconXSolid.js");
 
 var _ScreenReaderContent = require("@instructure/ui-a11y-content/lib/ScreenReaderContent");
@@ -31,6 +29,8 @@ var _theme = _interopRequireDefault(require("./theme"));
 
 var _BaseButton = require("../BaseButton");
 
+var _props = require("./props");
+
 const _excluded = ["screenReaderLabel", "elementRef", "size", "onClick", "margin", "placement", "offset", "type", "as", "href", "cursor", "tabIndex", "styles"];
 
 var _dec, _dec2, _class, _class2, _temp;
@@ -77,7 +77,7 @@ let CloseButton = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
           styles = _this$props.styles,
           props = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
     return (0, _emotion.jsx)("span", Object.assign({}, (0, _passthroughProps.passthroughProps)(props), {
-      css: styles.closeButton
+      css: styles === null || styles === void 0 ? void 0 : styles.closeButton
     }), (0, _emotion.jsx)(_BaseButton.BaseButton, {
       renderIcon: _IconXSolid.IconXSolid,
       elementRef: elementRef,
@@ -96,104 +96,16 @@ let CloseButton = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.defaul
     }, (0, _emotion.jsx)(_ScreenReaderContent.ScreenReaderContent, null, screenReaderLabel)));
   }
 
-}, _class2.displayName = "CloseButton", _class2.componentId = 'CloseButton', _class2.propTypes = {
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object,
-
-  /**
-   * An accessible label for the `CloseButton` (required)
-   */
-  screenReaderLabel: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
-
-  /**
-   * Specifies the color for the `CloseButton`.
-   */
-  color: _propTypes.default.oneOf(['primary', 'primary-inverse']),
-
-  /**
-   * Specifies if interaction with the `CloseButton` is enabled, disabled, or readonly.
-   */
-  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Provides a reference to the `CloseButton`'s underlying html element.
-   */
-  elementRef: _propTypes.default.func,
-
-  /**
-   * The size of the `CloseButton`
-   */
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Callback fired when the `CloseButton` is clicked.
-   */
-  onClick: _propTypes.default.func,
-
-  /**
-   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
-   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
-   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
-   */
-  margin: _emotion.ThemeablePropTypes.spacing,
-
-  /**
-   * Specifies the placement of the `CloseButton`
-   */
-  placement: _propTypes.default.oneOf(['start', 'end', 'static']),
-
-  /**
-   * Specifies the offset distance for the `CloseButton` with respect to both the top and start/end of the container.
-   * Note that for this property to have an effect, the `placement` prop must be set to either `start` or `end`. The
-   * offset will also be created with respect to a positioned parent. If it does not appear to be working, try setting
-   * the `position` of the parent container to `relative`.
-   */
-  offset: _propTypes.default.oneOf(['none', 'x-small', 'small', 'medium']),
-
-  /**
-   * Specifies the type of the `Button`'s underlying html element.
-   */
-  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
-
-  /**
-   * The element to render as the component root, `CloseButton` by default.
-   */
-  as: _propTypes.default.elementType,
-
-  /**
-   * Specifies an href attribute for the `CloseButton`'s underlying html element.
-   */
-  href: _propTypes.default.string,
-
-  /**
-   * Specify a mouse cursor to use when hovering over the `CloseButton`.
-   */
-  cursor: _propTypes.default.string,
-
-  /**
-   * Specifies the tabindex of the `CloseButton`.
-   */
-  tabIndex: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string])
-}, _class2.defaultProps = {
-  screenReaderLabel: void 0,
+}, _class2.displayName = "CloseButton", _class2.componentId = 'CloseButton', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   onClick: event => {},
-  elementRef: void 0,
-  color: void 0,
   // Leave interaction default undefined so that `disabled` and `readOnly` can also be supplied
-  interaction: void 0,
-  disabled: void 0,
-  readOnly: void 0,
   type: 'button',
   placement: 'static',
   offset: 'x-small',
   size: 'small',
   margin: '0',
   as: 'button',
-  href: void 0,
-  cursor: 'pointer',
-  tabIndex: void 0
+  cursor: 'pointer'
 }, _temp)) || _class) || _class);
 exports.CloseButton = CloseButton;
 var _default = CloseButton;