@khanacademy/perseus-editor 4.1.5 → 4.1.7

package/src/components/graph-settings.tsx

@@ -1,627 +0,0 @@
-/* eslint-disable react/forbid-prop-types, react/no-unsafe */
-import {
-    components,
-    interactiveSizes,
-    Changeable,
-    Dependencies,
-    KhanMath,
-    Util,
-} from "@khanacademy/perseus";
-import createReactClass from "create-react-class";
-import PropTypes from "prop-types";
-import * as React from "react";
-import ReactDOM from "react-dom";
-import _ from "underscore";
-
-const {ButtonGroup, InfoTip, PropCheckBox, RangeInput} = components;
-const {getDependencies} = Dependencies;
-
-const defaultBackgroundImage = {
-    url: null,
-    width: 0,
-    height: 0,
-} as const;
-
-function numSteps(range: any, step: any) {
-    return Math.floor((range[1] - range[0]) / step);
-}
-
-const GraphSettings = createReactClass({
-    displayName: "GraphSettings",
-
-    propTypes: {
-        ...Changeable.propTypes,
-        editableSettings: PropTypes.arrayOf(
-            PropTypes.oneOf(["canvas", "graph", "snap", "image", "measure"]),
-        ),
-        box: PropTypes.arrayOf(PropTypes.number),
-        labels: PropTypes.arrayOf(PropTypes.string),
-        range: PropTypes.arrayOf(PropTypes.arrayOf(PropTypes.number)),
-        step: PropTypes.arrayOf(PropTypes.number),
-        gridStep: PropTypes.arrayOf(PropTypes.number),
-        snapStep: PropTypes.arrayOf(PropTypes.number),
-        valid: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-        backgroundImage: PropTypes.object,
-        markings: PropTypes.oneOf(["graph", "grid", "none"]),
-        showProtractor: PropTypes.bool,
-        showRuler: PropTypes.bool,
-        showTooltips: PropTypes.bool,
-        rulerLabel: PropTypes.string,
-        rulerTicks: PropTypes.number,
-    },
-
-    getDefaultProps: function () {
-        return {
-            editableSettings: ["graph", "snap", "image", "measure"],
-            box: [
-                interactiveSizes.defaultBoxSizeSmall,
-                interactiveSizes.defaultBoxSizeSmall,
-            ],
-            labels: ["x", "y"],
-            range: [
-                [-10, 10],
-                [-10, 10],
-            ],
-            step: [1, 1],
-            gridStep: [1, 1],
-            snapStep: [1, 1],
-            valid: true,
-            backgroundImage: defaultBackgroundImage,
-            markings: "graph",
-            showProtractor: false,
-            showRuler: false,
-            showTooltips: false,
-            rulerLabel: "",
-            rulerTicks: 10,
-        };
-    },
-
-    getInitialState: function () {
-        return this.stateFromProps(this.props);
-    },
-
-    componentDidMount: function () {
-        // TODO(scottgrant): This is a hack to remove the deprecated call to
-        // this.isMounted() but is still considered an anti-pattern.
-        this._isMounted = true;
-
-        this.changeGraph = _.debounce(this.changeGraph, 300);
-    },
-
-    UNSAFE_componentWillReceiveProps: function (nextProps) {
-        // Make sure that state updates when switching
-        // between different items in a multi-item editor.
-        if (
-            !_.isEqual(this.props.labels, nextProps.labels) ||
-            !_.isEqual(this.props.gridStep, nextProps.gridStep) ||
-            !_.isEqual(this.props.snapStep, nextProps.snapStep) ||
-            !_.isEqual(this.props.step, nextProps.step) ||
-            !_.isEqual(this.props.range, nextProps.range) ||
-            !_.isEqual(this.props.backgroundImage, nextProps.backgroundImage)
-        ) {
-            this.setState(this.stateFromProps(nextProps));
-        }
-    },
-
-    componentWillUnmount: function () {
-        this._isMounted = false;
-    },
-
-    stateFromProps: function (props) {
-        return {
-            labelsTextbox: props.labels,
-            gridStepTextbox: props.gridStep,
-            snapStepTextbox: props.snapStep,
-            stepTextbox: props.step,
-            rangeTextbox: props.range,
-            backgroundImage: _.clone(props.backgroundImage),
-        };
-    },
-
-    change(...args) {
-        return Changeable.change.apply(this, args);
-    },
-
-    // TODO(aria): Make either a wrapper for standard events to work
-    // with this.change, or make these use some TextInput/NumberInput box
-    changeRulerLabel: function (e) {
-        this.change({rulerLabel: e.target.value});
-    },
-
-    changeRulerTicks: function (e) {
-        this.change({rulerTicks: +e.target.value});
-    },
-
-    changeBackgroundUrl: function (e) {
-        // Only continue on blur or "enter"
-        if (e.type === "keypress" && e.key !== "Enter") {
-            return;
-        }
-
-        const setUrl = (url, width: number, height: number) => {
-            const image = _.clone(this.props.backgroundImage);
-            image.url = url;
-            image.width = width;
-            image.height = height;
-            this.setState(
-                {
-                    backgroundImage: image,
-                },
-                this.changeGraph,
-            );
-        };
-
-        // @ts-expect-error - TS2531 - Object is possibly 'null'. | TS2339 - Property 'value' does not exist on type 'Element | Text'.
-        const url = ReactDOM.findDOMNode(this.refs["bg-url"]).value; // eslint-disable-line react/no-string-refs
-        if (url) {
-            Util.getImageSize(url, (width, height) => {
-                if (this._isMounted) {
-                    setUrl(url, width, height);
-                }
-            });
-        } else {
-            setUrl(null, 0, 0);
-        }
-    },
-
-    renderLabelChoices: function (choices) {
-        return _.map(choices, function (nameAndValue) {
-            return <option value={nameAndValue[1]}>{nameAndValue[0]}</option>;
-        });
-    },
-
-    validRange: function (range) {
-        const numbers = _.every(range, function (num) {
-            return _.isFinite(num);
-        });
-        if (!numbers) {
-            return "Range must be a valid number";
-        }
-        if (range[0] >= range[1]) {
-            return "Range must have a higher number on the right";
-        }
-        return true;
-    },
-
-    validateStepValue: function (settings) {
-        const {step, range, name, minTicks, maxTicks} = settings;
-
-        if (!_.isFinite(step)) {
-            return name + " must be a valid number";
-        }
-        const nSteps = numSteps(range, step);
-        if (nSteps < minTicks) {
-            return (
-                name +
-                " is too large, there must be at least " +
-                minTicks +
-                " ticks."
-            );
-        }
-        if (nSteps > maxTicks) {
-            return (
-                name +
-                " is too small, there can be at most " +
-                maxTicks +
-                " ticks."
-            );
-        }
-        return true;
-    },
-
-    validSnapStep: function (step, range) {
-        return this.validateStepValue({
-            step: step,
-            range: range,
-            name: "Snap step",
-            minTicks: 5,
-            maxTicks: 60,
-        });
-    },
-
-    validGridStep: function (step, range) {
-        return this.validateStepValue({
-            step: step,
-            range: range,
-            name: "Grid step",
-            minTicks: 3,
-            maxTicks: 60,
-        });
-    },
-
-    validStep: function (step, range) {
-        return this.validateStepValue({
-            step: step,
-            range: range,
-            name: "Step",
-            minTicks: 3,
-            maxTicks: 20,
-        });
-    },
-
-    validBackgroundImageSize: function (image) {
-        // Ignore empty images
-        if (!image.url) {
-            return true;
-        }
-
-        const validSize = image.width <= 450 && image.height <= 450;
-
-        if (!validSize) {
-            return "Image must be smaller than 450px x 450px.";
-        }
-        return true;
-    },
-
-    validateGraphSettings: function (range, step, gridStep, snapStep, image) {
-        const self = this;
-        let msg;
-        const goodRange = _.every(range, function (range) {
-            msg = self.validRange(range);
-            return msg === true;
-        });
-        if (!goodRange) {
-            return msg;
-        }
-        const goodStep = _.every(step, function (step, i) {
-            msg = self.validStep(step, range[i]);
-            return msg === true;
-        });
-        if (!goodStep) {
-            return msg;
-        }
-        const goodGridStep = _.every(gridStep, function (gridStep, i) {
-            msg = self.validGridStep(gridStep, range[i]);
-            return msg === true;
-        });
-        if (!goodGridStep) {
-            return msg;
-        }
-        const goodSnapStep = _.every(snapStep, function (snapStep, i) {
-            msg = self.validSnapStep(snapStep, range[i]);
-            return msg === true;
-        });
-        if (!goodSnapStep) {
-            return msg;
-        }
-        const goodImageSize = this.validBackgroundImageSize(image);
-        if (goodImageSize !== true) {
-            msg = goodImageSize;
-            return msg;
-        }
-        return true;
-    },
-
-    changeLabel: function (i, e) {
-        const val = e.target.value;
-        const labels = this.state.labelsTextbox.slice();
-        labels[i] = val;
-        this.setState({labelsTextbox: labels}, this.changeGraph);
-    },
-
-    changeRange: function (i, values) {
-        const ranges = this.state.rangeTextbox.slice();
-        ranges[i] = values;
-        const step = this.state.stepTextbox.slice();
-        const gridStep = this.state.gridStepTextbox.slice();
-        const snapStep = this.state.snapStepTextbox.slice();
-        const scale = Util.scaleFromExtent(ranges[i], this.props.box[i]);
-        if (this.validRange(ranges[i]) === true) {
-            step[i] = Util.tickStepFromExtent(ranges[i], this.props.box[i]);
-            gridStep[i] = Util.gridStepFromTickStep(step[i], scale);
-            snapStep[i] = gridStep[i] / 2;
-        }
-        this.setState(
-            {
-                stepTextbox: step,
-                gridStepTextbox: gridStep,
-                snapStepTextbox: snapStep,
-                rangeTextbox: ranges,
-            },
-            this.changeGraph,
-        );
-    },
-
-    changeStep: function (step) {
-        this.setState({stepTextbox: step}, this.changeGraph);
-    },
-
-    changeSnapStep: function (snapStep) {
-        this.setState({snapStepTextbox: snapStep}, this.changeGraph);
-    },
-
-    changeGridStep: function (gridStep) {
-        this.setState(
-            {
-                gridStepTextbox: gridStep,
-                snapStepTextbox: _.map(gridStep, function (step) {
-                    return step / 2;
-                }),
-            },
-            this.changeGraph,
-        );
-    },
-
-    changeGraph: function () {
-        const labels = this.state.labelsTextbox;
-        const range = _.map(this.state.rangeTextbox, function (range) {
-            return _.map(range, Number);
-        });
-        const step = _.map(this.state.stepTextbox, Number);
-        const gridStep = this.state.gridStepTextbox;
-        const snapStep = this.state.snapStepTextbox;
-        const image = this.state.backgroundImage;
-
-        // validationResult is either:
-        //   true -> the settings are valid
-        //   a string -> the settings are invalid, and the explanation
-        //               is contained in the string
-        // TODO(aria): Refactor this to not be confusing
-        const validationResult = this.validateGraphSettings(
-            range,
-            step,
-            gridStep,
-            snapStep,
-            image,
-        );
-
-        if (validationResult === true) {
-            // either true or a string
-            this.change({
-                valid: true,
-                labels: labels,
-                range: range,
-                step: step,
-                gridStep: gridStep,
-                snapStep: snapStep,
-                backgroundImage: image,
-            });
-        } else {
-            this.change({
-                valid: validationResult, // a string message, not false
-            });
-        }
-    },
-
-    render: function () {
-        const scale = [
-            KhanMath.roundTo(
-                2,
-                Util.scaleFromExtent(this.props.range[0], this.props.box[0]),
-            ),
-            KhanMath.roundTo(
-                2,
-                Util.scaleFromExtent(this.props.range[1], this.props.box[1]),
-            ),
-        ];
-
-        const {TeX} = getDependencies();
-
-        return (
-            <div>
-                {_.contains(this.props.editableSettings, "canvas") && (
-                    <div className="graph-settings">
-                        <div className="perseus-widget-row">
-                            Canvas size (x,y pixels)
-                            <RangeInput
-                                value={this.props.box}
-                                onChange={(box) => {
-                                    this.change({box: box});
-                                }}
-                            />
-                        </div>
-                        <div className="perseus-widget-row">
-                            Scale (px per div):{" "}
-                            <TeX>{"(" + scale[0] + ", " + scale[1] + ")"}</TeX>
-                        </div>
-                    </div>
-                )}
-
-                {_.contains(this.props.editableSettings, "graph") && (
-                    <div className="graph-settings">
-                        <div className="perseus-widget-row">
-                            <div className="perseus-widget-left-col">
-                                {" "}
-                                x Label
-                                <input
-                                    type="text"
-                                    className="graph-settings-axis-label"
-                                    // eslint-disable-next-line react/no-string-refs
-                                    ref="labels-0"
-                                    onChange={(e) => this.changeLabel(0, e)}
-                                    value={this.state.labelsTextbox[0] || ""}
-                                />
-                            </div>
-                            <div className="perseus-widget-right-col">
-                                y Label
-                                <input
-                                    type="text"
-                                    className="graph-settings-axis-label"
-                                    // eslint-disable-next-line react/no-string-refs
-                                    ref="labels-1"
-                                    onChange={(e) => this.changeLabel(1, e)}
-                                    value={this.state.labelsTextbox[1] || ""}
-                                />
-                            </div>
-                        </div>
-
-                        <div className="perseus-widget-row">
-                            <div className="perseus-widget-left-col">
-                                x Range
-                                <RangeInput
-                                    value={this.state.rangeTextbox[0]}
-                                    onChange={(vals) =>
-                                        this.changeRange(0, vals)
-                                    }
-                                />
-                            </div>
-                            <div className="perseus-widget-right-col">
-                                y Range
-                                <RangeInput
-                                    value={this.state.rangeTextbox[1]}
-                                    onChange={(vals) =>
-                                        this.changeRange(1, vals)
-                                    }
-                                />
-                            </div>
-                        </div>
-                        <div className="perseus-widget-row">
-                            <div className="perseus-widget-left-col">
-                                Tick Step
-                                <RangeInput
-                                    value={this.state.stepTextbox}
-                                    onChange={this.changeStep}
-                                />
-                            </div>
-                            <div className="perseus-widget-right-col">
-                                Grid Step
-                                <RangeInput
-                                    value={this.state.gridStepTextbox}
-                                    onChange={this.changeGridStep}
-                                />
-                            </div>
-                        </div>
-                        {_.contains(this.props.editableSettings, "snap") && (
-                            <div className="perseus-widget-row">
-                                <div className="perseus-widget-left-col">
-                                    Snap Step
-                                    <RangeInput
-                                        value={this.state.snapStepTextbox}
-                                        onChange={this.changeSnapStep}
-                                    />
-                                </div>
-                            </div>
-                        )}
-                        <div className="perseus-widget-row">
-                            <label>Markings: </label>
-                            <ButtonGroup
-                                value={this.props.markings}
-                                allowEmpty={false}
-                                buttons={[
-                                    {value: "graph", content: "Graph"},
-                                    {value: "grid", content: "Grid"},
-                                    {value: "none", content: "None"},
-                                ]}
-                                onChange={this.change("markings")}
-                            />
-                        </div>
-                        <div className="perseus-widget-left-col">
-                            <PropCheckBox
-                                label="Show tooltips"
-                                showTooltips={this.props.showTooltips}
-                                onChange={this.change}
-                            />
-                        </div>
-                    </div>
-                )}
-
-                {_.contains(this.props.editableSettings, "image") && (
-                    <div className="image-settings">
-                        <div>Background image:</div>
-                        <div>
-                            Url:{" "}
-                            <input
-                                type="text"
-                                className="graph-settings-background-url"
-                                // eslint-disable-next-line react/no-string-refs
-                                ref="bg-url"
-                                value={this.state.backgroundImage.url || ""}
-                                onChange={(e) => {
-                                    const image = _.clone(
-                                        this.props.backgroundImage,
-                                    );
-                                    image.url = e.target.value;
-                                    this.setState({backgroundImage: image});
-                                }}
-                                onKeyPress={this.changeBackgroundUrl}
-                                onBlur={this.changeBackgroundUrl}
-                            />
-                            <InfoTip>
-                                <p>
-                                    Create an image in graphie, or use the "Add
-                                    image" function to create a background.
-                                </p>
-                            </InfoTip>
-                        </div>
-                    </div>
-                )}
-
-                {_.contains(this.props.editableSettings, "measure") && (
-                    <div className="misc-settings">
-                        <div className="perseus-widget-row">
-                            <div className="perseus-widget-left-col">
-                                <PropCheckBox
-                                    label="Show ruler"
-                                    showRuler={this.props.showRuler}
-                                    onChange={this.change}
-                                />
-                            </div>
-                            <div className="perseus-widget-right-col">
-                                <PropCheckBox
-                                    label="Show protractor"
-                                    showProtractor={this.props.showProtractor}
-                                    onChange={this.change}
-                                />
-                            </div>
-                        </div>
-                        {this.props.showRuler && (
-                            <div>
-                                <div>
-                                    <label>
-                                        {" "}
-                                        Ruler label:{" "}
-                                        <select
-                                            onChange={this.changeRulerLabel}
-                                            value={this.props.rulerLabel}
-                                        >
-                                            <option value="">None</option>
-                                            <optgroup label="Metric">
-                                                {this.renderLabelChoices([
-                                                    ["milimeters", "mm"],
-                                                    ["centimeters", "cm"],
-                                                    ["meters", "m"],
-                                                    ["kilometers", "km"],
-                                                ])}
-                                            </optgroup>
-                                            <optgroup label="Imperial">
-                                                {this.renderLabelChoices([
-                                                    ["inches", "in"],
-                                                    ["feet", "ft"],
-                                                    ["yards", "yd"],
-                                                    ["miles", "mi"],
-                                                ])}
-                                            </optgroup>
-                                        </select>
-                                    </label>
-                                </div>
-                                <div>
-                                    <label>
-                                        {" "}
-                                        Ruler ticks:{" "}
-                                        <select
-                                            onChange={this.changeRulerTicks}
-                                            value={this.props.rulerTicks}
-                                        >
-                                            {_.map(
-                                                [1, 2, 4, 8, 10, 16],
-                                                function (n) {
-                                                    return (
-                                                        <option value={n}>
-                                                            {n}
-                                                        </option>
-                                                    );
-                                                },
-                                            )}
-                                        </select>
-                                    </label>
-                                </div>
-                            </div>
-                        )}
-                    </div>
-                )}
-            </div>
-        );
-    },
-});
-
-export default GraphSettings;

package/src/components/graph-type-selector.tsx

@@ -1,31 +0,0 @@
-import * as React from "react";
-
-type GraphTypeSelectorProps = {
-    graphType: string;
-    onChange: (newGraphType: string) => void;
-};
-
-const GraphTypeSelector = (props: GraphTypeSelectorProps) => {
-    return (
-        <select
-            value={props.graphType}
-            onChange={(e) => {
-                const type = e.target.value;
-                props.onChange(type);
-            }}
-        >
-            <option value="linear">Linear function</option>
-            <option value="quadratic">Quadratic function</option>
-            <option value="sinusoid">Sinusoid function</option>
-            <option value="circle">Circle</option>
-            <option value="point">Point(s)</option>
-            <option value="linear-system">Linear System</option>
-            <option value="polygon">Polygon</option>
-            <option value="segment">Line Segment(s)</option>
-            <option value="ray">Ray</option>
-            <option value="angle">Angle</option>
-        </select>
-    );
-};
-
-export default GraphTypeSelector;