Merge pull request #597 from hydephp/add-configuration-options-to-add…

…-html-to-the-head-and-scripts-sections Add configuration options to add HTML to the head and scripts sections
hydephp · Feb 13, 2024 · 2465936 · 2465936
2 parents 444873f + 17614df
commit 2465936
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 2 deletions.
diff --git a/config/hyde.php b/config/hyde.php
@@ -224,6 +224,23 @@
         Meta::property('site_name', env('SITE_NAME', 'HydePHP')),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Custom head and script HTML hooks
+    |--------------------------------------------------------------------------
+    |
+    | While the best way to add custom `<head>` and `<body>` code is to use the
+    | Blade components, you can also add them here. This is useful for adding
+    | scripts like analytics codes, chat widgets, or even custom styles.
+    |
+    */
+
+    // Add any extra HTML to include in the <head> tag
+    'head' => '',
+
+    // Add any extra HTML to include before the closing <body> tag
+    'scripts' => '',
+
     /*
     |--------------------------------------------------------------------------
     | Features

diff --git a/resources/views/layouts/head.blade.php b/resources/views/layouts/head.blade.php
@@ -16,4 +16,7 @@
     {{-- Check the local storage for theme preference to avoid FOUC --}}
     <meta id="meta-color-scheme" name="color-scheme" content="{{ config('hyde.default_color_scheme', 'light') }}">
     <script>if (localStorage.getItem('color-theme') === 'dark' || (!('color-theme' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches)) { document.documentElement.classList.add('dark'); document.getElementById('meta-color-scheme').setAttribute('content', 'dark');} else { document.documentElement.classList.remove('dark') } </script>
-@endif
+@endif
+
+{{-- If the user has defined any custom head tags, render them here --}}
+{!! config('hyde.head') !!}
diff --git a/resources/views/layouts/scripts.blade.php b/resources/views/layouts/scripts.blade.php
@@ -21,4 +21,7 @@ function toggleTheme() {
 </script>
 
 {{-- Add any extra scripts to include before the closing <body> tag --}}
-@stack('scripts')
+@stack('scripts')
+
+{{-- If the user has defined any custom scripts, render them here --}}
+{!! config('hyde.scripts') !!}
diff --git a/tests/Unit/Views/HeadComponentViewTest.php b/tests/Unit/Views/HeadComponentViewTest.php
@@ -72,6 +72,13 @@ public function testComponentIncludesStylesView()
         $this->assertStringContainsString("@include('hyde::layouts.styles')", $this->renderTestView());
     }
 
+    public function testCanAddHeadHtmlFromConfigHook()
+    {
+        config(['hyde.head' => '<meta name="custom-hook" content="foo">']);
+
+        $this->assertStringContainsString('<meta name="custom-hook" content="foo">', $this->renderTestView());
+    }
+
     protected function escapeIncludes(string $contents): string
     {
         return str_replace('@include', '@@include', $contents);

diff --git a/tests/Unit/Views/ScriptsComponentViewTest.php b/tests/Unit/Views/ScriptsComponentViewTest.php
@@ -56,6 +56,13 @@ public function test_component_uses_relative_path_to_app_js_file_for_nested_page
         Filesystem::unlink('_media/app.js');
     }
 
+    public function testCanAddHeadHtmlFromConfigHook()
+    {
+        config(['hyde.scripts' => '<script src="custom-hook.js"></script>']);
+
+        $this->assertStringContainsString('<script src="custom-hook.js"></script>', $this->renderTestView());
+    }
+
     public function test_scripts_can_be_pushed_to_the_component_scripts_stack()
     {
         view()->share('routeKey', '');