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 #5912

Closed

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: 4b4d347

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

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 4b4d347
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66fb778026d0aa00083b97cf
😎 Deploy Preview https://deploy-preview-5912--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.

Copy link

pkg-pr-new bot commented Oct 1, 2024

Open in Stackblitz

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

commit: 4b4d347

@enourbakhsh enourbakhsh marked this pull request as draft October 1, 2024 04:17
// Look for all gradient styles, ensuring that nested parentheses due to color functions are handled properly
const linearGradientStyles = vertex.cssCompiledStyles
?.join('')
?.match(/fill\s*:\s*linear-gradient\(([^()]*(\([^()]*\))*[^()]*)+\)/g);

Check failure

Code scanning / CodeQL

Inefficient regular expression High

This part of the regular expression may cause exponential backtracking on strings starting with 'fill:linear-gradient(' and containing many repetitions of '''.
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

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

Project coverage is 4.96%. Comparing base (17c6ed6) to head (4b4d347).
Report is 23 commits behind head on develop.

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

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #5912      +/-   ##
==========================================
- Coverage     5.00%   4.96%   -0.05%     
==========================================
  Files          338     339       +1     
  Lines        48221   48641     +420     
  Branches       551     552       +1     
==========================================
  Hits          2413    2413              
- Misses       45808   46228     +420     
Flag Coverage Δ
unit 4.96% <0.00%> (-0.05%) ⬇️

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 3 files with indirect coverage changes

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) 1 removed, 1 failure Oct 1, 2024, 4:28 AM

@enourbakhsh enourbakhsh closed this Oct 1, 2024
@enourbakhsh enourbakhsh deleted the add-linear-gradient branch October 1, 2024 04:36
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.

Gradient Styling
1 participant