#3046 Add support for cyclic themeVariable rotation for more than 8 branches

cypress/integration/rendering/gitGraph.spec.js

@@ -102,4 +102,33 @@ describe('Git Graph diagram', () => {
       {}
     );
   });
+  it('8: should render a simple gitgraph with more than 8 branchs &  overriding variables', () => {
+    imgSnapshotTest(
+      `%%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
+        'gitBranchLabel0': '#ffffff',
+        'gitBranchLabel1': '#ffffff',
+        'gitBranchLabel2': '#ffffff',
+        'gitBranchLabel3': '#ffffff',
+        'gitBranchLabel4': '#ffffff',
+        'gitBranchLabel5': '#ffffff',
+        'gitBranchLabel6': '#ffffff',
+        'gitBranchLabel7': '#ffffff',
+  } } }%%
+  gitGraph
+    checkout main
+    branch branch1
+    branch branch2
+    branch branch3
+    branch branch4
+    branch branch5
+    branch branch6
+    branch branch7
+    branch branch8
+    branch branch9
+    checkout branch1
+    commit
+      `,
+      {}
+    );
+  });
 });

docs/gitgraph.md

@@ -640,7 +640,9 @@ See how the default theme is used to set the colors for the branches:
        branch featureA
        commit
 ```
-
+> #### IMPORTANT:
+> Mermaid supports the theme variables to override the default values for **upto 8 branches**, i.e., you can set the color/styling of upto 8 branches using theme variables. After this threshold of 8 branches,  the theme variables are reused in the cyclic manner, i.e. 9th branch will use the color/styling of 1st  branch, or branch at index postion '8' will use the color/styling of branch at index position '0'.
+ *More on this in the next section. See examples on **Customizing branch label colors** below*
 ### Customizing branch colors
 You can customize the branch colors using the `git0` to `git7` theme variables. Mermaid allows you to set the colors for up-to 8 branches, where `git0` variable will drive the value of the first branch, `git1` will drive the value of the second branch and so on.
 
@@ -685,27 +687,32 @@ Now let's override the default values for the `gitBranchLabel0` to `gitBranchLab
 
 ```mermaid-example
     %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
-              'gitBranchLabel0': '#ff0000',
+        'gitBranchLabel0': '#ffffff',
-              'gitBranchLabel1': '#00ff00',
+        'gitBranchLabel1': '#ffffff',
-              'gitBranchLabel2': '#0000ff'
+        'gitBranchLabel2': '#ffffff',
-       } } }%%
+        'gitBranchLabel3': '#ffffff',
-       gitGraph
+        'gitBranchLabel4': '#ffffff',
-       commit
+        'gitBranchLabel5': '#ffffff',
-       branch develop
+        'gitBranchLabel6': '#ffffff',
-       commit tag:"v1.0.0"
+        'gitBranchLabel7': '#ffffff',
-       commit
+        'gitBranchLabel8': '#ffffff',
-       checkout main
+        'gitBranchLabel9': '#ffffff'
-       commit type: HIGHLIGHT
+  } } }%%
-       commit
+  gitGraph
-       merge develop
+    checkout main
-       commit
+    branch branch1
-       branch featureA
+    branch branch2
-       commit
+    branch branch3
-
+    branch branch4
+    branch branch5
+    branch branch6
+    branch branch7
+    branch branch8
+    branch branch9
+    checkout branch1
+    commit
 ```
-See how the branch label colors are changed to the values specified in the theme variables.
+Here, you can see that `branch8` and `branch9` colors and the styles are being picked from branch at index position `0` (`main`) and `1`(`branch1`) respectively, i.e., **branch themeVariables are repeated cyclically**.
-
-
 ### Customizing Commit colors
 You can customize commit using the `commitLabelColor` and `commitLabelBackground` theme variables for changes in the commit label color and background color respectively.
 
@@ -787,3 +794,4 @@ See how the highlight commit color on the first branch is changed to the value s
 
 
 
+

src/diagrams/git/gitGraphRenderer.js

@@ -408,13 +408,15 @@ const drawBranches = (svg, branches) => {
   const gitGraphConfig = getConfig().gitGraph;
   const g = svg.append('g');
   branches.forEach((branch, index) => {
+
+    let adjustIndexForTheme = (index>=8?index-8:index);
     const pos = branchPos[branch.name].pos;
     const line = g.append('line');
     line.attr('x1', 0);
     line.attr('y1', pos);
     line.attr('x2', maxPos);
     line.attr('y2', pos);
-    line.attr('class', 'branch branch' + index);
+    line.attr('class', 'branch branch' + adjustIndexForTheme);
 
     lanes.push(pos);
 
@@ -427,11 +429,11 @@ const drawBranches = (svg, branches) => {
     const branchLabel = g.insert('g').attr('class', 'branchLabel');
 
     // Create inner g, label, this will be positioned now for centering the text
-    const label = branchLabel.insert('g').attr('class', 'label branch-label' + index);
+    const label = branchLabel.insert('g').attr('class', 'label branch-label' + adjustIndexForTheme);
     label.node().appendChild(labelElement);
     let bbox = labelElement.getBBox();
     bkg
-      .attr('class', 'branchLabelBkg label' + index)
+      .attr('class', 'branchLabelBkg label' + adjustIndexForTheme)
       .attr('rx', 4)
       .attr('ry', 4)
       .attr('x', -bbox.width - 4)