AltRedirect.vue - Added an instructions <h2> below the page title on management pages.

AltRedirectController.php - Supports instructions

index.blade.php - Supports instructions

README.md - Readme changes to document new query string features

Author: benmAltDesign

README.md

@@ -9,6 +9,7 @@
 - Supports headers on redirects
 - Regex Redirects
 - Imports and Exports
+- URI Query String Stripping
 
 ## How to Install
 
@@ -56,6 +57,48 @@ php artisan vendor:publish --tag=alt-redirect-config
 
 In the `headers` property, you can provide an array of headers to be passed to the `redirect` method.
 
+### Query String Stripping
+
+This is a new feature we've added to remove query strings from URIs before they're processed by the redirect middleware. 
+
+Because redirects are URI-based, an unexpected query string on a link would've cause your redirects to not function.
+
+With this feature, you can strip out troublesome query strings so your redirects work as intended.
+
+The Query Strings functionality can be found in the nav as a child underneath the Alt Redirect Addon
+```
+- Alt Redirect
+    - Query Strings <---
+```
+
+On this page you can manage the query strings you wish to strip, simply :
+- add the key of the query string `( eg 'foo' for ?foo=bar )`
+- Select your site
+- Hit save
+
+You'll see your query string in the list.
+
+#### Defaults
+
+We've provided a few default query strings that will be stripped. 
+They're added as regular items when you install the addon.
+
+If you don't want / need these, simply delete them!
+
+#### Artisan Command
+
+We have provided an Artisan command to force the creation of defaults.
+
+This will "force" create them, so they'll be installed even if the defaults have already been installed.
+
+This is great for if you've deleted the defaults but want them back or if composer didn't install them during the addon install for some reason.
+
+Simple run the command below and confirm when it asks you too :
+
+```bash
+php artisan alt-redirect:default-query-strings
+```
+
 ## Questions etc
 
 Drop us a big shout-out if you have any questions, comments, or concerns. We're always looking to improve our addons, so if you have any feature requests, we'd love to hear them.

resources/js/components/AltRedirect.vue

@@ -2,6 +2,7 @@
 export default ({
     props: {
         title: String,
+        instructions: String,
         action: String,
         blueprint: Array,
         meta: Array,
@@ -128,7 +129,10 @@ export default ({
 <template>
     <div id="alt-redirect">
 
-        <publish-form :title="title" :action="action" :blueprint="blueprint" :meta="meta" :values="values" @saved="updateItems($event)"></publish-form>
+        <h1 class="flex-1">{{ title }}</h1>
+        <h2 class="flex-1">{{ instructions }}</h2>
+
+        <publish-form :title="''" :action="action" :blueprint="blueprint" :meta="meta" :values="values" @saved="updateItems($event)"></publish-form>
 
         <div class="card overflow-hidden p-0">
             <div class="mt-4 pb-2 px-4">

resources/views/index.blade.php

@@ -4,6 +4,7 @@
     <div id="alt-redirect-app" >
         <alt-redirect
             title="{{ $title }}"
+            instructions="{{ $instructions }}"
             action="{{ cp_route($action) }}"
             :blueprint='@json($blueprint)'
             :meta='@json($meta)'

src/Http/Controllers/AltRedirectController.php

@@ -20,6 +20,11 @@ class AltRedirectController
         'query-strings' => 'Alt Redirect - Query Strings'
     ];
 
+    private array $instructions = [
+        'redirects' => 'Manage your redirects here. For detailed instructions, please consult the Alt Redirect Readme',
+        'query-strings' => 'Alt Redirect can strip query strings from your URIs before they are processed. These are listed below, add the key for query strings you want strip',
+    ];
+
     // Work out what page we're handling
     public function __construct()
     {
@@ -61,6 +66,7 @@ public function index()
             'type' => $this->type,
             'action' => $this->actions[$this->type],
             'title' => $this->titles[$this->type],
+            'instructions' => $this->instructions[$this->type],
         ]);
     }