@instructure/ui-buttons 8.8.1-snapshot.3 → 8.8.1-snapshot.63

package/lib/CloseButton/props.js

@@ -0,0 +1,115 @@
+"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 = {
+  /**
+   * 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])
+};
+exports.propTypes = propTypes;
+const allowedProps = ['as', 'color', 'cursor', 'elementRef', 'href', 'interaction', 'margin', 'offset', 'onClick', 'placement', 'screenReaderLabel', 'size', 'tabIndex', 'type'];
+exports.allowedProps = allowedProps;

package/lib/CondensedButton/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 _passthroughProps = require("@instructure/ui-react-utils/lib/passthroughProps.js");
@@ -25,6 +23,8 @@ var _theme = _interopRequireDefault(require("./theme"));
 
 var _BaseButton = require("../BaseButton");
 
+var _props = require("./props");
+
 const _excluded = ["children", "type", "size", "elementRef", "as", "interaction", "color", "margin", "cursor", "href", "renderIcon"];
 
 var _dec, _dec2, _class, _class2, _temp;
@@ -86,77 +86,16 @@ let CondensedButton = (_dec = (0, _emotion.withStyle)(null, _theme.default), _de
     }), children);
   }
 
-}, _class2.displayName = "CondensedButton", _class2.componentId = 'CondensedButton', _class2.propTypes = {
-  /**
-   * Specifies the `CondensedButton` children.
-   */
-  children: _propTypes.default.node,
-
-  /**
-   * Specifies the type of the `CondensedButton`'s underlying html element.
-   */
-  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
-
-  /**
-   * The size of the `CondensedButton`
-   */
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Provides a reference to the `CondensedButton`'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 `CondensedButton` is enabled, disabled, or readonly.
-   */
-  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Specifies the color for the `CondensedButton`.
-   */
-  color: _propTypes.default.oneOf(['primary', 'primary-inverse']),
-
-  /**
-   * 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 `CondensedButton`'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 = "CondensedButton", _class2.componentId = 'CondensedButton', _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: 'primary',
   margin: '0',
-  cursor: 'pointer',
-  href: void 0,
-  renderIcon: void 0
+  cursor: 'pointer'
 }, _temp)) || _class) || _class);
 exports.CondensedButton = CondensedButton;
 var _default = CondensedButton;

package/lib/CondensedButton/props.js

@@ -0,0 +1,98 @@
+"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 `CondensedButton` children.
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * Specifies the type of the `CondensedButton`'s underlying html element.
+   */
+  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
+
+  /**
+   * The size of the `CondensedButton`
+   */
+  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * Provides a reference to the `CondensedButton`'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 `CondensedButton` is enabled, disabled, or readonly.
+   */
+  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
+
+  /**
+   * Specifies the color for the `CondensedButton`.
+   */
+  color: _propTypes.default.oneOf(['primary', 'primary-inverse']),
+
+  /**
+   * 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 `CondensedButton`'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', 'elementRef', 'href', 'interaction', 'margin', 'renderIcon', 'size', 'type'];
+exports.allowedProps = allowedProps;

package/lib/IconButton/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 _passthroughProps = require("@instructure/ui-react-utils/lib/passthroughProps.js");
@@ -27,6 +25,8 @@ var _theme = _interopRequireDefault(require("./theme"));
 
 var _BaseButton = require("../BaseButton");
 
+var _props = require("./props");
+
 const _excluded = ["children", "renderIcon", "screenReaderLabel", "type", "size", "elementRef", "as", "interaction", "color", "focusColor", "shape", "withBackground", "withBorder", "margin", "cursor", "href"];
 
 var _dec, _dec2, _class, _class2, _temp;
@@ -94,106 +94,19 @@ let IconButton = (_dec = (0, _emotion.withStyle)(null, _theme.default), _dec2 =
     }), /*#__PURE__*/_react.default.createElement(_ScreenReaderContent.ScreenReaderContent, null, screenReaderLabel));
   }
 
-}, _class2.displayName = "IconButton", _class2.componentId = 'IconButton', _class2.propTypes = {
-  /**
-   * An icon, or function returning an icon (identical to the `renderIcon` prop).
-   */
-  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * An icon, or function that returns an icon (identical to the `children` prop).
-   */
-  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
-
-  /**
-   * An accessible label for the `IconButton`.
-   */
-  screenReaderLabel: _propTypes.default.string.isRequired,
-
-  /**
-   * Specifies the type of the `IconButton`'s underlying html element.
-   */
-  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
-
-  /**
-   * The size of the `IconButton`
-   */
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * Provides a reference to the `IconButton`'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 `IconButton` is enabled, disabled, or readonly.
-   */
-  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
-
-  /**
-   * Specifies the color for the `IconButton`.
-   */
-  color: _propTypes.default.oneOf(['primary', 'primary-inverse', 'secondary', 'success', 'danger']),
-
-  /**
-   * Override the `Button`'s default focus outline color.
-   */
-  focusColor: _propTypes.default.oneOf(['info', 'inverse']),
-
-  /**
-   * Specifies if the `IconButton` shape should be a circle or rectangle.
-   */
-  shape: _propTypes.default.oneOf(['rectangle', 'circle']),
-
-  /**
-   * Specifies if the `IconButton` should render with a solid background. When false, the background is transparent.
-   */
-  withBackground: _propTypes.default.bool,
-
-  /**
-   * Specifies if the `IconButton` should render with a border.
-   */
-  withBorder: _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 `IconButton`'s underlying html element.
-   */
-  href: _propTypes.default.string
-}, _class2.defaultProps = {
+}, _class2.displayName = "IconButton", _class2.componentId = 'IconButton', _class2.propTypes = _props.propTypes, _class2.allowedProps = _props.allowedProps, _class2.defaultProps = {
   children: null,
-  renderIcon: void 0,
   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,
   shape: 'rectangle',
   withBackground: true,
   withBorder: true,
   margin: '0',
-  cursor: 'pointer',
-  href: void 0
+  cursor: 'pointer'
 }, _temp)) || _class) || _class);
 exports.IconButton = IconButton;
 var _default = IconButton;

package/lib/IconButton/props.js

@@ -0,0 +1,123 @@
+"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 = {
+  /**
+   * An icon, or function returning an icon (identical to the `renderIcon` prop).
+   */
+  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * An icon, or function that returns an icon (identical to the `children` prop).
+   */
+  renderIcon: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]),
+
+  /**
+   * An accessible label for the `IconButton`.
+   */
+  screenReaderLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * Specifies the type of the `IconButton`'s underlying html element.
+   */
+  type: _propTypes.default.oneOf(['button', 'submit', 'reset']),
+
+  /**
+   * The size of the `IconButton`
+   */
+  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * Provides a reference to the `IconButton`'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 `IconButton` is enabled, disabled, or readonly.
+   */
+  interaction: _propTypes.default.oneOf(['enabled', 'disabled', 'readonly']),
+
+  /**
+   * Specifies the color for the `IconButton`.
+   */
+  color: _propTypes.default.oneOf(['primary', 'primary-inverse', 'secondary', 'success', 'danger']),
+
+  /**
+   * Override the `Button`'s default focus outline color.
+   */
+  focusColor: _propTypes.default.oneOf(['info', 'inverse']),
+
+  /**
+   * Specifies if the `IconButton` shape should be a circle or rectangle.
+   */
+  shape: _propTypes.default.oneOf(['rectangle', 'circle']),
+
+  /**
+   * Specifies if the `IconButton` should render with a solid background. When false, the background is transparent.
+   */
+  withBackground: _propTypes.default.bool,
+
+  /**
+   * Specifies if the `IconButton` should render with a border.
+   */
+  withBorder: _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 `IconButton`'s underlying html element.
+   */
+  href: _propTypes.default.string
+};
+exports.propTypes = propTypes;
+const allowedProps = ['as', 'children', 'color', 'cursor', 'elementRef', 'focusColor', 'href', 'interaction', 'margin', 'renderIcon', 'screenReaderLabel', 'shape', 'size', 'type', 'withBackground', 'withBorder'];
+exports.allowedProps = allowedProps;