Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Docs for vNext 馃殌 #7911

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

docs: Docs for vNext 馃殌 #7911

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4c6462
Adding initial storeAction documentation
Mrazator Apr 18, 2024
550e23a
Expose StoreAction instead of StoreActionType
Mrazator Apr 22, 2024
15b7d14
Fractional indices normalization docs
Mrazator May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Next Next commit
Adding initial storeAction documentation
  • Loading branch information
@Mrazator
Mrazator committed Apr 18, 2024
commit d4c6462ab173fcf10efdfc0bef7566d3f2c7a139
15 changes: 14 additions & 1 deletion dev-docs/docs/@excalidraw/excalidraw/api/props/excalidraw-api.mdx
View file
Open in desktop
Expand Up @@ -65,7 +65,7 @@ You can use this function to update the scene with the sceneData. It accepts the
| `elements` | [`ImportedDataState["elements"]`](https://github.com/excalidraw/excalidraw/blob/master/packages/excalidraw/data/types.ts#L38) | The `elements` to be updated in the scene |
| `appState` | [`ImportedDataState["appState"]`](https://github.com/excalidraw/excalidraw/blob/master/packages/excalidraw/data/types.ts#L39) | The `appState` to be updated in the scene. |
| `collaborators` | <code>Map<string, <a href="https://github.com/excalidraw/excalidraw/blob/master/packages/excalidraw/types.ts#L37">Collaborator></a></code> | The list of collaborators to be updated in the scene. |
| `commitToStore` | `boolean` | Implies if the change should be captured and commited to the `store`. Commited changes are emmitted and listened to by other components, such as `History` for undo / redo purposes. Defaults to `false`. |
| `storeAction` | [`StoreActionType`](https://github.com/excalidraw/excalidraw/blob/master/packages/excalidraw/store.ts#L38) | Parameter to control which updates should be captured by the `Store`. Captured updates are emmitted as increments and listened to by other components, such as `History` for undo / redo purposes. |

```jsx live
function App() {
Expand Down Expand Up @@ -105,6 +105,7 @@ function App() {
appState: {
viewBackgroundColor: "#edf2ff",
},
storeAction: StoreAction.CAPTURE,
};
excalidrawAPI.updateScene(sceneData);
};
Expand All @@ -121,6 +122,17 @@ function App() {
}
```

#### storeAction

You can use the `storeAction` to influence undo / redo behaviour.

| | `storeAction` value | Notes |
| --- | --- | --- |
| _Immediately undoable_ | `"capture"` | Use for all updates which should be recorded. Should be used for the most of the local updates. These updates will _immediately_ make it to the local undo / redo stacks. |
| _Eventually undoable_ | `"none"` | Use for all updates which should not be recorded immediately (likely exceptions which are part of some async multi-step process) or those not meant to be recorded at all (i.e. updates to `collaborators` object, parts of `AppState` which are not observed by the store & history - not `ObservedAppState`). Otherwise, all such updates would end up being recorded with the next `"capture"` - triggered either by the next `updateScene` or internally by the editor. These updates will _eventually_ make it to the local undo / redo stacks. |
| _Never undoable_ | `"update"` | Use for all updates which should never be recorded, such as remote updates or scene initialization. These updates will _never_ make it to the local undo / redo stacks. |


### updateLibrary

<pre>
Expand Down Expand Up @@ -440,3 +452,4 @@ Returns an unsubscribe function.
Subscribes to canvas `pointerup` events.

Returns an unsubscribe function.