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.

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

Already on GitHub? Sign in to your account

feat: support sequence diagrams 🚀 #34

Merged
merged 42 commits into from
Nov 3, 2023
Merged

feat: support sequence diagrams 🚀 #34

merged 42 commits into from
Nov 3, 2023

Conversation

ad1992
Copy link
Member

@ad1992 ad1992 commented Oct 11, 2023

Support Mermaid Sequence diagrams

  • Support name and definition in testcases and beautify playground
  • Support containers, arrows and lines
  • transform the arrow type to correct excalidraw stroke style
  • don't show arrow head for solid open and dotted open
  • Render actors symbols in Excalidraw when present
    image
  • Grouping
  • Support grouping/box when diagram includes actor symbols
  • group actor image elements so it easy to move them
  • Aliases
sequenceDiagram
    participant A as Alice
    participant J as John
    A->>J: Hello John, how are you?
    J->>A: Great!
  • Notes

  • Add test cases for sequence

  • clean up playground

  • Activations

  • Loops

  • Alternate Paths

  • Parallel Actions

  • Breaks

  • Critical Regions

  • Self loops

  • Comments

  • Sequence numbers

  • background highlights

  • critical label shouldn't overlap with loop text

  • Remove font customization as Mermaid breaks with customizing font
    image

  • Entity codes to escape characters

I use the API diagram.parser.yy.getMessages and the text gets removed in this API when it containes entity codes (mermaid-js/mermaid#4983). So this API needs to be fixed in mermaid package. I can add a hacky fix rn to support it but will prefer using the message API to reduce the dependency on DOM. Opened a PR - mermaid-js/mermaid#5002.
Right now I have added the support in this PR by handling entity codes. Once PR is merged that part will be removed

Unsupported Features

@vercel
Copy link

vercel bot commented Oct 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
mermaid-to-excalidraw ✅ Ready (Inspect) Visit Preview Nov 3, 2023 11:57am

@ad1992
Copy link
Member Author

ad1992 commented Nov 3, 2023

Merging 🚀

@ad1992 ad1992 merged commit 75ead98 into master Nov 3, 2023
1 check passed
zsviczian added a commit to zsviczian/mermaid-to-excalidraw that referenced this pull request Nov 3, 2023
feat: support sequence diagrams 🚀 (excalidraw#34)
@ad1992 ad1992 deleted the aakansha/sequence branch November 28, 2023 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant