feat: text-to-diagram #7325
Merged
feat: text-to-diagram #7325
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
size-limit report 📦
|
dwelle
force-pushed
the
barnabasmolnar/hal-9000-tabs
branch
from
dade274
to
49bd824
Compare
dwelle
approved these changes
Nov 25, 2023
|
🔥 |
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.
This PR extends what was previously merely the Mermaid dialog with a Text to Diagram tab.
As discussed "offline", we're keeping the API surface really simple & small for now and we only expose very minimal control for host applications.
Given the following code in a host app:
The more tools toolbar will now feature a Text to Diagram button. Upon clicking said button, a dialog will open. The dialog has a tabbed interface where the user can choose between Text to Diagram and Mermaid. As already mentioned, we're keeping things closed & minimal for now, so tab names, layout, behaviour, etc cannot be customised from host apps. The general idea is that the host app can use the
onTextSubmitcallback onTTDDialogto get the input from the TTD text area, run some magic on it and spit back something that resolves to mermaid syntax/definition. At this point, clicking on Generate under the left tab will try and convert said mermaid syntax to an excalidraw diagram. Loading states & error handling are included.And that's about the gist of it.
Some testing notes:
Unfortunately the example app cannot load the mermaid package due to some bug so. I added a debug commit, instead, so that the whole flow can be tested in the editor proper. It's meant to be reverted before merging.
To show off functionality, I have some "fake" example code that will randomly succeed or fail, so just keep clicking Generate if it fails. 😄 Don't use linebreaks in your input, that will fail all the time.
Finally, note that if Generate succeeds, going over to the Mermaid tab, you'll now see the mermaid code that was generated in the previous step.