Create helper to build public widget options for expression #2139
+70
−1
Conversation
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
…lic widget options
…t option functions
… widget export function to filter out rubric data from widget options for the
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (c412751) and published it to npm. You Example: yarn add @khanacademy/perseus@PR2139If you are working in Khan Academy's webapp, you can run: ./dev/tools/bump_perseus_version.sh -t PR2139 |
|
Size Change: +170 B (+0.01%) Total Size: 1.47 MB
ℹ️ View Unchanged
|
Myranae
commented
Jan 22, 2025
Comment on lines
6
to
17
| /** | ||
| * For details on the individual options, see the | ||
| * PerseusOrdererWidgetOptions type | ||
| */ | ||
| type ExpressionPublicWidgetOptions = { | ||
| buttonSets: LegacyButtonSets; | ||
| functions: ReadonlyArray<string>; | ||
| times: boolean; | ||
| visibleLabel?: string; | ||
| ariaLabel?: string; | ||
| buttonsVisible?: "always" | "never" | "focused"; | ||
| }; |
There was a problem hiding this comment.
Left out answerFrom from the below widget options:
// The expression forms the answer may come in
answerForms: ReadonlyArray<PerseusExpressionAnswerForm>;
buttonSets: LegacyButtonSets;
// Variables that can be used as functions. Default: ["f", "g", "h"]
functions: ReadonlyArray<string>;
// Use x for rendering multiplication instead of a center dot.
times: boolean;
// visible label associated with the MathQuill field
visibleLabel?: string;
// aria label for screen readers attached to MathQuill field
ariaLabel?: string;
// Controls when buttons for special characters are visible when using a
// desktop browser. Defaults to "focused".
// NOTE: This isn't listed in perseus-format.js or perseus_data.go, but
// appears in item data in the datastore.
buttonsVisible?: "always" | "never" | "focused";
And here is PerseusExpressionAnswerForm. I don't think I need to pick out value from this, but if someone could confirm for me, that would be great.
value: string
form: boolean
simplify: boolean
considered: typeof PerseusExpressionAnswerFormConsidered[number]
key?: string
benchristel
reviewed
Jan 22, 2025
Comment on lines
+9
to
+10
| const options: PerseusExpressionWidgetOptions = | ||
| expressionItem2.question.widgets["expression 1"].options; |
There was a problem hiding this comment.
It looks like visibleLabel and ariaLabel are not included in the test data? I'd prefer to define the input inline rather than relying on shared data from expression.testdata.
Sharing data between tests makes them harder to understand (you have to look at multiple files to understand the test setup) and prone to false passes if the test data changes later.
Suggested change
| const options: PerseusExpressionWidgetOptions = | |
| expressionItem2.question.widgets["expression 1"].options; | |
| const options: PerseusExpressionWidgetOptions = { | |
| buttonSets: ["basic"], | |
| functions: ["f", "g", "h"], | |
| times: false, | |
| visibleLabel: "the visible label", | |
| ariaLabel: "the aria label", | |
| buttonsVisible: "always", | |
| }; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary:
Adds a function that takes expression's full widget options and filters out answer data. It also adds this function to the widget's widget export and adds a test confirming the function does what is expected.
Issue: LEMS-2758
Test plan: