Skip to content

Also add breadcrumbs to the hx-select-oob list #575

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
merged 4 commits into from
Feb 21, 2025
Merged

Also add breadcrumbs to the hx-select-oob list #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be414a1
Also add breadcrumbs to the hx-select-oob list
reakaleek Feb 21, 2025
1a27e0a
Refactor
reakaleek Feb 21, 2025
e3ae933
Fix syntax
reakaleek Feb 21, 2025
79fd73b
Fix tests
reakaleek Feb 21, 2025
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
10 changes: 10 additions & 0 deletions src/Elastic.Markdown/Helpers/Htmx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information

namespace Elastic.Markdown.Helpers;

public class Htmx
{
public static string GetHxSelectOob() => "#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs";
}
3 changes: 2 additions & 1 deletion src/Elastic.Markdown/Myst/Renderers/HtmxLinkInlineRenderer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information

using Elastic.Markdown.Helpers;
using Markdig;
using Markdig.Renderers;
using Markdig.Renderers.Html.Inlines;
Expand All @@ -19,7 +20,7 @@ protected override void Write(HtmlRenderer renderer, LinkInline link)
_ = renderer.WriteEscapeUrl(link.GetDynamicUrl != null ? link.GetDynamicUrl() ?? link.Url : link.Url);
_ = renderer.Write('"');
_ = renderer.WriteAttributes(link);
_ = renderer.Write(" hx-select-oob=\"#markdown-content,#toc-nav,#prev-next-nav\"");
_ = renderer.Write($" hx-select-oob=\"{Htmx.GetHxSelectOob()}\"");
_ = renderer.Write(" hx-swap=\"none\"");
_ = renderer.Write(" hx-push-url=\"true\"");
_ = renderer.Write(" hx-indicator=\"#htmx-indicator\"");
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.Markdown/Slices/Layout/_Breadcrumbs.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@inherits RazorSlice<LayoutViewModel>
<ol class="block w-full" itemscope="" itemtype="https://schema.org/BreadcrumbList">
<ol id="breadcrumbs" class="block w-full" itemscope="" itemtype="https://schema.org/BreadcrumbList">
<li class="inline text-ink text-sm hover:text-ink leading-[1.2em] tracking-[-0.02em]" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem">
<a itemprop="item" href="@Model.UrlPathPrefix/">
<span itemprop="name" class="hover:text-ink">Elastic</span>
Expand Down
5 changes: 3 additions & 2 deletions src/Elastic.Markdown/Slices/Layout/_TocTreeNav.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@using Elastic.Markdown.Helpers
@using Elastic.Markdown.IO.Navigation
@inherits RazorSlice<NavigationTreeItem>
@foreach (var item in Model.SubTree.NavigationItems)
Expand All @@ -10,7 +11,7 @@
<div class="flex">
<a
hx-get="@f.Url"
hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav"
hx-select-oob="@Htmx.GetHxSelectOob()"
hx-swap="none"
hx-push-url="true"
hx-indicator="#htmx-indicator"
Expand Down Expand Up @@ -49,7 +50,7 @@
<a
href="@g.Index?.Url"
hx-get="@g.Index?.Url"
hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav"
hx-select-oob="@Htmx.GetHxSelectOob()"
hx-swap="none"
hx-push-url="true"
hx-indicator="#htmx-indicator"
Expand Down
5 changes: 3 additions & 2 deletions src/Elastic.Markdown/Slices/_Layout.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@using Elastic.Markdown.Helpers
@inherits RazorLayoutSlice<LayoutViewModel>
<!DOCTYPE html>
<html lang="en" class="h-screen">
Expand Down Expand Up @@ -36,7 +37,7 @@
<a
href="@Model.Previous.Url"
hx-get="@Model.Previous.Url"
hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav"
hx-select-oob="@Htmx.GetHxSelectOob()"
hx-swap="none"
hx-push-url="true"
hx-indicator="#htmx-indicator"
Expand All @@ -59,7 +60,7 @@
<a
href="@Model.Next.Url"
hx-get="@Model.Next.Url"
hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav"
hx-select-oob="@Htmx.GetHxSelectOob()"
hx-swap="none"
hx-push-url="true"
hx-indicator="#htmx-indicator"
Expand Down
10 changes: 5 additions & 5 deletions tests/Elastic.Markdown.Tests/Inline/AnchorLinkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ [Sub Requirements](testing/req.md#sub-requirements)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#sub-requirements" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#sub-requirements" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
);

[Fact]
Expand All @@ -93,7 +93,7 @@ [Sub Requirements](testing/req.md#new-reqs)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#new-reqs" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#new-reqs" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
);

[Fact]
Expand All @@ -110,7 +110,7 @@ public class ExternalPageAnchorAutoTitleTests(ITestOutputHelper output) : Anchor
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#sub-requirements" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements &gt; Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#sub-requirements" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements &gt; Sub Requirements</a></p>"""
);

[Fact]
Expand Down Expand Up @@ -146,7 +146,7 @@ [Sub Requirements](testing/req.md#sub-requirements2)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#sub-requirements2" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#sub-requirements2" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
);

[Fact]
Expand All @@ -165,7 +165,7 @@ [Heading inside dropdown](testing/req.md#heading-inside-dropdown)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<a href="/docs/testing/req#heading-inside-dropdown" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Heading inside dropdown</a>"""
"""<a href="/docs/testing/req#heading-inside-dropdown" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Heading inside dropdown</a>"""
);
[Fact]
public void HasError() => Collector.Diagnostics.Should().HaveCount(0);
Expand Down
2 changes: 1 addition & 1 deletion tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ [Sub Requirements](testing/req.md#hint_ref)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#hint_ref" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#hint_ref" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
);

[Fact]
Expand Down
2 changes: 1 addition & 1 deletion tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ [Sub Requirements](testing/req.md#custom-anchor)
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req#custom-anchor" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
"""<p><a href="/docs/testing/req#custom-anchor" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Sub Requirements</a></p>"""
);

[Fact]
Expand Down
12 changes: 6 additions & 6 deletions tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class InlineLinkTests(ITestOutputHelper output) : LinkTestBase(output,
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/_static/img/observability.png" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Elasticsearch</a></p>"""
"""<p><a href="/docs/_static/img/observability.png" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Elasticsearch</a></p>"""
);

[Fact]
Expand All @@ -57,7 +57,7 @@ public class LinkToPageTests(ITestOutputHelper output) : LinkTestBase(output,
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Requirements</a></p>"""
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Requirements</a></p>"""
);

[Fact]
Expand All @@ -77,7 +77,7 @@ public class InsertPageTitleTests(ITestOutputHelper output) : LinkTestBase(outpu
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></p>"""
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></p>"""
);

[Fact]
Expand All @@ -99,7 +99,7 @@ public class LinkReferenceTest(ITestOutputHelper output) : LinkTestBase(output,
public void GeneratesHtml() =>
// language=html
Html.Should().Contain(
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">test</a></p>"""
"""<p><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">test</a></p>"""
);

[Fact]
Expand Down Expand Up @@ -213,10 +213,10 @@ public void GeneratesHtml() =>
Html.TrimEnd().Should().Be("""
<p>Links:</p>
<ul>
<li><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></li>
<li><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></li>
</ul>
<ul>
<li><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></li>
<li><a href="/docs/testing/req" hx-select-oob="#markdown-content,#toc-nav,#prev-next-nav,#breadcrumbs" hx-swap="none" hx-push-url="true" hx-indicator="#htmx-indicator" preload="mouseover">Special Requirements</a></li>
</ul>
""");

Expand Down