@khanacademy/wonder-blocks-icon-button 3.4.21 → 3.4.23

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @khanacademy/wonder-blocks-icon-button
 
+## 3.4.23
+
+### Patch Changes
+
+-   Updated dependencies [779b031d]
+    -   @khanacademy/wonder-blocks-core@4.9.0
+    -   @khanacademy/wonder-blocks-clickable@2.4.7
+    -   @khanacademy/wonder-blocks-icon@1.2.39
+
+## 3.4.22
+
+### Patch Changes
+
+-   d816af08: Update build and test configs use TypeScript
+-   3891f544: Update babel config to include plugins that Storybook needed
+-   0d28bb1c: Configured TypeScript
+-   3d05f764: Fix HOCs and other type errors
+-   c2ec4902: Update eslint configuration, fix lint
+-   2983c05b: Include 'types' field in package.json
+-   77ff6a66: Generate Flow types from TypeScript types
+-   ec8d4b7f: Fix miscellaneous TypeScript errors
+-   Updated dependencies [d816af08]
+-   Updated dependencies [3891f544]
+-   Updated dependencies [3813715d]
+-   Updated dependencies [0d28bb1c]
+-   Updated dependencies [873f4a14]
+-   Updated dependencies [3d05f764]
+-   Updated dependencies [c2ec4902]
+-   Updated dependencies [2983c05b]
+-   Updated dependencies [77ff6a66]
+-   Updated dependencies [ec8d4b7f]
+    -   @khanacademy/wonder-blocks-clickable@2.4.6
+    -   @khanacademy/wonder-blocks-color@1.2.2
+    -   @khanacademy/wonder-blocks-core@4.8.0
+    -   @khanacademy/wonder-blocks-icon@1.2.38
+
 ## 3.4.21
 
 ### Patch Changes

package/dist/components/icon-button-core.d.ts

@@ -0,0 +1,17 @@
+import * as React from "react";
+import type { ChildrenProps, ClickableState } from "@khanacademy/wonder-blocks-clickable";
+import type { SharedProps } from "./icon-button";
+type Props = SharedProps & ChildrenProps & ClickableState & {
+    /**
+     * URL to navigate to.
+     *
+     * Used to determine whether to render an `<a>` or `<button>` tag. Also
+     * passed in as the `<a>` tag's `href` if present.
+     */
+    href?: string;
+};
+export default class IconButtonCore extends React.Component<Props> {
+    renderInner(router: any): React.ReactNode;
+    render(): React.ReactElement;
+}
+export {};

package/dist/components/icon-button-core.js.flow

@@ -0,0 +1,32 @@
+/**
+ * Flowtype definitions for icon-button-core
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type {
+  ChildrenProps,
+  ClickableState,
+} from "@khanacademy/wonder-blocks-clickable";
+import type { SharedProps } from "./icon-button";
+declare type Props = {
+  ...SharedProps,
+  ...ChildrenProps,
+  ...ClickableState,
+  ...{
+    /**
+     * URL to navigate to.
+     *
+     * Used to determine whether to render an `<a>` or `<button>` tag. Also
+     * passed in as the `<a>` tag's `href` if present.
+     */
+    href?: string,
+    ...
+  },
+};
+declare export default class IconButtonCore extends React.Component<Props> {
+  renderInner(router: any): React.Node;
+  render(): React.Element<>;
+}

package/dist/components/icon-button.d.ts

@@ -0,0 +1,141 @@
+import * as React from "react";
+import type { IconAsset } from "@khanacademy/wonder-blocks-icon";
+import type { AriaProps, StyleType } from "@khanacademy/wonder-blocks-core";
+export type SharedProps = Partial<Omit<AriaProps, "aria-disabled">> & {
+    /**
+     * A Wonder Blocks icon asset, an object specifing paths for one or more of
+     * the following sizes: small, medium, large, xlarge.
+     */
+    icon: IconAsset;
+    /**
+     * The color of the icon button, either blue or red.
+     */
+    color: "default" | "destructive";
+    /**
+     * The kind of the icon button, either primary, secondary, or tertiary.
+     *
+     * In default state:
+     * - Primary icon buttons are color: props.color
+     * - Secondary buttons are offBlack
+     * - Tertiary buttons are offBlack64
+     *
+     * In the hover/focus/press states, all variants have a border.
+     */
+    kind: "primary" | "secondary" | "tertiary";
+    /**
+     * Whether the icon button is on a dark/colored background.
+     */
+    light: boolean;
+    /**
+     * Whether the icon button is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Test ID used for e2e testing.
+     */
+    testId?: string;
+    /**
+     * Optional custom styles.
+     */
+    style?: StyleType;
+    /**
+     * Adds CSS classes to the IconButton.
+     */
+    className?: string;
+    /**
+     * URL to navigate to.
+     *
+     * Note: Either href or onClick must be defined
+     */
+    href?: string;
+    /**
+     * A target destination window for a link to open in.
+     */
+    target?: "_blank";
+    /**
+     * Specifies the type of relationship between the current document and the
+     * linked document. Should only be used when `href` is specified. This
+     * defaults to "noopener noreferrer" when `target="_blank"`, but can be
+     * overridden by setting this prop to something else.
+     */
+    rel?: string;
+    /**
+     * Set the tabindex attribute on the rendered element.
+     */
+    tabIndex?: number;
+    /**
+     * Whether to avoid using client-side navigation.
+     *
+     * If the URL passed to href is local to the client-side, e.g.
+     * /math/algebra/eval-exprs, then it tries to use react-router-dom's Link
+     * component which handles the client-side navigation. You can set
+     * `skipClientNav` to true avoid using client-side nav entirely.
+     *
+     * NOTE: All URLs containing a protocol are considered external, e.g.
+     * https://khanacademy.org/math/algebra/eval-exprs will trigger a full
+     * page reload.
+     */
+    skipClientNav?: boolean;
+    /**
+     * Function to call when button is clicked.
+     *
+     * This callback should be used for things like marking BigBingo
+     * conversions. It should NOT be used to redirect to a different URL or to
+     * prevent navigation via e.preventDefault(). The event passed to this
+     * handler will have its preventDefault() and stopPropagation() methods
+     * stubbed out.
+     *
+     * Note: onClick is optional if href is present, but must be defined if
+     * href is not
+     */
+    onClick?: (e: React.SyntheticEvent) => unknown;
+};
+type DefaultProps = {
+    color: SharedProps["color"];
+    kind: SharedProps["kind"];
+    light: SharedProps["light"];
+    disabled: SharedProps["disabled"];
+};
+/**
+ * An IconButton is a button whose contents are an SVG image.
+ *
+ * To use, supply an onClick function, a wonder-blocks icon asset (see
+ * the Icon section) and an aria-label to describe the button functionality.
+ * Optionally specify href (URL), clientSideNav, color
+ * (Wonder Blocks Blue or Red), kind ("primary", "secondary", or "tertiary"),
+ * light (whether the IconButton will be rendered on a dark background),
+ * disabled , test ID, and custom styling.
+ *
+ * The size of an IconButton matches the size of icon it wraps which is 24x24
+ * pixels.  The focus ring which is displayed on hover and focus is much
+ * larger but does not affect its size.  This matches the behavior of Button.
+ *
+ * IconButtons require a certain amount of space between them to ensure the
+ * focus rings don't overlap.  The minimum amount of spacing is 16px, but
+ * you should refer to the mocks provided by design.  Using a Strut in between
+ * IconButtons is the preferred way to for adding this spacing.
+ *
+ * Many layouts require alignment of visual left (or right) side of an
+ * IconButton.  This requires a little bit of pixel nudging since each icon
+ * as a different amount of internal padding.
+ *
+ * See the Toolbar documentation for examples of IconButton use that follow
+ * the best practices described above.
+ *
+ * ```js
+ * import {icons} from "@khanacademy/wonder-blocks-icon";
+ * import IconButton from "@khanacademy/wonder-blocks-icon-button";
+ *
+ * <IconButton
+ *     icon={icons.anIcon}
+ *     aria-label="An Icon"
+ *     onClick={(e) => console.log("Hello, world!")}
+ * />
+ * ```
+ */
+export default class IconButton extends React.Component<SharedProps> {
+    static defaultProps: DefaultProps;
+    renderClickableBehavior(router: any): React.ReactNode;
+    render(): React.ReactElement;
+}
+export {};

package/dist/components/icon-button.js.flow

@@ -0,0 +1,165 @@
+/**
+ * Flowtype definitions for icon-button
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { IconAsset } from "@khanacademy/wonder-blocks-icon";
+import type { AriaProps, StyleType } from "@khanacademy/wonder-blocks-core";
+export type SharedProps = {
+  ...$Rest<$Diff<AriaProps, { "aria-disabled": any }>, { ... }>,
+  ...{
+    /**
+     * A Wonder Blocks icon asset, an object specifing paths for one or more of
+     * the following sizes: small, medium, large, xlarge.
+     */
+    icon: IconAsset,
+
+    /**
+     * The color of the icon button, either blue or red.
+     */
+    color: "default" | "destructive",
+
+    /**
+     * The kind of the icon button, either primary, secondary, or tertiary.
+     *
+     * In default state:
+     * - Primary icon buttons are color: props.color
+     * - Secondary buttons are offBlack
+     * - Tertiary buttons are offBlack64
+     *
+     * In the hover/focus/press states, all variants have a border.
+     */
+    kind: "primary" | "secondary" | "tertiary",
+
+    /**
+     * Whether the icon button is on a dark/colored background.
+     */
+    light: boolean,
+
+    /**
+     * Whether the icon button is disabled.
+     */
+    disabled: boolean,
+
+    /**
+     * Test ID used for e2e testing.
+     */
+    testId?: string,
+
+    /**
+     * Optional custom styles.
+     */
+    style?: StyleType,
+
+    /**
+     * Adds CSS classes to the IconButton.
+     */
+    className?: string,
+
+    /**
+     * URL to navigate to.
+     *
+     * Note: Either href or onClick must be defined
+     */
+    href?: string,
+
+    /**
+     * A target destination window for a link to open in.
+     */
+    target?: "_blank",
+
+    /**
+     * Specifies the type of relationship between the current document and the
+     * linked document. Should only be used when `href` is specified. This
+     * defaults to "noopener noreferrer" when `target="_blank"`, but can be
+     * overridden by setting this prop to something else.
+     */
+    rel?: string,
+
+    /**
+     * Set the tabindex attribute on the rendered element.
+     */
+    tabIndex?: number,
+
+    /**
+     * Whether to avoid using client-side navigation.
+     *
+     * If the URL passed to href is local to the client-side, e.g.
+     * /math/algebra/eval-exprs, then it tries to use react-router-dom's Link
+     * component which handles the client-side navigation. You can set
+     * `skipClientNav` to true avoid using client-side nav entirely.
+     *
+     * NOTE: All URLs containing a protocol are considered external, e.g.
+     * https://khanacademy.org/math/algebra/eval-exprs will trigger a full
+     * page reload.
+     */
+    skipClientNav?: boolean,
+
+    /**
+     * Function to call when button is clicked.
+     *
+     * This callback should be used for things like marking BigBingo
+     * conversions. It should NOT be used to redirect to a different URL or to
+     * prevent navigation via e.preventDefault(). The event passed to this
+     * handler will have its preventDefault() and stopPropagation() methods
+     * stubbed out.
+     *
+     * Note: onClick is optional if href is present, but must be defined if
+     * href is not
+     */
+    onClick?: (e: React.SyntheticEvent<>) => mixed,
+    ...
+  },
+};
+declare type DefaultProps = {
+  color: $PropertyType<SharedProps, "color">,
+  kind: $PropertyType<SharedProps, "kind">,
+  light: $PropertyType<SharedProps, "light">,
+  disabled: $PropertyType<SharedProps, "disabled">,
+  ...
+};
+/**
+ * An IconButton is a button whose contents are an SVG image.
+ *
+ * To use, supply an onClick function, a wonder-blocks icon asset (see
+ * the Icon section) and an aria-label to describe the button functionality.
+ * Optionally specify href (URL), clientSideNav, color
+ * (Wonder Blocks Blue or Red), kind ("primary", "secondary", or "tertiary"),
+ * light (whether the IconButton will be rendered on a dark background),
+ * disabled , test ID, and custom styling.
+ *
+ * The size of an IconButton matches the size of icon it wraps which is 24x24
+ * pixels.  The focus ring which is displayed on hover and focus is much
+ * larger but does not affect its size.  This matches the behavior of Button.
+ *
+ * IconButtons require a certain amount of space between them to ensure the
+ * focus rings don't overlap.  The minimum amount of spacing is 16px, but
+ * you should refer to the mocks provided by design.  Using a Strut in between
+ * IconButtons is the preferred way to for adding this spacing.
+ *
+ * Many layouts require alignment of visual left (or right) side of an
+ * IconButton.  This requires a little bit of pixel nudging since each icon
+ * as a different amount of internal padding.
+ *
+ * See the Toolbar documentation for examples of IconButton use that follow
+ * the best practices described above.
+ *
+ * ```js
+ * import {icons} from "@khanacademy/wonder-blocks-icon";
+ * import IconButton from "@khanacademy/wonder-blocks-icon-button";
+ *
+ * <IconButton
+ *     icon={icons.anIcon}
+ *     aria-label="An Icon"
+ *     onClick={(e) => console.log("Hello, world!")}
+ * />
+ * ```
+ */
+declare export default class IconButton extends React.Component<SharedProps> {
+  static defaultProps: DefaultProps;
+  renderClickableBehavior(router: any): React.Node;
+  render(): React.Element<>;
+}

package/dist/es/index.js

@@ -1,5 +1,3 @@
-import _extends from '@babel/runtime/helpers/extends';
-import _objectWithoutPropertiesLoose from '@babel/runtime/helpers/objectWithoutPropertiesLoose';
 import * as React from 'react';
 import { __RouterContext } from 'react-router';
 import { isClientSideUrl, getClickableBehavior } from '@khanacademy/wonder-blocks-clickable';
@@ -9,45 +7,91 @@ import Color, { SemanticColor, mix, fade } from '@khanacademy/wonder-blocks-colo
 import { addStyle } from '@khanacademy/wonder-blocks-core';
 import Icon from '@khanacademy/wonder-blocks-icon';
 
+function _objectDestructuringEmpty(obj) {
+  if (obj == null) throw new TypeError("Cannot destructure " + obj);
+}
+
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+function _objectWithoutPropertiesLoose(source, excluded) {
+  if (source == null) return {};
+  var target = {};
+  var sourceKeys = Object.keys(source);
+  var key, i;
+  for (i = 0; i < sourceKeys.length; i++) {
+    key = sourceKeys[i];
+    if (excluded.indexOf(key) >= 0) continue;
+    target[key] = source[key];
+  }
+  return target;
+}
+
+function _setPrototypeOf(o, p) {
+  _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) {
+    o.__proto__ = p;
+    return o;
+  };
+  return _setPrototypeOf(o, p);
+}
+
+function _inheritsLoose(subClass, superClass) {
+  subClass.prototype = Object.create(superClass.prototype);
+  subClass.prototype.constructor = subClass;
+  _setPrototypeOf(subClass, superClass);
+}
+
 const _excluded$1 = ["skipClientNav", "color", "disabled", "focused", "hovered", "href", "icon", "kind", "light", "pressed", "style", "testId", "waiting"];
 const StyledAnchor = addStyle("a");
 const StyledButton = addStyle("button");
 const StyledLink = addStyle(Link);
-class IconButtonCore extends React.Component {
-  renderInner(router) {
+let IconButtonCore = function (_React$Component) {
+  _inheritsLoose(IconButtonCore, _React$Component);
+  function IconButtonCore() {
+    return _React$Component.apply(this, arguments) || this;
+  }
+  var _proto = IconButtonCore.prototype;
+  _proto.renderInner = function renderInner(router) {
     const _this$props = this.props,
-          {
-      skipClientNav,
-      color,
-      disabled,
-      focused,
-      hovered,
-      href,
-      icon,
-      kind,
-      light,
-      pressed,
-      style,
-      testId
-    } = _this$props,
-          restProps = _objectWithoutPropertiesLoose(_this$props, _excluded$1);
-
+      {
+        skipClientNav,
+        color,
+        disabled,
+        focused,
+        hovered,
+        href,
+        icon,
+        kind,
+        light,
+        pressed,
+        style,
+        testId
+      } = _this$props,
+      restProps = _objectWithoutPropertiesLoose(_this$props, _excluded$1);
     const buttonColor = color === "destructive" ? SemanticColor.controlDestructive : SemanticColor.controlDefault;
-
     const buttonStyles = _generateStyles(buttonColor, kind, light);
-
     const defaultStyle = [sharedStyles.shared, disabled && sharedStyles.disabled, buttonStyles.default, disabled && buttonStyles.disabled, !disabled && (pressed ? buttonStyles.active : (hovered || focused) && buttonStyles.focus)];
     const child = React.createElement(Icon, {
       size: "medium",
       color: "currentColor",
       icon: icon
     });
-
     const commonProps = _extends({
       "data-test-id": testId,
       style: [defaultStyle, style]
     }, restProps);
-
     if (href && !disabled) {
       return router && !skipClientNav && isClientSideUrl(href) ? React.createElement(StyledLink, _extends({}, commonProps, {
         to: href
@@ -61,13 +105,12 @@ class IconButtonCore extends React.Component {
         disabled: disabled
       }), child);
     }
-  }
-
-  render() {
+  };
+  _proto.render = function render() {
     return React.createElement(__RouterContext.Consumer, null, router => this.renderInner(router));
-  }
-
-}
+  };
+  return IconButtonCore;
+}(React.Component);
 const sharedStyles = StyleSheet.create({
   shared: {
     position: "relative",
@@ -94,18 +137,14 @@ const sharedStyles = StyleSheet.create({
   }
 });
 const styles = {};
-
 const _generateStyles = (color, kind, light) => {
   const buttonType = color + kind + light.toString();
-
   if (styles[buttonType]) {
     return styles[buttonType];
   }
-
   if (light && kind !== "primary") {
     throw new Error("Light is only supported for primary IconButtons");
   }
-
   const {
     white,
     offBlack32,
@@ -133,7 +172,6 @@ const _generateStyles = (color, kind, light) => {
       cursor: "default"
     }
   };
-
   if (kind === "primary") {
     newStyles["default"] = {
       color: light ? white : color
@@ -149,24 +187,27 @@ const _generateStyles = (color, kind, light) => {
   } else {
     throw new Error("IconButton kind not recognized");
   }
-
   styles[buttonType] = StyleSheet.create(newStyles);
   return styles[buttonType];
 };
 
 const _excluded = ["onClick", "href", "skipClientNav", "tabIndex", "target"];
-class IconButton extends React.Component {
-  renderClickableBehavior(router) {
+let IconButton = function (_React$Component) {
+  _inheritsLoose(IconButton, _React$Component);
+  function IconButton() {
+    return _React$Component.apply(this, arguments) || this;
+  }
+  var _proto = IconButton.prototype;
+  _proto.renderClickableBehavior = function renderClickableBehavior(router) {
     const _this$props = this.props,
-          {
-      onClick,
-      href,
-      skipClientNav,
-      tabIndex,
-      target
-    } = _this$props,
-          sharedProps = _objectWithoutPropertiesLoose(_this$props, _excluded);
-
+      {
+        onClick,
+        href,
+        skipClientNav,
+        tabIndex,
+        target
+      } = _this$props,
+      sharedProps = _objectWithoutPropertiesLoose(_this$props, _excluded);
     const ClickableBehavior = getClickableBehavior(href, skipClientNav, router);
     return React.createElement(ClickableBehavior, {
       disabled: sharedProps.disabled,
@@ -175,8 +216,7 @@ class IconButton extends React.Component {
       role: "button",
       target: target
     }, (state, _ref) => {
-      let childrenProps = _extends({}, _ref);
-
+      let childrenProps = _extends({}, (_objectDestructuringEmpty(_ref), _ref));
       return React.createElement(IconButtonCore, _extends({}, sharedProps, state, childrenProps, {
         skipClientNav: skipClientNav,
         href: href,
@@ -184,13 +224,12 @@ class IconButton extends React.Component {
         tabIndex: tabIndex
       }));
     });
-  }
-
-  render() {
+  };
+  _proto.render = function render() {
     return React.createElement(__RouterContext.Consumer, null, router => this.renderClickableBehavior(router));
-  }
-
-}
+  };
+  return IconButton;
+}(React.Component);
 IconButton.defaultProps = {
   color: "default",
   kind: "primary",

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import IconButton from "./components/icon-button";
+export { IconButton as default };