feat: undo/redo, action enhancements #128
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/timc/kbar/B5q4wxPacn31Qba9LKRTwDGHkN1F |
example/src/App.tsx
Outdated
| document.documentElement.setAttribute("data-theme-dark", ""), | ||
| perform: () => { | ||
| document.documentElement.setAttribute("data-theme-dark", ""); | ||
| return () => { |
There was a problem hiding this comment.
Return an optional cleanup function similar to useEffect which will give your action the ability to undo.
| @@ -160,7 +163,7 @@ const App = () => { | |||
| }; | |||
|
|
|||
| function RenderResults() { | |||
| const { results, rootActionId } = useDeepMatches(); | |||
| const { results, rootActionId } = useMatches(); | |||
timc1
changed the title
src/types.ts
Outdated
| undo: (item?: IHistoryItem) => void; | ||
| redo: (item?: IHistoryItem) => void; |
There was a problem hiding this comment.
Todo: History should probably only store and retrieve items; we should leave the undo/redo to the implementer, which in our case is the Command object.
| if (!currentRootActionId) return action.ancestors; | ||
| const index = action.ancestors.findIndex( | ||
| (ancestor) => ancestor.id === currentRootActionId | ||
| ); | ||
| // +1 removes the currentRootAction; e.g. | ||
| // if we are on the "Set theme" parent action, | ||
| // the UI should not display "Set theme… > Dark" | ||
| // but rather just "Dark" | ||
| return action.ancestors.slice(index + 1); | ||
| }, [action.ancestors, currentRootActionId]); |
There was a problem hiding this comment.
It would be wonderful to have this logic handled within ActionImpl, but ActionImpl shouldn't have context of currentRootActionId.
| return () => { | ||
| if (isDark) doc.setAttribute(attribute, ""); | ||
| }; |
There was a problem hiding this comment.
🍖 An action's undo is defined by the return function of its perform
Closes #129.
Introducing the Command interface, which extends a given
action.performand adds the ability to undo/redo.Command&HistoryUndo/redo