@khanacademy/math-input 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @khanacademy/math-input
 
+## 4.2.0
+
+### Minor Changes
+
+-   d497118e: MathInput exports tools for generating MathFields, replacing the need for direct MathQuill access
+
+### Patch Changes
+
+-   e7d21b67: Add keypress logic from MathInput to key translator
+-   eceb4510: Updated aria-labels to be more descriptive and tests that used aria-labels.
+
+## 4.1.1
+
+### Patch Changes
+
+-   31ed8380: Add math-input v2 keypad tests
+-   937d2308: Added basic Cypress testing for the v2 math-input keypad
+
 ## 4.1.0
 
 ### Minor Changes

package/dist/components/input/math-wrapper.d.ts

@@ -9,7 +9,7 @@ import { MathFieldInterface, MathFieldCursor } from "./mathquill-types";
 declare class MathWrapper {
     mathField: MathFieldInterface;
     callbacks: any;
-    constructor(element: any, options?: {}, callbacks?: {});
+    constructor(element: any, callbacks?: {});
     focus(): void;
     blur(): void;
     /**

package/dist/components/input/math-wrapper.js.flow

@@ -17,7 +17,7 @@ import { MathFieldInterface, MathFieldCursor } from "./mathquill-types";
 declare class MathWrapper {
   mathField: MathFieldInterface;
   callbacks: any;
-  constructor(element: any, options?: {||}, callbacks?: {||}): this;
+  constructor(element: any, callbacks?: {||}): this;
   focus(): void;
   blur(): void;
 

package/dist/components/input/mathquill-instance.d.ts

@@ -1,3 +1,14 @@
-import { MathQuillInterface } from "./mathquill-types";
-declare const _default: MathQuillInterface;
-export default _default;
+import { MathQuillInterface, MathFieldConfig } from "./mathquill-types";
+export declare const mathQuillInstance: MathQuillInterface;
+/**
+ * Creates a new [MathField](http://docs.mathquill.com/en/latest/Api_Methods/#mqmathfieldhtml_element-config)
+ * instance within the given `container`.
+ *
+ * An optional configuration callback can be provided to customize
+ * the created MathField. A default configuration is passed to this
+ * callback which can then be adjusted as needed. The configuration
+ * returned from this callback is used to create the MathField.
+ * This allows callers to do minimal configuration as only configs
+ * that vary from the default need to be provided.
+ */
+export declare function createMathField(container: HTMLDivElement | HTMLSpanElement, configCallback?: (baseConfig: MathFieldConfig) => MathFieldConfig): import("./mathquill-types").MathFieldInterface;

package/dist/components/input/mathquill-instance.js.flow

@@ -4,6 +4,21 @@
  * Flowgen v1.21.0
  * @flow
  */
-import { MathQuillInterface } from "./mathquill-types";
-declare var _default: MathQuillInterface;
-declare export default typeof _default;
+import * as $Flowgen$Import$_2e__2f_mathquill_2d_types from "./mathquill-types";
+import { MathQuillInterface, MathFieldConfig } from "./mathquill-types";
+declare export var mathQuillInstance: MathQuillInterface;
+/**
+ * Creates a new [MathField](http://docs.mathquill.com/en/latest/Api_Methods/#mqmathfieldhtml_element-config)
+ * instance within the given `container`.
+ *
+ * An optional configuration callback can be provided to customize
+ * the created MathField. A default configuration is passed to this
+ * callback which can then be adjusted as needed. The configuration
+ * returned from this callback is used to create the MathField.
+ * This allows callers to do minimal configuration as only configs
+ * that vary from the default need to be provided.
+ */
+declare export function createMathField(
+  container: HTMLDivElement | HTMLSpanElement,
+  configCallback?: (baseConfig: MathFieldConfig) => MathFieldConfig
+): $Flowgen$Import$_2e__2f_mathquill_2d_types.MathFieldInterface;

package/dist/components/input/mathquill-types.d.ts

@@ -2,13 +2,34 @@ import Key from "../../data/keys";
 export interface MathQuillInterface {
     L: "L";
     R: "R";
-    MathField: (mount: HTMLDivElement, options: any) => MathFieldInterface;
+    MathField: (mount: HTMLDivElement | HTMLSpanElement, config: MathFieldConfig) => MathFieldInterface;
 }
+type MathQuillDir = "L" | "R";
+export type MathFieldConfig = {
+    spaceBehavesLikeTab?: boolean;
+    leftRightIntoCmdGoes?: string;
+    restrictMismatchedBrackets?: boolean;
+    sumStartsWithNEquals?: boolean;
+    supSubsRequireOperand?: boolean;
+    charsThatBreakOutOfSupSub?: string;
+    autoSubscriptNumerals?: boolean;
+    autoCommands?: string;
+    autoOperatorNames?: string;
+    maxDepth?: number;
+    substituteTextarea?: () => HTMLElement;
+    handlers?: {
+        edit?: (mathField: MathFieldInterface) => void;
+        upOutOf?: (mathField: MathFieldInterface) => void;
+        moveOutOf?: (dir: MathQuillDir, mathField: MathFieldInterface) => void;
+    };
+};
 export interface MathFieldInterface {
-    write: (input: string) => void;
-    cmd: (input: string) => void;
-    keystroke: (input: string) => void;
-    typedText: (input: string) => void;
+    focus: () => MathFieldInterface;
+    blur: () => MathFieldInterface;
+    write: (input: string) => MathFieldInterface;
+    cmd: (input: string) => MathFieldInterface;
+    keystroke: (input: string) => MathFieldInterface;
+    typedText: (input: string) => MathFieldInterface;
     latex: (input?: string) => string;
     moveToDirEnd: (direction: "L" | "R") => void;
     select: () => void;
@@ -22,4 +43,5 @@ export declare enum MathFieldActionType {
     MQ_END = 0
 }
 export type MathFieldCursor = any;
-export type MathQuillUpdaterCallback = (mathQuill: MathFieldInterface, key: Key) => void;
+export type MathFieldUpdaterCallback = (mathField: MathFieldInterface, key: Key) => void;
+export {};

package/dist/components/input/mathquill-types.js.flow

@@ -8,13 +8,37 @@ import Key from "../../data/keys";
 export interface MathQuillInterface {
   L: "L";
   R: "R";
-  MathField: (mount: HTMLDivElement, options: any) => MathFieldInterface;
+  MathField: (
+    mount: HTMLDivElement | HTMLSpanElement,
+    config: MathFieldConfig
+  ) => MathFieldInterface;
 }
+declare type MathQuillDir = "L" | "R";
+export type MathFieldConfig = {|
+  spaceBehavesLikeTab?: boolean,
+  leftRightIntoCmdGoes?: string,
+  restrictMismatchedBrackets?: boolean,
+  sumStartsWithNEquals?: boolean,
+  supSubsRequireOperand?: boolean,
+  charsThatBreakOutOfSupSub?: string,
+  autoSubscriptNumerals?: boolean,
+  autoCommands?: string,
+  autoOperatorNames?: string,
+  maxDepth?: number,
+  substituteTextarea?: () => HTMLElement,
+  handlers?: {|
+    edit?: (mathField: MathFieldInterface) => void,
+    upOutOf?: (mathField: MathFieldInterface) => void,
+    moveOutOf?: (dir: MathQuillDir, mathField: MathFieldInterface) => void,
+  |},
+|};
 export interface MathFieldInterface {
-  write: (input: string) => void;
-  cmd: (input: string) => void;
-  keystroke: (input: string) => void;
-  typedText: (input: string) => void;
+  focus: () => MathFieldInterface;
+  blur: () => MathFieldInterface;
+  write: (input: string) => MathFieldInterface;
+  cmd: (input: string) => MathFieldInterface;
+  keystroke: (input: string) => MathFieldInterface;
+  typedText: (input: string) => MathFieldInterface;
   latex: (input?: string) => string;
   moveToDirEnd: (direction: "L" | "R") => void;
   select: () => void;
@@ -28,7 +52,7 @@ declare export var MathFieldActionType: {|
   +MQ_END: 0, // 0
 |};
 export type MathFieldCursor = any;
-export type MathQuillUpdaterCallback = (
-  mathQuill: MathFieldInterface,
+export type MathFieldUpdaterCallback = (
+  mathField: MathFieldInterface,
   key: Key
 ) => void;

package/dist/components/key-handlers/handle-arrow.d.ts

@@ -0,0 +1,3 @@
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
+export default function handleArrow(mathField: MathFieldInterface, key: Key): void;

package/dist/components/{input/key-handlers → key-handlers}/handle-arrow.js.flow

@@ -4,8 +4,8 @@
  * Flowgen v1.21.0
  * @flow
  */
-import Key from "../../../data/keys";
-import { MathFieldInterface } from "../mathquill-types";
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
 declare export default function handleArrow(
   mathField: MathFieldInterface,
   key: Key

package/dist/components/{input/key-handlers → key-handlers}/handle-backspace.d.ts

@@ -1,4 +1,4 @@
-import { MathFieldInterface } from "../mathquill-types";
+import { MathFieldInterface } from "../input/mathquill-types";
 /**
  * Selects and deletes part of the expression based on the cursor location.
  * See inline comments for precise behavior of different cases.

package/dist/components/{input/key-handlers → key-handlers}/handle-backspace.js.flow

@@ -4,7 +4,7 @@
  * Flowgen v1.21.0
  * @flow
  */
-import { MathFieldInterface } from "../mathquill-types";
+import { MathFieldInterface } from "../input/mathquill-types";
 
 /**
  * Selects and deletes part of the expression based on the cursor location.

package/dist/components/key-handlers/handle-exponent.d.ts

@@ -0,0 +1,3 @@
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
+export default function handleExponent(mathField: MathFieldInterface, key: Key): void;

package/dist/components/{input/key-handlers → key-handlers}/handle-exponent.js.flow

@@ -4,8 +4,8 @@
  * Flowgen v1.21.0
  * @flow
  */
-import Key from "../../../data/keys";
-import { MathFieldInterface } from "../mathquill-types";
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
 declare export default function handleExponent(
   mathField: MathFieldInterface,
   key: Key

package/dist/components/{input/key-handlers → key-handlers}/handle-jump-out.d.ts

@@ -1,5 +1,5 @@
-import Key from "../../../data/keys";
-import { MathFieldInterface } from "../mathquill-types";
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
 /**
  * Advances the cursor to the next logical position.
  */

package/dist/components/{input/key-handlers → key-handlers}/handle-jump-out.js.flow

@@ -4,8 +4,8 @@
  * Flowgen v1.21.0
  * @flow
  */
-import Key from "../../../data/keys";
-import { MathFieldInterface } from "../mathquill-types";
+import Key from "../../data/keys";
+import { MathFieldInterface } from "../input/mathquill-types";
 
 /**
  * Advances the cursor to the next logical position.

package/dist/components/key-handlers/key-translator.d.ts

@@ -0,0 +1,4 @@
+import Key from "../../data/keys";
+import { MathFieldUpdaterCallback } from "../input/mathquill-types";
+declare const keyToMathquillMap: Record<Key, MathFieldUpdaterCallback>;
+export default keyToMathquillMap;

package/dist/components/{key-translator.js.flow → key-handlers/key-translator.js.flow}

@@ -4,7 +4,7 @@
  * Flowgen v1.21.0
  * @flow
  */
-import Key from "../data/keys";
-import { MathQuillUpdaterCallback } from "./input/mathquill-types";
-declare var keyToMathquillMap: { [key: Key]: MathQuillUpdaterCallback };
+import Key from "../../data/keys";
+import { MathFieldUpdaterCallback } from "../input/mathquill-types";
+declare var keyToMathquillMap: { [key: Key]: MathFieldUpdaterCallback };
 declare export default typeof keyToMathquillMap;

package/dist/components/keypad/geometry-page/index.d.ts

@@ -1,6 +1,7 @@
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
 };
 export default class GeometryPage extends React.Component<Props> {
     render(): React.ReactNode;

package/dist/components/keypad/geometry-page/index.js.flow

@@ -5,8 +5,9 @@
  * @flow
  */
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 declare type Props = {|
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
 |};
 declare export default class GeometryPage extends React.Component<Props> {
   render(): React.Node;

package/dist/components/keypad/index.d.ts

@@ -1,10 +1,11 @@
 import * as React from "react";
 import Key from "../../data/keys";
+import { ClickKeyCallback } from "../../types";
 import { TabbarItemType } from "../tabbar/types";
 import { NumbersPageOptions } from "./numbers-page/types";
 import { OperatorsButtonSets } from "./operators-page/types";
 export type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
     trigonometry?: boolean;
     extraKeys: ReadonlyArray<Key>;
 } & OperatorsButtonSets & NumbersPageOptions;

package/dist/components/keypad/index.js.flow

@@ -6,12 +6,13 @@
  */
 import * as React from "react";
 import Key from "../../data/keys";
+import { ClickKeyCallback } from "../../types";
 import { TabbarItemType } from "../tabbar/types";
 import { NumbersPageOptions } from "./numbers-page/types";
 import { OperatorsButtonSets } from "./operators-page/types";
 export type Props = {|
   ...{|
-    onClickKey: (keyConfig: string) => void,
+    onClickKey: ClickKeyCallback,
     trigonometry?: boolean,
     extraKeys: $ReadOnlyArray<Key>,
   |},

package/dist/components/keypad/keypad-page-items.d.ts

@@ -1,29 +1,21 @@
 import * as React from "react";
-import { KeyConfig } from "../../types";
+import { KeyConfig, ClickKeyCallback } from "../../types";
 import type { StyleType } from "@khanacademy/wonder-blocks-core";
 type KeypadPageContainerProps = {
     children: React.ReactNode;
 };
 export declare const KeypadPageContainer: ({ children, }: KeypadPageContainerProps) => React.ReactElement;
-export type KeypadButtonProps = {
-    keyConfig: KeyConfig;
-    tintColor?: string;
-    style?: StyleType;
-    onClickKey: (keyConfig: string) => void;
-};
-export declare const KeypadButton: ({ keyConfig, onClickKey, tintColor, style, }: KeypadButtonProps) => React.ReactElement;
-type SecondaryKeypadButtonProps = {
+type SharedButtonProps = {
     keyConfig: KeyConfig;
     style?: StyleType;
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
 };
-export declare const SecondaryKeypadButton: ({ keyConfig, onClickKey, style, }: SecondaryKeypadButtonProps) => React.ReactElement;
-type KeypadActionButtonProps = {
-    keyConfig: KeyConfig;
-    style?: StyleType;
-    onClickKey: (keyConfig: string) => void;
+export type KeypadButtonProps = SharedButtonProps & {
+    tintColor?: string;
 };
-export declare const KeypadActionButton: ({ keyConfig, onClickKey, style, }: KeypadActionButtonProps) => React.ReactElement;
+export declare const KeypadButton: ({ keyConfig, onClickKey, tintColor, style, }: KeypadButtonProps) => React.ReactElement;
+export declare const SecondaryKeypadButton: ({ keyConfig, onClickKey, style, }: SharedButtonProps) => React.ReactElement;
+export declare const KeypadActionButton: ({ keyConfig, onClickKey, style, }: SharedButtonProps) => React.ReactElement;
 /**
  * A placeholder button for the keypad. Optional count prop to render multiple
  * buttons. Defaults to 1.

package/dist/components/keypad/keypad-page-items.js.flow

@@ -5,7 +5,7 @@
  * @flow
  */
 import * as React from "react";
-import { KeyConfig } from "../../types";
+import { KeyConfig, ClickKeyCallback } from "../../types";
 import type { StyleType } from "@khanacademy/wonder-blocks-core";
 declare type KeypadPageContainerProps = {|
   children: React.Node,
@@ -13,28 +13,23 @@ declare type KeypadPageContainerProps = {|
 declare export var KeypadPageContainer: (
   x: KeypadPageContainerProps
 ) => React.Element<any>;
-export type KeypadButtonProps = {|
+declare type SharedButtonProps = {|
   keyConfig: KeyConfig,
-  tintColor?: string,
   style?: StyleType,
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
 |};
-declare export var KeypadButton: (x: KeypadButtonProps) => React.Element<any>;
-declare type SecondaryKeypadButtonProps = {|
-  keyConfig: KeyConfig,
-  style?: StyleType,
-  onClickKey: (keyConfig: string) => void,
+export type KeypadButtonProps = {|
+  ...SharedButtonProps,
+  ...{|
+    tintColor?: string,
+  |},
 |};
+declare export var KeypadButton: (x: KeypadButtonProps) => React.Element<any>;
 declare export var SecondaryKeypadButton: (
-  x: SecondaryKeypadButtonProps
+  x: SharedButtonProps
 ) => React.Element<any>;
-declare type KeypadActionButtonProps = {|
-  keyConfig: KeyConfig,
-  style?: StyleType,
-  onClickKey: (keyConfig: string) => void,
-|};
 declare export var KeypadActionButton: (
-  x: KeypadActionButtonProps
+  x: SharedButtonProps
 ) => React.Element<any>;
 /**
  * A placeholder button for the keypad. Optional count prop to render multiple

package/dist/components/keypad/numbers-page/index.d.ts

@@ -1,7 +1,8 @@
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 import { NumbersPageOptions } from "./types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
 } & NumbersPageOptions;
 export default class NumbersPage extends React.Component<Props> {
     render(): React.ReactNode;

package/dist/components/keypad/numbers-page/index.js.flow

@@ -5,10 +5,11 @@
  * @flow
  */
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 import { NumbersPageOptions } from "./types";
 declare type Props = {|
   ...{|
-    onClickKey: (keyConfig: string) => void,
+    onClickKey: ClickKeyCallback,
   |},
   ...NumbersPageOptions,
 |};

package/dist/components/keypad/operators-page/advanced-relations-buttons.d.ts

@@ -1,6 +1,7 @@
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
     placeholder?: boolean;
 };
 export declare const AdvancedRelations: ({ onClickKey, placeholder, }: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/advanced-relations-buttons.js.flow

@@ -5,8 +5,9 @@
  * @flow
  */
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 declare type Props = {|
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
   placeholder?: boolean,
 |};
 declare export var AdvancedRelations: (x: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/basic-relations-buttons.d.ts

@@ -1,6 +1,7 @@
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
     placeholder?: boolean;
 };
 export declare const BasicRelations: ({ onClickKey, placeholder, }: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/basic-relations-buttons.js.flow

@@ -5,8 +5,9 @@
  * @flow
  */
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 declare type Props = {|
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
   placeholder?: boolean,
 |};
 declare export var BasicRelations: (x: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/index.d.ts

@@ -1,7 +1,8 @@
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 import { OperatorsButtonSets } from "./types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
 } & OperatorsButtonSets;
 export default class OperatorsPage extends React.Component<Props> {
     render(): React.ReactNode;

package/dist/components/keypad/operators-page/index.js.flow

@@ -5,10 +5,11 @@
  * @flow
  */
 import * as React from "react";
+import { ClickKeyCallback } from "../../../types";
 import { OperatorsButtonSets } from "./types";
 declare type Props = {|
   ...{|
-    onClickKey: (keyConfig: string) => void,
+    onClickKey: ClickKeyCallback,
   |},
   ...OperatorsButtonSets,
 |};

package/dist/components/keypad/operators-page/logarithms-buttons.d.ts

@@ -1,6 +1,7 @@
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
     placeholder?: boolean;
 };
 export declare const Logarithms: ({ onClickKey, placeholder, }: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/logarithms-buttons.js.flow

@@ -5,8 +5,9 @@
  * @flow
  */
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 declare type Props = {|
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
   placeholder?: boolean,
 |};
 declare export var Logarithms: (x: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/pre-algebra-buttons.d.ts

@@ -1,6 +1,7 @@
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 type Props = {
-    onClickKey: (keyConfig: string) => void;
+    onClickKey: ClickKeyCallback;
     placeholder?: boolean;
 };
 export declare const PreAlgebra: ({ onClickKey, placeholder, }: Props) => React.ReactElement;

package/dist/components/keypad/operators-page/pre-algebra-buttons.js.flow

@@ -5,8 +5,9 @@
  * @flow
  */
 import React from "react";
+import { ClickKeyCallback } from "../../../types";
 declare type Props = {|
-  onClickKey: (keyConfig: string) => void,
+  onClickKey: ClickKeyCallback,
   placeholder?: boolean,
 |};
 declare export var PreAlgebra: (x: Props) => React.ReactElement;