Skip to content

[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into from
Nov 1, 2023
Merged

[4.x] Add helper arg for addons to easily remove child item in core nav #8883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd00e79
Add arg to easily remove child CP nav item.
jesseleite Oct 25, 2023
8ef2e15
Test new public `find()` method as well.
jesseleite Oct 25, 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
49 changes: 45 additions & 4 deletions src/CP/Navigation/Nav.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
}

/**
* Find or create nav item.
* Find nav item.
*
* @param string $section
* @param string $name
* @return NavItem|null
*/
public function findOrCreate($section, $name)
public function find($section, $name)
{
$item = collect($this->items)->first(function ($item) use ($section, $name) {
return $item->section() === $section
&& $item->display() === $name
&& ! $item->isChild();
});

return $item ?: $this->create($name)->section($section);
return $item;
}

/**
* Find or create nav item.
*
* @param string $section
* @param string $name
* @return NavItem
*/
public function findOrCreate($section, $name)
{
return $this->find($section, $name) ?: $this->create($name)->section($section);
}

/**
* Remove nav item.
*
* @param string $section
* @param string|null $name
* @param string|null $childName
* @return $this
*/
public function remove($section, $name = null)
public function remove($section, $name = null, $childName = null)
{
if ($childName) {
return $this->removeChildItem($section, $name, $childName);
}

$this->items = collect($this->items)
->reject(function ($item) use ($section, $name) {
return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
return $this;
}

/**
* Remove nav item.
*
* @param string $section
* @param string|null $name
* @param string|null $childName
* @return $this
*/
protected function removeChildItem($section, $name, $childName)
{
if (! $parent = $this->find($section, $name)) {
return $this;
}

if (! $children = $parent->resolveChildren()->children()) {
return $this;
}

$parent->children($children->reject(fn ($child) => $child->display() === $childName));

return $this;
}

/**
* Build navigation.
*
Expand Down
85 changes: 84 additions & 1 deletion tests/CP/Navigation/NavTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
}

/** @test */
public function it_can_get_and_modify_an_existing_item()
public function it_can_find_and_modify_an_existing_item()
{
$this->actingAs(tap(User::make()->makeSuper())->save());

Nav::droids('WAC-47')
->url('/pit-droid')
->icon('<svg>...</svg>');

Nav::find('Droids', 'WAC-47')
->url('/d-squad');

$item = $this->build()->get('Droids')->first();

$this->assertEquals('Droids', $item->section());
$this->assertEquals('WAC-47', $item->display());
$this->assertEquals('<svg>...</svg>', $item->icon());
$this->assertEquals('http://localhost/d-squad', $item->url());
}

/** @test */
public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
{
$this->actingAs(tap(User::make()->makeSuper())->save());

Nav::droids('WAC-47')
->url('/pit-droid')
->icon('<svg>...</svg>');

// Callign the same constructor does a `findOrCreate()` under the hood...
Nav::droids('WAC-47')
->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
$this->assertEquals('A-Wing', $ships->first()->display());
}

/** @test */
public function it_can_remove_a_specific_nav_child_item()
{
$this->actingAs(tap(User::make()->makeSuper())->save());

Nav::ships('Y-Wing')
->url('/y-wing')
->icon('y-wing')
->children(function () {
return [
Nav::item('Foo'),
Nav::item('Bar'),
];
});

Nav::ships('A-Wing')
->url('/a-wing')
->icon('a-wing')
->children(function () {
return [
Nav::item('Foo'),
Nav::item('Bar'),
];
});

$this->assertCount(2, $this->build()->get('Ships'));

Nav::remove('Ships', 'Y-Wing', 'Foo');

$this->assertCount(2, $ships = $this->build()->get('Ships'));

$this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
$this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
}

/** @test */
public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
{
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
$this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
}

/** @test */
public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
{
Facades\Collection::make('articles')->save();
Facades\Collection::make('pages')->save();

$this->actingAs(tap(User::make()->makeSuper())->save());

$nav = Nav::build();

$collectionsChildren = function () {
return $this->build()
->get('Content')
->first(fn ($item) => $item->display() === 'Collections')
->resolveChildren()
->children();
};

$this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

Nav::extend(function ($nav) {
$nav->remove('Content', 'Collections', 'Articles');
});

$this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
}

/** @test */
public function it_checks_if_active()
{
Expand Down
, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down

, '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] Add helper arg for addons to easily remove child item in core nav by jesseleite · Pull Request #8883 · statamic/cms · GitHub
Skip to content
[4.x] Add helper arg for addons to easily remove child item in core nav#8883

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 2 commits into

from

Nov 1, 2023
 Merged


[4.x] Add helper arg for addons to easily remove child item in core nav
#8883
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
dd00e79

Add arg to easily remove child CP nav item.


jesseleite Oct 25, 2023
8ef2e15

Test new public `find()` method as well.


jesseleite Oct 25, 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


49 changes: 45 additions & 4 deletions
src/CP/Navigation/Nav.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,31 +45,49 @@ public function item($name)
 }

 /**
 * Find or create nav item.
 * Find nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem|null
 */
 public function findOrCreate($section, $name)
 public function find($section, $name)
 {
 $item = collect($this->items)->first(function ($item) use ($section, $name) {
 return $item->section() === $section
 && $item->display() === $name
 && ! $item->isChild();
 });

 return $item ?: $this->create($name)->section($section);
 return $item;
 }

 /**
 * Find or create nav item.
 *
 * @param string $section
 * @param string $name
 * @return NavItem
 */
 public function findOrCreate($section, $name)
 {
 return $this->find($section, $name) ?: $this->create($name)->section($section);
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 public function remove($section, $name = null)
 public function remove($section, $name = null, $childName = null)
 {
 if ($childName) {
 return $this->removeChildItem($section, $name, $childName);
 }

 $this->items = collect($this->items)
 ->reject(function ($item) use ($section, $name) {
 return $name
Expand All@@ -81,6 +99,29 @@ public function remove($section, $name = null)
 return $this;
 }

 /**
 * Remove nav item.
 *
 * @param string $section
 * @param string|null $name
 * @param string|null $childName
 * @return $this
 */
 protected function removeChildItem($section, $name, $childName)
 {
 if (! $parent = $this->find($section, $name)) {
 return $this;
 }

 if (! $children = $parent->resolveChildren()->children()) {
 return $this;
 }

 $parent->children($children->reject(fn ($child) => $child->display() === $childName));

 return $this;
 }

 /**
 * Build navigation.
 *
Expand Down

85 changes: 84 additions & 1 deletion
tests/CP/Navigation/NavTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -124,14 +124,35 @@ public function it_can_create_a_nav_item_with_a_custom_svg_icon()
 }

 /** @test */
 public function it_can_get_and_modify_an_existing_item()
 public function it_can_find_and_modify_an_existing_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 Nav::find('Droids', 'WAC-47')
 ->url('/d-squad');

 $item = $this->build()->get('Droids')->first();

 $this->assertEquals('Droids', $item->section());
 $this->assertEquals('WAC-47', $item->display());
 $this->assertEquals('<svg>...</svg>', $item->icon());
 $this->assertEquals('http://localhost/d-squad', $item->url());
 }

 /** @test */
 public function it_can_find_and_modify_an_existing_item_using_magic_constructor()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::droids('WAC-47')
 ->url('/pit-droid')
 ->icon('<svg>...</svg>');

 // Callign the same constructor does a `findOrCreate()` under the hood...
 Nav::droids('WAC-47')
 ->url('/d-squad');

Expand DownExpand Up@@ -344,6 +365,41 @@ public function it_can_remove_a_specific_nav_item()
 $this->assertEquals('A-Wing', $ships->first()->display());
 }

 /** @test */
 public function it_can_remove_a_specific_nav_child_item()
 {
 $this->actingAs(tap(User::make()->makeSuper())->save());

 Nav::ships('Y-Wing')
 ->url('/y-wing')
 ->icon('y-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 Nav::ships('A-Wing')
 ->url('/a-wing')
 ->icon('a-wing')
 ->children(function () {
 return [
 Nav::item('Foo'),
 Nav::item('Bar'),
 ];
 });

 $this->assertCount(2, $this->build()->get('Ships'));

 Nav::remove('Ships', 'Y-Wing', 'Foo');

 $this->assertCount(2, $ships = $this->build()->get('Ships'));

 $this->assertEquals(['Bar'], $ships->first()->resolveChildren()->children()->map->display()->all());
 $this->assertEquals(['Foo', 'Bar'], $ships->last()->resolveChildren()->children()->map->display()->all());
 }

 /** @test */
 public function it_can_use_extend_to_defer_until_after_statamic_core_nav_items_are_built()
 {
Expand DownExpand Up@@ -378,6 +434,33 @@ public function it_can_use_extend_to_remove_a_default_statamic_nav_item()
 $this->assertNotContains('Collections', $this->build()->get('Content')->map->display());
 }

 /** @test */
 public function it_can_use_extend_to_remove_a_default_statamic_child_nav_item()
 {
 Facades\Collection::make('articles')->save();
 Facades\Collection::make('pages')->save();

 $this->actingAs(tap(User::make()->makeSuper())->save());

 $nav = Nav::build();

 $collectionsChildren = function () {
 return $this->build()
 ->get('Content')
 ->first(fn ($item) => $item->display() === 'Collections')
 ->resolveChildren()
 ->children();
 };

 $this->assertEquals(['Articles', 'Pages'], $collectionsChildren()->map->display()->all());

 Nav::extend(function ($nav) {
 $nav->remove('Content', 'Collections', 'Articles');
 });

 $this->assertEquals(['Pages'], $collectionsChildren()->map->display()->all());
 }

 /** @test */
 public function it_checks_if_active()
 {
Expand Down