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

Feature/4653 add actor-top class to sequence diagram #5241

Conversation

Ronid1
Copy link
Contributor

@Ronid1 Ronid1 commented Jan 26, 2024

📑 Summary

Added actor-top class to top-level actor boxes and actor figures in sequence diagram.
Resolves #4653

📏 Design Decisions

For the rectangle actors, added the actor-top class to the rectangle
For the man figure actors, added the actor-top class to the <g> wrapper

📋 Tasks

Make sure you

Copy link

netlify bot commented Jan 26, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 941d9d1
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/65ba0a4d634668000888da5f
😎 Deploy Preview https://deploy-preview-5241--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the Type: Enhancement New feature or request label Jan 26, 2024
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (aa50db8) 43.21% compared to head (941d9d1) 79.47%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #5241       +/-   ##
============================================
+ Coverage    43.21%   79.47%   +36.26%     
============================================
  Files           23      167      +144     
  Lines         5033    13907     +8874     
  Branches        23      710      +687     
============================================
+ Hits          2175    11053     +8878     
+ Misses        2857     2702      -155     
- Partials         1      152      +151     
Flag Coverage Δ
e2e 85.28% <100.00%> (?)
unit 43.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
packages/mermaid/src/diagrams/sequence/svgDraw.js 90.98% <100.00%> (ø)

... and 162 files with indirect coverage changes

Copy link
Member

@sidharthv96 sidharthv96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!
Should we add an actor-bottom class as well in the footer?
An integration test to verify the class has been added is required. You can do an imgSnapshotTest, and check that the class has been added using a check similar to

cy.get('.actor-top').should('have.text', '<Name of actor>');

You can add this line to any existing test, that's fine. No need for a new test.

@Ronid1
Copy link
Contributor Author

Ronid1 commented Jan 26, 2024

@sidharthv96 I agree that adding a actor-bottom class makes sense. Happy to implement it if desired.

As per the integration test, adding a new one seemed cleaner to me, tested both scenarios of rectangle actor and man actor.

@sidharthv96
Copy link
Member

Yes, can you please add bottom as well?

@Ronid1
Copy link
Contributor Author

Ronid1 commented Jan 29, 2024

added actor-bottom class

@sidharthv96 sidharthv96 added this pull request to the merge queue Jan 30, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 30, 2024
@sidharthv96 sidharthv96 added this pull request to the merge queue Jan 30, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 30, 2024
@sidharthv96 sidharthv96 added this pull request to the merge queue Jan 31, 2024
Merged via the queue into mermaid-js:develop with commit 7503694 Jan 31, 2024
20 checks passed
@Ronid1 Ronid1 deleted the feature/4653-add_actor-top_class_to_sequence_diagram branch January 31, 2024 17:26
fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Feb 3, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.7.0` ->
`10.8.0`](https://renovatebot.com/diffs/npm/mermaid/10.7.0/10.8.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.8.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.8.0)

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.0)

### v10.8.0

#### Features

<img width="375" alt="image"
src="https://github.com/mermaid-js/mermaid/assets/5837277/c17405fb-2a06-4f7c-9c77-5eaba6c76747">

- Adding new diagram type - Block Diagram by
[@&#8203;knsv](https://togithub.com/knsv) in
[mermaid-js/mermaid#5221

- Feature/5114 add parallel commit config by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5161

- Changes to Gantt Parsers to allow hashes and semicolons to titles,
sections, and task data. by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[mermaid-js/mermaid#5095

- Feature/4653 add actor-top class to sequence diagram by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[mermaid-js/mermaid#5241

#### Documentation

- Updated gantt chart docs to show all config options by
[@&#8203;murdoa](https://togithub.com/murdoa) in
[mermaid-js/mermaid#5192
- Contribution documentation improvements by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#5132
- Update flowchart.md - how to use font-awesome
[#&#8203;5195](https://togithub.com/mermaid-js/mermaid/issues/5195) by
[@&#8203;arukiidou](https://togithub.com/arukiidou) in
[mermaid-js/mermaid#5196
- Add more detailed docs for Gantt tasks by
[@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) in
[mermaid-js/mermaid#5194
- Docs/4974 reorder integration links by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[mermaid-js/mermaid#5066
- docs: fix swimm link by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#5219
- Update Slack community links to Discord by
[@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) in
[mermaid-js/mermaid#5225
- Docs: Mermaid chart updates by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#5232
- Fix typos in timeline syntax samples by
[@&#8203;sblom](https://togithub.com/sblom) in
[mermaid-js/mermaid#5139

#### Bug fixes

- Bug/5059 fix external connection after updating edges by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5127
- \[Fix] Sequence diagram actor menu popup by
[@&#8203;vitorsss](https://togithub.com/vitorsss) in
[mermaid-js/mermaid#5160
- fix: Dompurify Hooks by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5236
- Accurate pie chart labeling for text alignment by
[@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) in
[mermaid-js/mermaid#5141
- fix: Redirect of old URLs by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5250
- Fixed Typo in ErrorRenderer.ts by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[mermaid-js/mermaid#5256

#### Chores

- Revert "Revert 5041 feature/4935 subgraph title margin config option"
by [@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5205
- build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[mermaid-js/mermaid#5200
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#5150
- E2E Image comparison by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5208
- E2E test by [@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5210
- Optimise caching of test results by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5213
- Update update-browserlist.yml to fix deprecation and action fails by
[@&#8203;Abrifq](https://togithub.com/Abrifq) in
[mermaid-js/mermaid#5151
- UpdateCypress by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5228
- Use node v20 by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5248
- Convert Mindmap to TS by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5247
- chore: Add interface naming Convention by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5254

#### New Contributors

- [@&#8203;murdoa](https://togithub.com/murdoa) made their first
contribution in
[mermaid-js/mermaid#5192
- [@&#8203;arukiidou](https://togithub.com/arukiidou) made their first
contribution in
[mermaid-js/mermaid#5196
- [@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) made their
first contribution in
[mermaid-js/mermaid#5194
- [@&#8203;Ronid1](https://togithub.com/Ronid1) made their first
contribution in
[mermaid-js/mermaid#5066
- [@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) made their first
contribution in
[mermaid-js/mermaid#5225
- [@&#8203;vitorsss](https://togithub.com/vitorsss) made their first
contribution in
[mermaid-js/mermaid#5160
- [@&#8203;sblom](https://togithub.com/sblom) made their first
contribution in
[mermaid-js/mermaid#5139
- [@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) made
their first contribution in
[mermaid-js/mermaid#5141

**Full Changelog**:
mermaid-js/mermaid@v10.7.0...v10.8.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement request: In sequence diagram, top-level actors are "sticky"
2 participants