MockWidget: renderer user input state #2586
Merged
Conversation
This file contains hidden or 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
|
Size Change: 0 B Total Size: 473 kB ℹ️ View Unchanged
|
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (a077d0e) and published it to npm. You Example: pnpm add @khanacademy/perseus@PR2586If you are working in Khan Academy's frontend, you can run the below command. ./tools/bump_perseus_version.js -t PR2586If you are working in Khan Academy's webapp, you can run the below command. ./dev/tools/bump_perseus_version.js -s n -t PR2586 |
SonicScrewdriver
approved these changes
Jun 18, 2025
handeyeco
added a commit
that referenced
this pull request
Jun 24, 2025
## Summary: Issue: [LEMS-3208](https://khanacademy.atlassian.net/browse/LEMS-3208) Edit see the ticket for full context. **tl;dr: I need user input to be outside the chunk of state that Renderer stores arbitrary widget state in** (currently it's a mash of render props, user input, and whatever else widgets want to shove in there). This ticket is the shared changes of this work - things that multiple widgets need. For the most part, I tried to have the other PRs _only_ affect things that are _specific_ to the individual widget. Anything outside of the immediate scope of the widget went into this PR. The main ideas: - Renderer now has `userInput` state which is a `UserInputMap` - `UniversalWidgetProps` now passes `userInput` and `handleUserInput` down to components for them to consume - `WidgetExports` has some new optional APIs: - `getUserInputFromSerializedState` for restoring serialized state - `getStartUserInput` for initializing user input - `getCorrectUserInput` for static widgets - Marked a bunch of things as deprecated Note that besides some cleanup, no tests were harmed in the making of this PR. It's backwards compatible with our old way of doing things. --- Reviewers: handeyeco, benchristel, SonicScrewdriver, jeremywiebe, ivyolamit, mark-fitzgerald, anakaren-rojas, nishasy Child PRs: - [Categorizer](#2572) - [CSProgram](#2584) - [Dropdown](#2568) - [Expression](#2569) - [FreeResponse](#2585) - [Grapher](#2596) - [IFrame](#2582) - [InputNumber](#2589) - [InteractiveGraph](#2598) - [LabelImage](#2577) - [Matcher](#2575) - [Matrix](#2581) - [MockWidget](#2586) - [NumberLine](#2573) - [NumericInput](#2571) - [Orderer](#2592) - [Plotter](#2588) - [Sorter](#2578) - [Table](#2587) [LEMS-3208]: https://khanacademy.atlassian.net/browse/LEMS-3208?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ Author: handeyeco Required Reviewers: Approved By: SonicScrewdriver, jeremywiebe Checks: ✅ 8 checks were successful Pull Request URL: #2566
handeyeco
changed the base branch from
renderer-user-input-core
to
feature/renderer-user-input
handeyeco
requested review from
ivyolamit,
mark-fitzgerald,
anakaren-rojas and
nishasy
as code owners
An error occurred while trying to automatically change base from
renderer-user-input-core
to
feature/renderer-user-input
June 24, 2025 17:08
handeyeco
force-pushed
the
rui-mock-widget
branch
from
717ea78 to
a077d0e
Compare
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:
See the parent PR for more context. Part of LEMS-3208.
In #2566 I add additional APIs to let widgets consume
userInputfrom a parent and to update that parent state usinghandleUserInput, while also supporting the legacy way of storing user input (which was a combination of internal widget state and stashing state in a random blob in Renderer). This PR is part of a series of PRs that go widget-by-widget to use the new API.This is a generic summary I'm putting on each PR and not every point will be applicable to every widget, but the common themes are:
getSerializedStateandgetUserInputFromSerializedStateto keep supporting the expected results.userInputstate in Renderer. This means consuminguserInputin the component and callinghandleUserInputon change.transformdid something to initialize user input state, I moved the logic togetStartUserInput.staticTransformdid something to get correct state in static widgets, I moved the logic togetCorrectUserInput.Please see the parent PR for more information.
MockWidget doesn't have an editor, so no impact on the editing experience.