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

Enable CSS-like linear gradient fills for flowchart nodes #5913

Draft
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

enourbakhsh
Copy link

@enourbakhsh enourbakhsh commented Oct 1, 2024

📑 Summary

This PR adds support for CSS-like linear-gradient fills to Mermaid, following the CSS linear-gradient syntax. It introduces a reusable gradient utility that can be applied to other diagrams in the future, though this PR focuses on flowcharts as an example of how the feature can be used.

Resolves #2907 and #4476

📏 Design Decisions

The implementation involves updating the lexer to recognize the linear-gradient syntax and modifying the renderer to correctly apply the gradient fills to flowchart nodes. The design follows a CSS-like approach to maintain familiarity for users.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.
Copy link

changeset-bot bot commented Oct 1, 2024

⚠️ No Changeset found

Latest commit: df3e5b4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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

netlify bot commented Oct 1, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit df3e5b4
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6724a516312daf00089b23a1
😎 Deploy Preview https://deploy-preview-5913--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.

@enourbakhsh enourbakhsh marked this pull request as draft October 1, 2024 04:45
Copy link

pkg-pr-new bot commented Oct 1, 2024

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5913
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5913
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5913
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5913

commit: df3e5b4

Copy link

argos-ci bot commented Oct 1, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 339 added, 339 removed, 1 failure Nov 1, 2024, 10:02 AM
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

Attention: Patch coverage is 0% with 821 lines in your changes missing coverage. Please review.

Project coverage is 4.43%. Comparing base (ece3b25) to head (df3e5b4).

Files with missing lines Patch % Lines
...kages/mermaid/src/rendering-util/createGradient.ts 0.00% 729 Missing ⚠️
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts 0.00% 92 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #5913      +/-   ##
==========================================
- Coverage     4.50%   4.43%   -0.07%     
==========================================
  Files          383     385       +2     
  Lines        53875   54704     +829     
  Branches       622     597      -25     
==========================================
  Hits          2425    2425              
- Misses       51450   52279     +829     
Flag Coverage Δ
unit 4.43% <0.00%> (-0.07%) ⬇️

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

Files with missing lines Coverage Δ
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts 0.00% <0.00%> (ø)
...kages/mermaid/src/rendering-util/createGradient.ts 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

@enourbakhsh enourbakhsh marked this pull request as ready for review November 1, 2024 09:46
@enourbakhsh enourbakhsh marked this pull request as draft November 1, 2024 09:47
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
1 participant