Skip to content

Feat/nightingale tooltip #289

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

Open
justintyf01 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feat/nightingale tooltip #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f87f05
Implemented nightingale-tooltip component
justintyf01 Jul 9, 2024
dbb93d3
Added nightingale-tooltip README
justintyf01 Jul 9, 2024
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
321 changes: 181 additions & 140 deletions packages/nightingale-manager/src/nightingale-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,155 +3,196 @@ import NightingaleElement from "@nightingale-elements/nightingale-new-core";

@customElement("nightingale-manager")
class NightingaleManager extends NightingaleElement {
@property({
converter: {
fromAttribute: (value): Map<string, null> | null => {
if (!value) {
return null;
}
const attributes = value.split(",");
if (attributes.indexOf("type") !== -1)
throw new Error("'type' can't be used as a protvista attribute");
if (attributes.indexOf("value") !== -1)
throw new Error("'value' can't be used as a protvista attribute");
const mapToReturn = new Map(
attributes
.filter(
(attr: string) =>
!NightingaleManager.observedAttributes.includes(attr),
)
.map((attr: string) => [attr, null]),
);
return mapToReturn;
},
toAttribute: (value: []) => {
return value.join(",");
},
},
})
"reflected-attributes"?: Map<string, null> = new Map();

@property({ type: Number })
length?: number;

@property({ type: Number })
"display-start"?: number;

@property({ type: Number })
"display-end"?: number;

@property({ type: String })
"highlight"?: string;

@state()
protvistaElements = new Set<HTMLElement>();

@state()
propertyValues = new Map<string, string>();

connectedCallback() {
super.connectedCallback();
this.addEventListener("change", this.changeListener as EventListener);
this.style.display = "unset";
}

override attributeChangedCallback(
attr: string,
previousValue: string | null,
newValue: string | null,
) {
super.attributeChangedCallback(attr, previousValue, newValue);
this.applyAttributes();
}

applyAttributes() {
this.protvistaElements.forEach((element: HTMLElement) => {
this["reflected-attributes"]?.forEach((value, type) => {
if (value === false || value === null || value === undefined) {
element.removeAttribute(type);
@property({
converter: {
fromAttribute: (value): Map<string, null> | null => {
if (!value) {
return null;
}
const attributes = value.split(",");
if (attributes.indexOf("type") !== -1) throw new Error("'type' can't be used as a protvista attribute");
if (attributes.indexOf("value") !== -1) throw new Error("'value' can't be used as a protvista attribute");
const mapToReturn = new Map(attributes.filter((attr: string) => !NightingaleManager.observedAttributes.includes(attr)).map((attr: string) => [attr, null]));
return mapToReturn;
},
toAttribute: (value: []) => {
return value.join(",");
},
},
})
"reflected-attributes"?: Map<string, null> = new Map();

@property({ type: Number })
length?: number;

@property({ type: Number })
"display-start"?: number;

@property({ type: Number })
"display-end"?: number;

@property({ type: String })
"highlight"?: string;

@state()
protvistaElements = new Set<HTMLElement>();

@state()
propertyValues = new Map<string, string>();

connectedCallback() {
super.connectedCallback();
this.addEventListener("change", this.changeListener as EventListener);
document.addEventListener("click", this.handleDocumentClick.bind(this));
this.style.display = "unset";
}

override attributeChangedCallback(attr: string, previousValue: string | null, newValue: string | null) {
super.attributeChangedCallback(attr, previousValue, newValue);
this.applyAttributes();
}

applyAttributes() {
this.protvistaElements.forEach((element: HTMLElement) => {
this["reflected-attributes"]?.forEach((value, type) => {
if (value === false || value === null || value === undefined) {
element.removeAttribute(type);
} else {
element.setAttribute(type, typeof value === "boolean" ? "" : value);
}
});
// Default properties
if (this.length) {
element.setAttribute("length", `${this.length}`);
}
if (this["display-end"]) {
element.setAttribute("display-end", `${this["display-end"]}`);
}
if (this["display-start"]) {
element.setAttribute("display-start", `${this["display-start"]}`);
}
if (this.highlight) {
element.setAttribute("highlight", this.highlight);
}
});
}

register(element: NightingaleElement) {
this.protvistaElements.add(element);
this.applyAttributes();
}

unregister(element: NightingaleElement) {
this.protvistaElements.delete(element);
}

applyProperties(forElementId: string) {
if (forElementId) {
const element = this.querySelector(`#${forElementId}`) as HTMLElement;
if (!element) {
return;
}
this.propertyValues.forEach((value, type) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(element as any)[type] = value;
});
} else {
element.setAttribute(type, typeof value === "boolean" ? "" : value);
this.protvistaElements.forEach((element: HTMLElement) => {
if (!element) {
return;
}
this.propertyValues.forEach((value, type) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(element as any)[type] = value;
});
});
}
});
// Default properties
if (this.length) {
element.setAttribute("length", `${this.length}`);
}
if (this["display-end"]) {
element.setAttribute("display-end", `${this["display-end"]}`);
}
if (this["display-start"]) {
element.setAttribute("display-start", `${this["display-start"]}`);
}
if (this.highlight) {
element.setAttribute("highlight", this.highlight);
}
});
}

register(element: NightingaleElement) {
this.protvistaElements.add(element);
this.applyAttributes();
}

unregister(element: NightingaleElement) {
this.protvistaElements.delete(element);
}

applyProperties(forElementId: string) {
if (forElementId) {
const element = this.querySelector(`#${forElementId}`) as HTMLElement;
if (!element) {
return;
}
this.propertyValues.forEach((value, type) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(element as any)[type] = value;
});
} else {
this.protvistaElements.forEach((element: HTMLElement) => {
if (!element) {
return;
}

isRegisteredAttribute(attributeName: string) {
if (!this["reflected-attributes"]) {
return false;
}
this.propertyValues.forEach((value, type) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(element as any)[type] = value;
});
});
return [...this["reflected-attributes"].keys()].includes(attributeName) || NightingaleManager.observedAttributes.includes(attributeName);
}
}

isRegisteredAttribute(attributeName: string) {
if (!this["reflected-attributes"]) {
return false;
// This function is the click listener for the entire document - responsible for closing tooltips and de-highlighting
handleDocumentClick(event: MouseEvent) {
const isClickInsideFeatureOrTooltip = event.composedPath().some((element) => {
const el = element as HTMLElement;
return el.classList?.contains("outer-rectangle") || (el.nodeType === Node.ELEMENT_NODE && (el as HTMLElement).closest("nightingale-tooltip"));
});

// If click occurs outside of tooltip or feature track, remove and de-highlight
if (!isClickInsideFeatureOrTooltip) {
const tooltip = this.querySelector("nightingale-tooltip");
if (tooltip) {
const tooltipElement = tooltip.shadowRoot?.querySelector(".tooltip");
if (tooltipElement && !tooltipElement.contains(event.target as Node)) {
(tooltip as any).hideTooltip();
this.highlight = "null";
this.applyAttributes();
}
}
}
}
return (
[...this["reflected-attributes"].keys()].includes(attributeName) ||
NightingaleManager.observedAttributes.includes(attributeName)
);
}

changeListener(e: CustomEvent) {
if (!e.detail) {
return;

handleTrackClick(event: CustomEvent) {
if (event.detail?.eventType === "click") {
event.stopPropagation(); // Prevent event from bubbling up to document
const tooltip = this.querySelector("nightingale-tooltip");

if (!tooltip) {
console.error("Tooltip element not found in the DOM.");
return;
}

const [x, y] = event.detail.coords;

// Ensure `showTooltip` exists on the element
if (typeof (tooltip as any).showTooltip === "function") {
let feature = event.detail.feature;
if (feature) {
(tooltip as any).showTooltip(
x,
y,
{
description: feature.description || "Random description",
evidence: feature.evidence || "Random evidence",
},
feature.accession
);

this.highlight = event.detail.highlight;
}
} else {
console.error("Tooltip element does not have a showTooltip method.");
}
}
}
switch (e.detail.handler) {
case "property":
this.propertyValues.set(e.detail.type, e.detail.value);
this.applyProperties(e.detail.for);
break;
default:
if (this.isRegisteredAttribute(e.detail.type)) {
this["reflected-attributes"]?.set(e.detail.type, e.detail.value);

changeListener(e: CustomEvent) {
if (!e.detail) {
return;
}
switch (e.detail.handler) {
case "property":
this.propertyValues.set(e.detail.type, e.detail.value);
this.applyProperties(e.detail.for);
break;
default:
if (this.isRegisteredAttribute(e.detail.type)) {
this["reflected-attributes"]?.set(e.detail.type, e.detail.value);
}
Object.keys(e.detail).forEach((key) => {
if (this.isRegisteredAttribute(key)) {
this["reflected-attributes"]?.set(key, e.detail[key]);
}
});
this.handleTrackClick(e);
this.applyAttributes();
}
Object.keys(e.detail).forEach((key) => {
if (this.isRegisteredAttribute(key)) {
this["reflected-attributes"]?.set(key, e.detail[key]);
}
});
this.applyAttributes();
}
}
}

export default NightingaleManager;
Loading