jeans/frontend
jeans/frontend
1
0
Fork 0
mirror of https://github.com/home-assistant/frontend.git synced 2025-07-24 09:46:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simplify GtHub markdown alerts (#19536)

Browse Source 
Simplify GtHub merkdown alerts
This commit is contained in:
Joakim Sørensen 2024-01-30 13:37:47 +01:00 committed by GitHub
parent 623ac88166
commit 0944b1e9d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 39 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
src/components/ha-markdown-element.ts
View File

@ -3,13 +3,16 @@ import { customElement, property } from "lit/decorators";
import { fireEvent } from "../common/dom/fire_event";
import { renderMarkdown } from "../resources/render-markdown";
const _legacyGitHubBlockQuoteToAlert = { Note: "info", Warning: "warning" };
const _gitHubBlockQuoteToAlert = {
"[!NOTE]": "info",
"[!TIP]": "success",
"[!IMPORTANT]": "info",
"[!WARNING]": "warning",
"[!CAUTION]": "error",
const _gitHubMarkdownAlerts = {
reType:
/(?<input>(\[!(?<type>caution|important|note|tip|warning)\])(?:\s|\\n)?)/i,
typeToHaAlert: {
caution: "error",
important: "info",
note: "info",
tip: "success",
warning: "warning",
},
};
@customElement("ha-markdown-element")
@ -75,42 +78,33 @@ class HaMarkdownElement extends ReactiveElement {
}
node.addEventListener("load", this._resize);
} else if (node instanceof HTMLQuoteElement) {
// Map GitHub blockquote elements to our ha-alert element
const firstElementChild = node.firstElementChild;
const quoteTitleElement = firstElementChild?.firstElementChild;
const blockQuoteType =
firstElementChild?.firstChild?.textContent &&
_gitHubBlockQuoteToAlert[firstElementChild.firstChild.textContent];
const legacyBlockQuoteType =
!blockQuoteType &&
quoteTitleElement?.textContent &&
_legacyGitHubBlockQuoteToAlert[quoteTitleElement.textContent];
/**
* Map GitHub blockquote elements to our ha-alert element
* https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
*/
const gitHubAlertMatch =
node.firstElementChild?.firstChild?.textContent &&
_gitHubMarkdownAlerts.reType.exec(
node.firstElementChild.firstChild.textContent
);
if (
blockQuoteType ||
(quoteTitleElement?.nodeName === "STRONG" && legacyBlockQuoteType)
) {
const alertNote = document.createElement("ha-alert");
alertNote.alertType = blockQuoteType || legacyBlockQuoteType;
alertNote.title = blockQuoteType
? ""
: (firstElementChild!.childNodes[1].nodeName === "#text" &&
firstElementChild!.childNodes[1].textContent?.trimStart()) ||
"";
if (gitHubAlertMatch) {
const { type: alertType } = gitHubAlertMatch.groups!;
const haAlertNode = document.createElement("ha-alert");
haAlertNode.alertType =
_gitHubMarkdownAlerts.typeToHaAlert[alertType.toLowerCase()];
const childNodes = Array.from(node.childNodes)
.map((child) => Array.from(child.childNodes))
.reduce((acc, val) => acc.concat(val), [])
.filter(
(childNode) =>
childNode.textContent &&
!(childNode.textContent in _gitHubBlockQuoteToAlert) &&
!(childNode.textContent in _legacyGitHubBlockQuoteToAlert)
);
for (const child of childNodes) {
alertNote.appendChild(child);
}
node.firstElementChild!.replaceWith(alertNote);
haAlertNode.append(
...Array.from(node.childNodes)
.map((child) => Array.from(child.childNodes))
.reduce((acc, val) => acc.concat(val), [])
.filter(
(childNode) =>
childNode.textContent &&
childNode.textContent !== gitHubAlertMatch.input
)
);
walker.parentNode()!.replaceChild(haAlertNode, node);
}
} else if (
node instanceof HTMLElement &&

4
src/components/ha-markdown.ts
View File

@ -42,6 +42,10 @@ export class HaMarkdown extends LitElement {
ha-markdown-element > *:last-child {
margin-bottom: 0;
}
ha-alert {
display: block;
margin: 4px 0;
}
a {
color: var(--primary-color);
}