feat: Add support for styling Journey Diagram title (color, font-family, and font-size)

[Shahir-47]

📑 Summary

This PR introduces additional customization options for the title in Journey Diagrams. Users can now define titleColor, titleFontFamily, and titleFontSize in the themeVariables configuration to style the title's color, font family, and font size. If these properties are not defined, they default to textColor, "trebuchet ms, verdana, arial, sans-serif", and 16px, respectively. The feature includes corresponding updates in the rendering logic and documentation.

Resolves #3508

📏 Design Decisions

1. New Theme Variables:

   • titleColor: Sets the color of the Journey Diagram title. Defaults to textColor.
   • titleFontFamily: Sets the font family for the title. Defaults to "trebuchet ms, verdana, arial, sans-serif".
   • titleFontSize: Sets the font size for the title. Defaults to 16px.

2. Renderer Updates:

   • The Journey Diagram renderer now fetches these new properties using getConfig() and applies them during rendering.
   • Relevant code changes:

     const titleColor = getConfig().themeVariables.titleColor;
     const titleFontSize = getConfig().themeVariables.titleFontSize;
     const titleFontFamily = getConfig().themeVariables.titleFontFamily;
     
     if (title) {
       diagram
         .append('text')
         .text(title)
         .attr('x', LEFT_MARGIN)
         .attr('font-size', titleFontSize)
         .attr('font-weight', 'bold')
         .attr('y', 25)
         .attr('fill', titleColor)
         .attr('font-family', titleFontFamily);
     }

3. Default Values:

   • In packages/mermaid/src/themes/theme-default.js:

     this.titleColor = this.titleColor === 'calculated' ? this.textColor : this.titleColor;
     this.titleFontFamily = this.titleFontFamily || '"trebuchet ms", verdana, arial, sans-serif';
     this.titleFontSize = this.titleFontSize || '16px';

4. Documentation Updates:

   • Updated the Theme Variables section in packages/mermaid/src/docs/config/theming.md to include titleColor, titleFontFamily, and titleFontSize.

---

📋 Tasks

Make sure you

• [ x ] 📖 have read the contribution guidelines
• [ x ] 💻 have added necessary unit/e2e tests.
• [ x ] 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• [ x ] 🦋 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:.

Updated Documentation

File Updated: packages/mermaid/src/docs/config/theming.md

Added the following rows to the Theme Variables table:

| Variable             | Default value                      | Description                                                                                                                      |
| -------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| titleColor           | calculated from textColor          | Color to be used for the title text in Journey Diagrams.                                                                         |
| titleFontFamily      | trebuchet ms, verdana, arial       | Font family to be used for the title text in Journey Diagrams.                                                                   |
| titleFontSize        | 16px                               | Font size in pixels to be used for the title text in Journey Diagrams.                                                           |

---

Example Configuration

Users can customize the Journey Diagram title using the following configuration:

---
config:
  themeVariables:
    titleColor: "#ff0"
    titleFontFamily: "Arial, sans-serif"
    titleFontSize: "20px"
---

journey
    title User Journey Example
    section Onboarding
        Sign Up: 5: John, Sam
        Complete Profile: 4: John
    section Engagement
        Browse Features: 3: John
        Use Core Functionality: 4: John
    section Retention
        Revisit Application: 5: John
        Invite Friends: 3: John

With this configuration, the title "User Journey Example" will have a yellow color, Arial font, and 20px font size.

---

[changeset-bot]

⚠️ No Changeset found

Latest commit: 82d0192

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

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	82d0192
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/67ada579abb21d000877cd14
😎 Deploy Preview	https://deploy-preview-6225--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6225

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6225

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6225

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6225

commit: 82d0192

[autofix-ci]

Hi! I'm autofix.ci, a bot that automatically fixes trivial issues such as code formatting in pull requests.

I would like to apply some automated changes to this pull request, but it looks like I don't have the necessary permissions to do so. To get this pull request into a mergeable state, please do one of the following two things:

1. Allow edits by maintainers for your pull request, and then re-trigger CI (for example by pushing a new commit).
2. Manually fix the issues identified for your pull request (see the GitHub Actions output for details on what I would like to change).

[sidharthv96]

Please add visual tests that verify the parameters work.

[Shahir-47]

@sidharthv96 We’ve implemented the requested changes:

✅ Optimized getConfig() calls – Now, getConfig() is called once and stored in configObject, and its values are reused in draw().

✅ Added visual tests – We've included a test to verify that the User Journey Diagram title correctly applies the expected color, font family, and font size based on themeVariables.

Let us know if you have any feedback!

@pranavm2109 and I appreciate your guidance.

[codecov]

Codecov Report

Attention: Patch coverage is 26.66667% with 11 lines in your changes missing coverage. Please review.

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

Files with missing lines	Patch %	Lines
...rmaid/src/diagrams/user-journey/journeyRenderer.ts	0.00%	10 Missing ⚠️
...aid/src/diagrams/architecture/architectureTypes.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           develop   #6225   +/-   ##
=======================================
  Coverage     4.47%   4.47%           
=======================================
  Files          385     384    -1     
  Lines        54191   54186    -5     
  Branches       598     626   +28     
=======================================
+ Hits          2425    2427    +2     
+ Misses       51766   51759    -7     

Flag	Coverage Δ
unit	4.47% <26.66%> (+<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/config.ts	51.60% <100.00%> (ø)
packages/mermaid/src/themes/theme-default.js	94.55% <100.00%> (+0.02%)	⬆️
...aid/src/diagrams/architecture/architectureTypes.ts	0.00% <0.00%> (ø)
...rmaid/src/diagrams/user-journey/journeyRenderer.ts	0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

[Shahir-47]

Hey @sidharthv96, this PR is good to go—passes all GitHub Actions checks and CI/CD tests!

[pranavm2109]

Hey @sidharthv96, this PR is good to go—passes all GitHub Actions checks and CI/CD tests!

Hi @sidharthv96, is there anything else that remains to be done on our end? If not, could this PR please be merged?

[sidharthv96]

@pranavm2109 @Shahir-47 please check the allow edit by maintainers for this PR.

[sidharthv96]

The title gets cut off if the font size is large, but that's not a blocker, can be fixed in a different PR

[Shahir-47]

@pranavm2109 @Shahir-47 please check the allow edit by maintainers for this PR.

Just enabled it—sorry about that! Let me know if it works now.

[Shahir-47]

The title gets cut off if the font size is large, but that's not a blocker, can be fixed in a different PR

@pranavm2109 and I can look into that and fix it in a separate PR.

[sidharthv96]

Sorry, I just noticed that the global themevariable was the one being updated, for a diagram specific change, that shouldn't be the case. Please add them to the diagram's config.

[sidharthv96]

We can't have diagram specific variables in the main config.

Please add them to the diagram's config, which you can find in packages/mermaid/src/schemas/config.schema.yaml