Add 'when' param support to Toc tag and tests

.github/workflows/tests.yaml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         php: [8.1]
-        statamic: [4.0.*, 5.0.*]
+        statamic: [4.6.*, 5.*]
         os: [ubuntu-latest]
         laravel: [10.*]
         testbench: [8.*]

src/Tags/Toc.php

@@ -26,6 +26,12 @@ class Toc extends Tags
      */
     public function index()
     {
+        if ($this->params->get('when', true) === false) {
+            return [];
+        }
+
+        // get the supported header-levels
+
         // get the supported header-levels
         $depth = $this->params->int("depth", 3);
         $start = $this->params->get('from', "h1");

tests/Unit/RecursionTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Tests\Unit;
+
+use Goldnead\StatamicToc\Tests\TestCase;
+use Statamic\Facades\Antlers;
+
+class RecursionTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        app('statamic.tags')->put('toc', \Goldnead\StatamicToc\Tags\Toc::class);
+    }
+
+    /** @test */
+    public function it_renders_toc_with_when_param()
+    {
+        $content = '<h1>Heading 1</h1><h2>Heading 2</h2>';
+
+        $template = <<<'EOT'
+    <ol>
+    {{ toc field="content" :when="show_toc" }}
+        <li>
+            <a href="#{{ toc_id }}">{{ toc_title }}</a>
+            {{ if children }}
+            <ol>
+                {{ *recursive children* }}
+            </ol>
+            {{ /if }}
+        </li>
+    {{ /toc }}
+    </ol>
+EOT;
+
+        $data = [
+            'content' => $content,
+            'show_toc' => true,
+        ];
+
+        $output = (string) Antlers::parse($template, $data);
+
+        $this->assertStringContainsString('Heading 1', $output);
+
+        // Test false
+        $data['show_toc'] = false;
+        $output = (string) Antlers::parse($template, $data);
+        $this->assertStringNotContainsString('Heading 1', $output);
+    }
+}