Skip to content

Add a locale filter to links #30

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
Apr 21, 2023
Merged

Add a locale filter to links #30

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
faab3ef
Add a locale attribute to custom header links
Mar 23, 2023
3b99de4
Filter out links which locale is different from the html document's
Mar 23, 2023
d21739b
prettier
jordanvidrine Apr 21, 2023
494c33c
more syntax
jordanvidrine Apr 21, 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
29 changes: 23 additions & 6 deletions javascripts/discourse/initializers/discourse-custom-header-links.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,18 @@ export default {
.split("|")
.filter(Boolean)
.map((customHeaderLinksArray) => {
const [linkText, linkTitle, linkHref, device, target, keepOnScroll] =
customHeaderLinksArray
.split(",")
.filter(Boolean)
.map((x) => x.trim());
const [
linkText,
linkTitle,
linkHref,
device,
target,
keepOnScroll,
locale,
] = customHeaderLinksArray
.split(",")
.filter(Boolean)
.map((x) => x.trim());

const deviceClass = `.${device}`;
const linkTarget = target === "self" ? "" : "_blank";
Expand All @@ -37,6 +44,8 @@ export default {
.toLowerCase()
.replace(/\s/gi, "-")}-custom-header-links`;

const localeClass = locale === "" ? "" : `.${locale}`;

const anchorAttributes = {
title: linkTitle,
href: linkHref,
Expand All @@ -45,9 +54,17 @@ export default {
anchorAttributes.target = linkTarget;
}

if (
locale !== "" &&
document.documentElement.lang &&
document.documentElement.lang !== locale
) {
return;
}

headerLinks.push(
h(
`li.headerLink${deviceClass}${keepOnScrollClass}${linkClass}`,
`li.headerLink${deviceClass}${keepOnScrollClass}${localeClass}${linkClass}`,
h("a", anchorAttributes, linkText)
)
);
Expand Down
4 changes: 2 additions & 2 deletions settings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Custom_header_links:
type: list
list_type: simple
default: "External link, this link will open in a new tab, https://meta.discourse.org, vdo, blank, remove|Most Liked, Posts with the most amount of likes, /latest/?order=op_likes, vdo, self, keep|Privacy, Our Privacy Policy, /privacy, vdm, self, keep"
default: "External link, this link will open in a new tab, https://meta.discourse.org, vdo, blank, remove, en|Most Liked, Posts with the most amount of likes, /latest/?order=op_likes, vdo, self, keep, en|Privacy, Our Privacy Policy, /privacy, vdm, self, keep, en"
description:
en: "Comma delimited in this order: link text, link title, URL, view, target, hide on scroll<br><b>Link text:</b> The text for the link<br><b>Link title:</b> the text that shows when the link is hovered<br><b>URL:</b> The path for the link (can be relative)<br><b>View:</b> vdm = desktop and mobile, vdo = desktop only, vmo = mobile only<br><b>Target:</b> blank = opens in a new tab, self = opens in the same tab<br><b>Hide on scroll:</b> remove = hides the link when the title is expanded on topic pages keep = keeps the link visible even when the title is visible on topic pages"
en: "Comma delimited in this order: link text, link title, URL, view, target, hide on scroll<br><b>Link text:</b> The text for the link<br><b>Link title:</b> the text that shows when the link is hovered<br><b>URL:</b> The path for the link (can be relative)<br><b>View:</b> vdm = desktop and mobile, vdo = desktop only, vmo = mobile only<br><b>Target:</b> blank = opens in a new tab, self = opens in the same tab<br><b>Hide on scroll:</b> remove = hides the link when the title is expanded on topic pages keep = keeps the link visible even when the title is visible on topic pages<br><b>Language:</b> blank = no locale assoaciated to the link, else insert a locale code (en, fr, de, ...)"

links_position:
default: right
Expand Down