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

Component Diagram Interfaces #6202

Open
ziidonato opened this issue Jan 19, 2025 · 0 comments
Open

Component Diagram Interfaces #6202

ziidonato opened this issue Jan 19, 2025 · 0 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request

Comments

@ziidonato
Copy link

Proposal

Problem

  • There is no real support for lollipop/ball & socket interfaces. Common in component diagrams, they look like this:

Image

You can see as an example, send & receive email are interfaces, with the email inbox being the "pusher" and the email management component being the receiver.

Currently, MermaidJS has the ball (or lollipop, as you call it), but no socket. I don't believe this is sufficient.

Solution

  • Please integrate the socket, so making these components in mermaid can be a lot smoother.
  • Speaking of which, there doesn't seem to be any official support for component diagrams. Is it assumed that they are the same as/an extension of class diagrams? That's fair, but please integrate the full functionality of a component diagram (such as nested components, ports, those

Example

component Source {
     ProcessArguments:
     ArgProcessor -o)- Client

     ProcessResponse
     Client -o)- ResponseProcessor
}

component DataCruncher {
     ParseConfig:
     ConfigParser -(o- ByteReader
}

component Publisher {
     Broadcast:
     DataProcessor -(o- Broadcaster
}

FetchData:
DataCruncher -o)- Source

PublishData:
PublishData -o) Source

Results in this:
Image

Screenshots

No response

@ziidonato ziidonato added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant