[its-a-numeric-story] Improving Numeric Input Storybook Stories #2138
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@khanacademy/perseus": patch | ||
| --- | ||
|
|
||
| Cleanup of Numeric Input stories |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,188 @@ | ||
| import * as React from "react"; | ||
|
|
||
| import {RendererWithDebugUI} from "../../../../../testing/renderer-with-debug-ui"; | ||
|
|
||
| import {NumericInput} from "./numeric-input.class"; | ||
| import {decimalProblem, question1} from "./numeric-input.testdata"; | ||
|
|
||
| import type { | ||
| PerseusNumericInputWidgetOptions, | ||
| PerseusRenderer, | ||
| } from "@khanacademy/perseus-core"; | ||
| import type {Meta} from "@storybook/react"; | ||
|
|
||
| // We're using this format as storybook was not able to infer the type of the options. | ||
| // It also gives us a lovely hover view of the JSON structure. | ||
| const answerFormsArray: string = `[ | ||
| { | ||
| simplify: string; | ||
| name: string; | ||
| } | ||
| ]`; | ||
|
|
||
| const answersArray: string = `[ | ||
| { | ||
| message: string; | ||
| value: number; | ||
| status: string; | ||
| answerForms: array<string>; | ||
| strict: boolean; | ||
| maxError: number; | ||
| simplify: string; | ||
| } | ||
| ]`; | ||
|
|
||
| const meta: Meta<typeof NumericInput> = { | ||
| component: NumericInput, | ||
| title: "Perseus/Widgets/Numeric Input", | ||
| args: { | ||
| coefficient: false, | ||
| currentValue: "", | ||
| rightAlign: false, | ||
| size: "normal", | ||
| answers: [ | ||
| { | ||
| status: "correct", | ||
| maxError: null, | ||
| strict: false, | ||
| value: 1252, | ||
| simplify: "required", | ||
| message: "", | ||
| }, | ||
| ], | ||
| answerForms: [ | ||
| {simplify: "required", name: "decimal"}, | ||
| {simplify: "required", name: "integer"}, | ||
| {simplify: "required", name: "mixed"}, | ||
| {simplify: "required", name: "percent"}, | ||
| {simplify: "required", name: "pi"}, | ||
| ], | ||
| }, | ||
| argTypes: { | ||
| answers: { | ||
| control: {type: "object"}, | ||
| description: | ||
| "A list of all the possible correct and incorrect answers", | ||
| table: { | ||
| type: { | ||
| summary: "array", | ||
| detail: answersArray, | ||
| }, | ||
| }, | ||
| }, | ||
| answerForms: { | ||
| control: {type: "object"}, | ||
| description: | ||
| "Used by examples, maybe not used and should be removed in the future", | ||
| table: { | ||
| type: { | ||
| summary: "array", | ||
| detail: answerFormsArray, | ||
| }, | ||
| }, | ||
| }, | ||
| currentValue: { | ||
| control: {type: "text"}, | ||
| description: "The current value of the input field", | ||
| table: { | ||
| type: {summary: "string"}, | ||
| }, | ||
| }, | ||
| coefficient: { | ||
| control: {type: "boolean"}, | ||
| description: | ||
| "A coefficient style number allows the student to use - for -1 and an empty string to mean 1.", | ||
| table: { | ||
| type: {summary: "boolean"}, | ||
| }, | ||
| }, | ||
| labelText: { | ||
| control: {type: "text"}, | ||
| description: | ||
| " Translatable Text; Text to describe this input. This will be shown to users using screenreaders.", | ||
| value: "What's the answer?", | ||
| table: { | ||
| type: {summary: "string"}, | ||
| }, | ||
| }, | ||
| rightAlign: { | ||
| control: {type: "boolean"}, | ||
| description: "Whether to right-align the text or not", | ||
| table: { | ||
| type: {summary: "boolean"}, | ||
| }, | ||
| }, | ||
| size: { | ||
| options: ["normal", "small"], | ||
| control: {type: "radio"}, | ||
| defaultValue: "normal", | ||
| description: | ||
| "Use size 'Normal' for all text boxes, unless there are multiple text boxes in one line and the answer area is too narrow to fit them.", | ||
| table: { | ||
| type: {summary: "string"}, | ||
| defaultValue: {summary: "normal"}, | ||
| }, | ||
| }, | ||
| static: { | ||
| control: {type: "boolean"}, | ||
| description: "Always false. Not used for this widget", | ||
| table: { | ||
| type: {summary: "boolean"}, | ||
| }, | ||
| }, | ||
| // ApiOptions and linterContext are large objects and not particularly applicable to this story, | ||
| // so we're hiding them from view to simplify the UI. | ||
| apiOptions: { | ||
| table: { | ||
| disable: true, | ||
| }, | ||
| }, | ||
| linterContext: { | ||
| table: { | ||
| disable: true, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; | ||
|
|
||
| const updateWidgetOptions = ( | ||
| question: PerseusRenderer, | ||
| widgetId: string, | ||
| options: PerseusNumericInputWidgetOptions, | ||
| ): PerseusRenderer => { | ||
| const widget = question.widgets[widgetId]; | ||
| return { | ||
| ...question, | ||
| widgets: { | ||
| [widgetId]: { | ||
| ...widget, | ||
| options: { | ||
| ...widget.options, | ||
| ...options, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| export const Default = ( | ||
| args: PerseusNumericInputWidgetOptions, | ||
| ): React.ReactElement => { | ||
| const question = updateWidgetOptions(question1, "numeric-input 1", args); | ||
| return <RendererWithDebugUI question={question} />; | ||
| }; | ||
| Default.args = question1.widgets["numeric-input 1"].options; | ||
|
|
||
| export const WithExample = ( | ||
| args: PerseusNumericInputWidgetOptions, | ||
| ): React.ReactElement => { | ||
| const question = updateWidgetOptions( | ||
| decimalProblem, | ||
| "numeric-input 1", | ||
| args, | ||
| ); | ||
| return <RendererWithDebugUI question={question} />; | ||
| }; | ||
| WithExample.args = decimalProblem.widgets["numeric-input 1"].options; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After setting up all the Storybook controls, I wasn't really sure if we needed any more stories as we can control most of these options on the fly now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah! Perhaps a story for each answerForm, as it IS a little frustrating to edit the json views for that. If possible, it'd be good to get an example of the pi answerForm with a note about how to trigger the "It seems like you've approximated pi" message.