Table: renderer user input state #2587
Conversation
|
Size Change: +18 B (0%) Total Size: 473 kB
ℹ️ View Unchanged
|
handeyeco
requested review from
benchristel,
nishasy,
a team and
catandthemachines
and removed request for
nishasy
npm Snapshot: PublishedGood news!! We've packaged up the latest commit from this PR (e9abb24) and published it to npm. You Example: pnpm add @khanacademy/perseus@PR2587If you are working in Khan Academy's frontend, you can run the below command. ./tools/bump_perseus_version.js -t PR2587If you are working in Khan Academy's webapp, you can run the below command. ./dev/tools/bump_perseus_version.js -s n -t PR2587 |
|
|
||
| type Props = WidgetProps<PerseusTableWidgetOptions, PerseusTableUserInput> & | ||
| type Props = WidgetProps<RenderProps, PerseusTableUserInput> & | ||
| ChangeableProps & |
There was a problem hiding this comment.
It'd be lovely to get rid of changeable again here, but I understand if you don't want to stuff too much work into this already large task. :)
There was a problem hiding this comment.
I tried to remove uses that were only related to user input. In my next leg of work I'll being looking at UI state which should remove more uses of Changeable. Then the only thing that will be left are uses for the editor.
| } | ||
|
|
||
| function getUserInputFromSerializedState( | ||
| serializedState: any, |
There was a problem hiding this comment.
I'm not too fussed as I know we want to remove the serialized state eventually, but I do think avoiding "any" wherever possible is probably going to help us.
I also think this method should have the deprecated comment you've added to the other serialized states across your PRs
There was a problem hiding this comment.
any is actually kind of correct here. We don't have a type for this - it's just a blob of data. That's a big part of why I want to remove the serialization stuff.
Comment added!
## 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
handeyeco
merged commit 88a4f68
into
feature/renderer-user-input
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.
TableEditor does use Table, so this will affect the editing experience