Skip to content

refactor(legend): avoid repetitive code & optimize #452

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
fraxken merged 1 commit into from
Jan 26, 2025
Merged

refactor(legend): avoid repetitive code & optimize #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion public/common/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,20 @@ export function extractEmojis(strWithEmojis) {
* @param {string[]} [options.classList]
* @param {HTMLElement[]} [options.childs]
* @param {Record<string, any>} [options.attributes]
* @param {Record<string, any>} [options.styles]
* @param {string | null} [options.text]
* @param {string | null} [options.className]
* @returns {HTMLElement}
*/
export function createDOMElement(kind = "div", options = {}) {
const { classList = [], childs = [], attributes = {}, text = null, className = null } = options;
const {
classList = [],
childs = [],
attributes = {},
styles = {},
text = null,
className = null
} = options;

const el = document.createElement(kind);
if (className !== null) {
Expand All @@ -50,6 +58,9 @@ export function createDOMElement(kind = "div", options = {}) {
if (text !== null) {
el.appendChild(document.createTextNode(String(text)));
}
if (Object.keys(styles).length > 0) {
Object.assign(el.style, styles);
}

return el;
}
Expand Down
100 changes: 42 additions & 58 deletions public/components/legend/legend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,74 +1,58 @@
// Import Internal Dependencies
import { COLORS } from "../../../workspaces/vis-network/src/constants.js";
import { currentLang } from "../../common/utils.js";
import { createDOMElement, currentLang } from "../../common/utils.js";

export class Legend {
constructor(options = {}) {
constructor(
options = {}
) {
const { show = false } = options;
const lang = currentLang();
const theme = "LIGHT";
const legend = document.getElementById("legend");
const colors = COLORS[theme];

const defaultBadgeElement = document.createElement("div");
defaultBadgeElement.classList.add("legend-badge");
defaultBadgeElement.style.backgroundColor = colors.DEFAULT.color;
defaultBadgeElement.style.color = colors.DEFAULT.font.color;
const defaultElement = document.createElement("div");
defaultElement.classList.add("legend");
defaultElement.textContent = window.i18n[lang].legend.default;
const colors = COLORS.LIGHT;
const { legend } = window.i18n[currentLang()];

const warnBadgeElement = document.createElement("div");
warnBadgeElement.classList.add("legend-badge");
warnBadgeElement.style.backgroundColor = colors.WARN.color;
warnBadgeElement.style.color = colors.WARN.font.color;
const warnElement = document.createElement("div");
warnElement.classList.add("legend");
warnElement.textContent = window.i18n[lang].legend.warn;
const fragment = document.createDocumentFragment();
fragment.append(
createLegendBoxElement(colors.WARN, legend.warn),
createLegendBoxElement(colors.FRIENDLY, legend.friendly),
createLegendBoxElement(colors.DEFAULT, legend.default)
);

const friendlyBadgeElement = document.createElement("div");
friendlyBadgeElement.classList.add("legend-badge");
friendlyBadgeElement.style.backgroundColor = colors.FRIENDLY.color;
friendlyBadgeElement.style.color = colors.FRIENDLY.font.color;
const friendlyElement = document.createElement("div");
friendlyElement.classList.add("legend");
friendlyElement.textContent = window.i18n[lang].legend.friendly;

const warnBox = document.createElement("div");
warnBox.classList.add("legend-box");
warnBox.appendChild(warnBadgeElement);
warnBox.appendChild(warnElement);
warnBox.style.backgroundColor = colors.WARN.color;
warnBox.style.color = colors.WARN.font.color;

const friendlyBox = document.createElement("div");
friendlyBox.classList.add("legend-box");
friendlyBox.appendChild(friendlyBadgeElement);
friendlyBox.appendChild(friendlyElement);
friendlyBox.style.backgroundColor = colors.FRIENDLY.color;
friendlyBox.style.color = colors.FRIENDLY.font.color;

const defaultBox = document.createElement("div");
defaultBox.classList.add("legend-box");
defaultBox.appendChild(defaultBadgeElement);
defaultBox.appendChild(defaultElement);
defaultBox.style.backgroundColor = colors.DEFAULT.color;
defaultBox.style.color = colors.DEFAULT.font.color;

legend.appendChild(warnBox);
legend.appendChild(friendlyBox);
legend.appendChild(defaultBox);

if (show) {
this.show();
}
this.DOMElement = document.getElementById("legend");
this.DOMElement.appendChild(fragment);
show && this.show();
}

show() {
document.getElementById("legend").style.display = "flex";
this.DOMElement.style.display = "flex";
}

hide() {
document.getElementById("legend").style.display = "none";
this.DOMElement.style.display = "none";
}
}

function createLegendBoxElement(
theme,
text
) {
const styles = {
backgroundColor: theme.color,
color: theme.font.color
};

return createDOMElement("div", {
className: "legend-box",
childs: [
createDOMElement("div", {
className: "legend-badge",
styles
}),
createDOMElement("div", {
className: "legend",
text
})
],
styles
});
}
Loading