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

6256 - Allow themeVariables to have additional valid CSS colors #6261

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

MikeSQ
Copy link

@MikeSQ MikeSQ commented Feb 7, 2025

📑 Summary

This is to resolve the recent issue I submitted. Before this PR there are several color options that can't be used without the sanitization stripping them out. After the PR, you should be able to set a themeVariable to:

  • var(--some-css-var)
  • light-dark(var(--lightColor), var(--darkColor))
  • lighten(var(--someColor), 10%)
  • oklch(from var(--base-color) calc(1 * 1.15) c h)

For me, this will enable easy theming of the diagrams based on user selection of light mode or dark mode, but in general it should open up a lot of theming possibilities for everybody I think.

This is my first PR on a major project, so apologies if I make any mistakes :)

Resolves #6256

📏 Design Decisions

The only change here was to the regular expression, I tried to do the bare minimum to allow the CSS. Dashes were added which covers most of the features above, I also added the ability to do *, +, /

📋 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 Feb 7, 2025

⚠️ No Changeset found

Latest commit: b6c35be

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: Bug / Error Something isn't working or is incorrect label Feb 7, 2025
Copy link

netlify bot commented Feb 7, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit b6c35be
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67a63f5154d7d900080ae731
😎 Deploy Preview https://deploy-preview-6261--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 Feb 7, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6261
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6261
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6261
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6261

commit: b6c35be

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 4.47%. Comparing base (8dd0e7a) to head (b6c35be).

Files with missing lines Patch % Lines
packages/mermaid/src/utils/sanitizeDirective.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6261   +/-   ##
=======================================
  Coverage     4.47%   4.47%           
=======================================
  Files          385     384    -1     
  Lines        54191   54180   -11     
  Branches       598     623   +25     
=======================================
  Hits          2425    2425           
+ Misses       51766   51755   -11     
Flag Coverage Δ
unit 4.47% <0.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
packages/mermaid/src/utils/sanitizeDirective.ts 13.09% <0.00%> (ø)

... and 1 file with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

themeVariable validation not allowing valid CSS attributes with dashes
1 participant