Skip to content

A platform for community discussion. Free, open, simple.

UX: Add permalink anchors to tag group headings on /tags page (#38813)

Alan Guo Xiang Tan2c3ce25631da
diff --git a/app/assets/stylesheets/common/base/_index.scss b/app/assets/stylesheets/common/base/_index.scss
index e9f32713380..c4724fea42f 100644
--- a/app/assets/stylesheets/common/base/_index.scss
+++ b/app/assets/stylesheets/common/base/_index.scss
@@ -27,6 +27,7 @@
@import "faqs";
@import "group";
@import "groups";
+@import "heading-anchor";
@import "header";
@import "history";
@import "json_schema";
diff --git a/app/assets/stylesheets/common/base/heading-anchor.scss b/app/assets/stylesheets/common/base/heading-anchor.scss
new file mode 100644
index 00000000000..3d90fb2bda2
--- /dev/null
+++ b/app/assets/stylesheets/common/base/heading-anchor.scss
@@ -0,0 +1,36 @@
+%heading-anchor {
+ a.anchor {
+ opacity: 0;
+ transition: opacity 0.25s;
+
+ &:focus-visible {
+ outline: 0;
+ opacity: 1;
+ }
+
+ &::before {
+ content: svg-uri(
+ '<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 512 512" fill="#{$primary-medium}"><path d="M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"></path></svg>'
+ );
+ line-height: 1.4;
+ margin-left: -20px;
+ padding-right: 4px;
+ position: absolute;
+ z-index: 2;
+ }
+ }
+
+ // the anchor icon is a CSS pseudo element set above
+ // so we can't change the color of the icon itself
+ // but we can change the color of the anchor text
+ &:has(a.anchor:focus-visible) {
+ color: var(--tertiary);
+ }
+
+ // show when hovering where icon should be
+ // show when hovering header
+ .discourse-no-touch & a.anchor:hover,
+ .discourse-no-touch &:hover a.anchor {
+ opacity: 1;
+ }
+}
diff --git a/app/assets/stylesheets/common/base/tagging.scss b/app/assets/stylesheets/common/base/tagging.scss
index eb40388e33a..bfc936fe881 100644
--- a/app/assets/stylesheets/common/base/tagging.scss
+++ b/app/assets/stylesheets/common/base/tagging.scss
@@ -24,6 +24,10 @@
margin-bottom: 20px;
}
+.tags-index .tags-list h3 {
+ @extend %heading-anchor;
+}
+
.tags-list .tag-box {
width: 300px;
margin-bottom: 1em;
diff --git a/app/assets/stylesheets/common/base/topic-post.scss b/app/assets/stylesheets/common/base/topic-post.scss
index 875fd81d4e5..facd611cafc 100644
--- a/app/assets/stylesheets/common/base/topic-post.scss
+++ b/app/assets/stylesheets/common/base/topic-post.scss
@@ -144,40 +144,7 @@
margin: 2rem 0 0.67rem;
line-height: var(--line-height-medium);
- a.anchor {
- opacity: 0;
- transition: opacity 0.25s;
-
- &:focus-visible {
- outline: 0;
- opacity: 1;
- }
-
- &::before {
- content: svg-uri(
- '<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 512 512" fill="#{$primary-medium}"><path d="M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"></path></svg>'
- );
- line-height: 1.4;
- margin-left: -20px;
- padding-right: 4px;
- position: absolute;
- z-index: 2;
- }
- }
-
- // the anchor icon is a CSS pseudo element set above
- // so we can't change the color of the icon itself
- // but we can change the color of the anchor text
- &:has(a.anchor:focus-visible) {
- color: var(--tertiary);
- }
-
- // show when hovering where icon should be
- // show when hovering header
- .discourse-no-touch & a.anchor:hover,
- .discourse-no-touch &:hover a.anchor {
- opacity: 1;
- }
+ @extend %heading-anchor;
}
h1 {
diff --git a/frontend/discourse/app/components/tag-list.gjs b/frontend/discourse/app/components/tag-list.gjs
index 49ddea5a8c1..e3cc6f1be0d 100644
--- a/frontend/discourse/app/components/tag-list.gjs
+++ b/frontend/discourse/app/components/tag-list.gjs
@@ -7,6 +7,7 @@ import CategoryTitleLink from "discourse/components/category-title-link";
import concatClass from "discourse/helpers/concat-class";
import icon from "discourse/helpers/d-icon";
import discourseTag from "discourse/helpers/discourse-tag";
+import { slugify } from "discourse/lib/utilities";
import Category from "discourse/models/category";
import { i18n } from "discourse-i18n";
@@ -32,16 +33,17 @@ export default class TagList extends Component {
}
@computed("tagGroupName")
- get tagGroupNameClass() {
+ get tagGroupNameSlug() {
if (this.tagGroupName) {
- const groupName = this.tagGroupName
- .replace(/\s+/g, "-")
- .replace(/[!\"#$%&'\(\)\*\+,\.\/:;<=>\?\@\[\\\]\^`\{\|\}~]/g, "")
- .toLowerCase();
- return groupName && `tag-group-${groupName}`;
+ return slugify(this.tagGroupName);
}
}
+ @computed("tagGroupNameSlug")
+ get tagGroupNameClass() {
+ return this.tagGroupNameSlug && `tag-group-${this.tagGroupNameSlug}`;
+ }
+
<template>
<div
class={{concatClass
@@ -59,7 +61,11 @@ export default class TagList extends Component {
<CategoryTitleLink @category={{this.category}} />
{{/if}}
{{#if this.tagGroupName}}
- <h3>{{this.tagGroupName}}</h3>
+ <h3 id={{this.tagGroupNameSlug}}><a
+ href="#{{this.tagGroupNameSlug}}"
+ class="anchor"
+ aria-label={{i18n "post.heading_anchor"}}
+ ></a>{{this.tagGroupName}}</h3>
{{/if}}
{{#each this.sortedTags as |tag|}}
<div class="tag-box">
diff --git a/frontend/discourse/app/routes/tags/index.js b/frontend/discourse/app/routes/tags/index.js
index 7f3681863d7..1137cecf1b2 100644
--- a/frontend/discourse/app/routes/tags/index.js
+++ b/frontend/discourse/app/routes/tags/index.js
@@ -1,9 +1,15 @@
import { action } from "@ember/object";
+import DiscourseURL from "discourse/lib/url";
import Tag from "discourse/models/tag";
import DiscourseRoute from "discourse/routes/discourse";
import { i18n } from "discourse-i18n";
export default class TagsIndex extends DiscourseRoute {
+ activate() {
+ super.activate(...arguments);
+ DiscourseURL.jumpToElement(document.location.hash.slice(1));
+ }
+
model() {
return this.store.findAll("tag").then((result) => {
if (result.extras) {
diff --git a/frontend/discourse/tests/acceptance/tags-test.js b/frontend/discourse/tests/acceptance/tags-test.js
index 8c457aa978d..c673456bfb3 100644
--- a/frontend/discourse/tests/acceptance/tags-test.js
+++ b/frontend/discourse/tests/acceptance/tags-test.js
@@ -192,6 +192,12 @@ acceptance("Tags listed by group", function (needs) {
);
});
+ test("tag group headings have anchor ids", async function (assert) {
+ await visit("/tags");
+ assert.dom("h3#ford-cars").exists();
+ assert.dom("h3#ford-cars a.anchor").hasAttribute("href", "#ford-cars");
+ });
+
test("list the tags in groups", async function (assert) {
await visit("/tags");