Skip to content

[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonvarga merged 12 commits into from
Sep 18, 2023
Merged

[4.x] Fix nav item active status on user modified navs #8685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d6f3a80
[4.x] Open CP nav item when it has any active child
jacksleight Jun 6, 2023
88bd557
Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…
jesseleite Sep 5, 2023
324c731
Add `URL::removeQueryAndFragment()` helper.
jesseleite Sep 10, 2023
ef24ff9
Check nav item and associated children for explicit `isActive()` URL …
jesseleite Sep 10, 2023
33cac12
Ensure `resolveChildrenPattern` actually resolves children for `hasAc…
jesseleite Sep 10, 2023
2bf0700
Test it properly checks active status on moved items.
jesseleite Sep 10, 2023
884fd61
Temporarily test deprecated `active()` alias, since some addons may u…
jesseleite Sep 10, 2023
218db8b
Fix styling
jesseleite Sep 10, 2023
ee3c4d4
Merge branch '4.x' into fix/cp-nav-active-children-part-two
jasonvarga Sep 11, 2023
265553b
Backpeddle on deprecated method rename, and just better explain purpo…
jesseleite Sep 18, 2023
cf91901
Move method closer to usage.
jesseleite Sep 18, 2023
85d442b
nitpick
jasonvarga Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 62 additions & 29 deletions src/CP/Navigation/NavItem.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
->value($url);
}

/**
* Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
*
* @param string $url
* @return string
*/
protected function generateActivePatternForCpUrl($url)
{
$cpUrl = url(config('statamic.cp.route')).'/';

$relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

return $relativeUrl.'(/(.*)?|$)';
}

/**
* Get editable url for nav builder UI.
*/
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
->value($isChild);
}

/**
* Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
*
* @return $this
*/
public function active($pattern = null)
{
return $this->fluentlyGetOrSet('active')->value($pattern);
}

/**
* Determine when to resolve children for `hasActiveChild()` checks.
*
* @return bool
*/
protected function shouldResolveChildren()
{
if (! $this->active) {
return false;
}

$pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
}

/**
* Resolve children closure.
*
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
}

/**
* Get or set pattern for active state styling.
* Get whether the nav item is currently active.
*
* @param string|null $pattern
* @return mixed
* @return bool
*/
public function active($pattern = null)
public function isActive()
{
return $this->fluentlyGetOrSet('active')->value($pattern);
if ($this->hasActiveChild()) {
return true;
}

return request()->url() === URL::removeQueryAndFragment($this->url);
}

/**
* Get whether the nav item is currently active.
* Get whether the nav item has a currently active child.
*
* @return bool
*/
public function isActive()
protected function hasActiveChild()
{
if (! $this->active) {
return false;
if ($this->shouldResolveChildren()) {
$this->resolveChildren();
}

$pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
if (! $this->children() instanceof Collection) {
return false;
}

return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
return $this
->children()
->filter(fn ($item) => $item->isActive())
->isNotEmpty();
}

/**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

return $string;
}

/**
* Generate active pattern for CP url.
*
* @param string $url
* @return string
*/
protected function generateActivePatternForCpUrl($url)
{
$cpUrl = url(config('statamic.cp.route')).'/';

$url = Str::before($url, '?'); // Remove query params
$url = Str::before($url, '#'); // Remove anchors

$relativeUrl = str_replace($cpUrl, '', $url);

return $relativeUrl.'(/(.*)?|$)';
}
}
14 changes: 14 additions & 0 deletions src/Facades/Endpoint/URL.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

return $url;
}

/**
* Remove query and fragment from end of URL.
*
* @param string $url
* @return string
*/
public function removeQueryAndFragment($url)
{
$url = Str::before($url, '?'); // Remove query params
$url = Str::before($url, '#'); // Remove anchor fragment

return $url;
}
}
50 changes: 50 additions & 0 deletions tests/CP/Navigation/NavPreferencesTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
$this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
}

/** @test */
public function it_checks_active_status_on_moved_items()
{
Facades\Taxonomy::make('topics')->save();
Facades\Taxonomy::make('tags')->save();

$items = $this->buildNavWithPreferences([
'top_level' => [
'content::collections::articles' => [
'action' => '@move',
'children' => [
'content::taxonomies::topics' => '@move',
],
],
],
], true);

$articles = $items->get('Top Level')->keyBy->display()->get('Articles');
$topics = $articles->children()->first();
$taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
$tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

$this->assertFalse($articles->isActive());
$this->assertFalse($topics->isActive());
$this->assertFalse($taxonomies->isActive());
$this->assertFalse($tags->isActive());

Request::swap(Request::create('http://localhost/cp/collections/articles'));

$this->assertTrue($articles->isActive());
$this->assertFalse($topics->isActive());
$this->assertFalse($taxonomies->isActive());
$this->assertFalse($tags->isActive());

Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

$this->assertTrue($articles->isActive());
$this->assertTrue($topics->isActive());
$this->assertFalse($taxonomies->isActive());
$this->assertFalse($tags->isActive());

Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

$this->assertFalse($articles->isActive());
$this->assertFalse($topics->isActive());
$this->assertTrue($taxonomies->isActive());
$this->assertTrue($tags->isActive());
}

private function buildNavWithPreferences($preferences, $withHidden = false)
{
$this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down
70 changes: 65 additions & 5 deletions tests/CP/Navigation/NavTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
$this->assertFalse($hello->isActive());
$this->assertFalse($helloWithQueryParams->isActive());
$this->assertFalse($helloWithAnchor->isActive());
$this->assertTrue($hell->isActive());
$this->assertFalse($hell->isActive());
$this->assertFalse($localNotCp->isActive());
$this->assertFalse($external->isActive());
$this->assertFalse($externalSecure->isActive());

Request::swap(Request::create('http://localhost/cp/hello/test'));
$this->assertTrue($hello->isActive());
$this->assertTrue($helloWithQueryParams->isActive());
$this->assertTrue($helloWithAnchor->isActive());
$this->assertFalse($hello->isActive());
$this->assertFalse($helloWithQueryParams->isActive());
$this->assertFalse($helloWithAnchor->isActive());
$this->assertFalse($hell->isActive());
$this->assertFalse($localNotCp->isActive());
$this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
$this->assertFalse($externalSecure->isActive());
}

/** @test */
public function it_checks_if_has_active_children()
{
$collections = Nav::content('Collections')
->url('http://localhost/cp/collections')
->children(function () use (&$pages, &$articles) {
return [
$pages = Nav::item('Pages')->url('/cp/collections/pages'),
$articles = Nav::item('Articles')->url('/cp/collections/articles'),
];
});

Request::swap(Request::create('http://localhost/cp/collections/articles'));
$this->assertTrue($collections->isActive());
$this->assertFalse($pages->isActive());
$this->assertTrue($articles->isActive());
}

/** @test */
public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
{
$collections = Nav::content('Custom Collections Url')
->url('http://localhost/cp/custom/url')
->active('collections*')
->children(function () use (&$pages, &$articles) {
return [
$pages = Nav::item('Pages')->url('/cp/collections/pages'),
$articles = Nav::item('Articles')->url('/cp/collections/articles'),
];
});

Request::swap(Request::create('http://localhost/cp/collections/articles'));
$this->assertTrue($collections->isActive());
$this->assertFalse($pages->isActive());
$this->assertTrue($articles->isActive());
}

/**
* @deprecated
*
* @test
*/
public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
{
$collections = Nav::content('Custom Collections Url')
->url('http://localhost/cp/custom/url')
->active('collections*')
->children(function () use (&$pages, &$articles) {
return [
$pages = Nav::item('Pages')->url('/cp/collections/pages'),
$articles = Nav::item('Articles')->url('/cp/collections/articles'),
];
});

Request::swap(Request::create('http://localhost/cp/collections/articles'));
$this->assertTrue($collections->isActive());
$this->assertFalse($pages->isActive());
$this->assertTrue($articles->isActive());
}

/** @test */
public function it_sets_the_url()
{
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
}

/** @test */
public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
{
$nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
$this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down
19 changes: 19 additions & 0 deletions tests/Facades/UrlTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
];
}

/** @test */
public function it_can_remove_query_and_fragment()
{
$this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
$this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
$this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
$this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

$this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
$this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
$this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
$this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

$this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
$this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
$this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
$this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[4.x] Fix nav item active status on user modified navs by jesseleite · Pull Request #8685 · statamic/cms · GitHub
Skip to content
[4.x] Fix nav item active status on user modified navs#8685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 12 commits into

from

Sep 18, 2023
 Merged


[4.x] Fix nav item active status on user modified navs
#8685
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
d6f3a80

[4.x] Open CP nav item when it has any active child


jacksleight Jun 6, 2023
88bd557

Merge branch '4.x' of https://github.com/statamic/cms into cp-nav-act…


jesseleite Sep 5, 2023
324c731

Add `URL::removeQueryAndFragment()` helper.


jesseleite Sep 10, 2023
ef24ff9

Check nav item and associated children for explicit `isActive()` URL …


jesseleite Sep 10, 2023
33cac12

Ensure `resolveChildrenPattern` actually resolves children for `hasAc…


jesseleite Sep 10, 2023
2bf0700

Test it properly checks active status on moved items.


jesseleite Sep 10, 2023
884fd61

Temporarily test deprecated `active()` alias, since some addons may u…


jesseleite Sep 10, 2023
218db8b

Fix styling


jesseleite Sep 10, 2023
ee3c4d4

Merge branch '4.x' into fix/cp-nav-active-children-part-two


jasonvarga Sep 11, 2023
265553b

Backpeddle on deprecated method rename, and just better explain purpo…


jesseleite Sep 18, 2023
cf91901

Move method closer to usage.


jesseleite Sep 18, 2023
85d442b

nitpick


jasonvarga Sep 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


91 changes: 62 additions & 29 deletions
src/CP/Navigation/NavItem.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@

namespace Statamic\CP\Navigation;

use Illuminate\Support\Collection;
use Statamic\Facades\CP\Nav;
use Statamic\Facades\URL;
use Statamic\Statamic;
use Statamic\Support\Html;
use Statamic\Support\Str;
Expand DownExpand Up@@ -131,6 +133,21 @@ public function url($url = null)
 ->value($url);
 }

 /**
 * Generate active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $relativeUrl = str_replace($cpUrl, '', URL::removeQueryAndFragment($url));

 return $relativeUrl.'(/(.*)?|$)';
 }

 /**
 * Get editable url for nav builder UI.
 */
Expand DownExpand Up@@ -239,6 +256,32 @@ public function isChild($isChild = null)
 ->value($isChild);
 }

 /**
 * Active URL pattern to determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return $this
 */
 public function active($pattern = null)
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 }

 /**
 * Determine when to resolve children for `hasActiveChild()` checks.
 *
 * @return bool
 */
 protected function shouldResolveChildren()
 {
 if (! $this->active) {
 return false;
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 }

 /**
 * Resolve children closure.
 *
Expand DownExpand Up@@ -300,30 +343,38 @@ public function can($ability = null, $arguments = [])
 }

 /**
 * Get or set pattern for active state styling.
 * Get whether the nav item is currently active.
 *
 * @param string|null $pattern
 * @return mixed
 * @return bool
 */
 public function active($pattern = null)
 public function isActive()
 {
 return $this->fluentlyGetOrSet('active')->value($pattern);
 if ($this->hasActiveChild()) {
 return true;
 }

 return request()->url() === URL::removeQueryAndFragment($this->url);
 }

 /**
 * Get whether the nav item is currently active.
 * Get whether the nav item has a currently active child.
 *
 * @return bool
 */
public function isActive()
protected function hasActiveChild()
 {
 if (! $this->active) {
return false;
 if ($this->shouldResolveChildren()) {
$this->resolveChildren();
 }

 $pattern = preg_quote(config('statamic.cp.route'), '#').'/'.$this->active;
 if (! $this->children() instanceof Collection) {
 return false;
 }

 return preg_match('#'.$pattern.'#', request()->decodedPath()) === 1;
 return $this
 ->children()
 ->filter(fn ($item) => $item->isActive())
 ->isNotEmpty();
 }

 /**
Expand DownExpand Up@@ -441,22 +492,4 @@ public static function snakeCase($string)

 return $string;
 }

 /**
 * Generate active pattern for CP url.
 *
 * @param string $url
 * @return string
 */
 protected function generateActivePatternForCpUrl($url)
 {
 $cpUrl = url(config('statamic.cp.route')).'/';

 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchors

 $relativeUrl = str_replace($cpUrl, '', $url);

 return $relativeUrl.'(/(.*)?|$)';
 }
}

14 changes: 14 additions & 0 deletions
src/Facades/Endpoint/URL.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,4 +301,18 @@ public function gravatar($email, $size = null)

 return $url;
 }

 /**
 * Remove query and fragment from end of URL.
 *
 * @param string $url
 * @return string
 */
 public function removeQueryAndFragment($url)
 {
 $url = Str::before($url, '?'); // Remove query params
 $url = Str::before($url, '#'); // Remove anchor fragment

 return $url;
 }
}

50 changes: 50 additions & 0 deletions
tests/CP/Navigation/NavPreferencesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace Tests\CP\Navigation;

use Illuminate\Support\Facades\Request;
use Statamic\Facades;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand DownExpand Up@@ -1637,6 +1638,55 @@ public function it_can_build_with_hidden_items()
 $this->assertEquals('@modify', $contentItems->keyBy->display()->get('Globetrotters')->manipulations()['action']);
 }

 /** @test */
 public function it_checks_active_status_on_moved_items()
 {
 Facades\Taxonomy::make('topics')->save();
 Facades\Taxonomy::make('tags')->save();

 $items = $this->buildNavWithPreferences([
 'top_level' => [
 'content::collections::articles' => [
 'action' => '@move',
 'children' => [
 'content::taxonomies::topics' => '@move',
 ],
 ],
 ],
 ], true);

 $articles = $items->get('Top Level')->keyBy->display()->get('Articles');
 $topics = $articles->children()->first();
 $taxonomies = $items->get('Content')->keyBy->display()->get('Taxonomies');
 $tags = $items->get('Content')->keyBy->display()->get('Taxonomies')->children()->first();

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/collections/articles'));

 $this->assertTrue($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/topics'));

 $this->assertTrue($articles->isActive());
 $this->assertTrue($topics->isActive());
 $this->assertFalse($taxonomies->isActive());
 $this->assertFalse($tags->isActive());

 Request::swap(Request::create('http://localhost/cp/taxonomies/tags'));

 $this->assertFalse($articles->isActive());
 $this->assertFalse($topics->isActive());
 $this->assertTrue($taxonomies->isActive());
 $this->assertTrue($tags->isActive());
 }

 private function buildNavWithPreferences($preferences, $withHidden = false)
 {
 $this->actingAs(tap(Facades\User::make()->makeSuper())->save());
Expand Down

70 changes: 65 additions & 5 deletions
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -433,15 +433,15 @@ public function it_checks_if_active()
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertTrue($hell->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
 $this->assertFalse($externalSecure->isActive());

 Request::swap(Request::create('http://localhost/cp/hello/test'));
 $this->assertTrue($hello->isActive());
 $this->assertTrue($helloWithQueryParams->isActive());
 $this->assertTrue($helloWithAnchor->isActive());
 $this->assertFalse($hello->isActive());
 $this->assertFalse($helloWithQueryParams->isActive());
 $this->assertFalse($helloWithAnchor->isActive());
 $this->assertFalse($hell->isActive());
 $this->assertFalse($localNotCp->isActive());
 $this->assertFalse($external->isActive());
Expand All@@ -466,6 +466,66 @@ public function it_checks_if_active()
 $this->assertFalse($externalSecure->isActive());
 }

 /** @test */
 public function it_checks_if_has_active_children()
 {
 $collections = Nav::content('Collections')
 ->url('http://localhost/cp/collections')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_can_get_has_active_children_status_with_custom_resolve_children_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /**
 * @deprecated
 *
 * @test
 */
 public function it_can_get_has_active_children_status_with_deprecated_active_pattern()
 {
 $collections = Nav::content('Custom Collections Url')
 ->url('http://localhost/cp/custom/url')
 ->active('collections*')
 ->children(function () use (&$pages, &$articles) {
 return [
 $pages = Nav::item('Pages')->url('/cp/collections/pages'),
 $articles = Nav::item('Articles')->url('/cp/collections/articles'),
 ];
 });

 Request::swap(Request::create('http://localhost/cp/collections/articles'));
 $this->assertTrue($collections->isActive());
 $this->assertFalse($pages->isActive());
 $this->assertTrue($articles->isActive());
 }

 /** @test */
 public function it_sets_the_url()
 {
Expand DownExpand Up@@ -502,7 +562,7 @@ public function it_gets_a_cleaner_editable_version_of_the_url()
 }

 /** @test */
 public function it_does_not_automatically_add_an_active_pattern_when_setting_url_if_one_is_already_defined()
 public function it_does_not_automatically_add_a_resolve_children_pattern_when_setting_url_if_one_is_already_defined()
 {
 $nav = Nav::create('cp-relative')->active('foo.*')->url('foo/bar');
 $this->assertEquals('http://localhost/cp/foo/bar', $nav->url());
Expand Down

19 changes: 19 additions & 0 deletions
tests/Facades/UrlTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -229,4 +229,23 @@ public function relativeProvider()
 ['/foo/bar/?bar=baz#fragment', '/foo/bar/?bar=baz#fragment'],
 ];
 }

 /** @test */
 public function it_can_remove_query_and_fragment()
 {
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?query'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com#anchor'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com', URL::removeQueryAndFragment('https://example.com?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?query'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/#anchor'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/', URL::removeQueryAndFragment('https://example.com/?foo=bar&baz=qux#anchor'));

 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?query'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about#anchor'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux'));
 $this->assertEquals('https://example.com/about', URL::removeQueryAndFragment('https://example.com/about?foo=bar&baz=qux#anchor'));
 }
}