Spaces:
Running
Running
File size: 14,850 Bytes
9bd422a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 | /**
* HelpTooltip - Displays help icons (?) next to section headers with multilingual popup explanations.
* Loads help content from a JSON file and supports EN/VI/JA language switching.
* Requirements: 28.1, 28.2, 28.3, 28.4, 28.5, 28.6, 28.7, 28.8, 28.9
*/
class HelpTooltip {
/**
* @param {Object} [options]
* @param {string} [options.helpContentPath] - Path to help JSON file (default: './help/help-content.json')
* @param {string} [options.defaultLang] - Default language code (default: 'en')
* @param {string} [options.storageKey] - localStorage key for language (default: 'onnx_explorer_help_lang')
*/
constructor(options = {}) {
this._helpContentPath = options.helpContentPath || './help/help-content.json';
this._defaultLang = options.defaultLang || 'en';
this._storageKey = options.storageKey || 'onnx_explorer_help_lang';
this._helpContent = null;
this._currentLang = this._loadLanguage();
this._currentPopup = null;
this._currentIconSection = null;
// Bound handler for closing popup on outside click
this._onDocumentClick = this._onDocumentClick.bind(this);
// Section key β display name mapping
this._sectionNames = {
metadata: 'Metadata',
inputOutput: 'Inputs & Outputs',
initializers: 'Initializers',
layerStats: 'Layer Statistics',
modelComplexity: 'Model Complexity',
opsetCompatibility: 'Opset Compatibility',
modelGraph: 'Model Graph',
nodeDetails: 'Node Details'
};
// Section key β container selector + header text for lookup
this._sectionMap = {
metadata: { selector: '#metadataContainer', headerText: 'Metadata' },
inputOutput: { selector: '#inputOutputContainer', headerText: 'Inputs & Outputs' },
initializers: { selector: '#initializerContainer', headerText: 'Initializers' },
layerStats: { selector: '#layerStatsContainer', headerText: 'Layer Statistics', noCard: true },
modelComplexity: { selector: '#modelComplexityContainer',headerText: 'Model Complexity', noCard: true },
opsetCompatibility: { selector: '#opsetCheckerContainer', headerText: 'Opset Compatibility', noCard: true },
modelGraph: { selector: null, headerText: 'Model Graph' },
nodeDetails: { selector: null, headerText: 'Node Details' }
};
}
// βββ Public API βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
/**
* Initialize: load help content JSON, inject icons into section headers.
* @returns {Promise<void>}
*/
async init() {
try {
this._helpContent = await this.loadHelpContent();
} catch (err) {
console.warn('[HelpTooltip] Failed to load help content:', err);
this._helpContent = null;
}
this._injectAllIcons();
document.addEventListener('click', this._onDocumentClick);
}
/**
* Fetch help content from JSON file.
* @returns {Promise<Object>}
*/
async loadHelpContent() {
const response = await fetch(this._helpContentPath);
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return response.json();
}
/**
* Inject a help icon (?) next to a section header element.
* @param {string} sectionKey - Key of the section (e.g. 'metadata')
* @param {HTMLElement} headerElement - The heading element to inject icon next to
*/
injectIcon(sectionKey, headerElement) {
if (!headerElement) return;
// Avoid duplicate injection
if (headerElement.querySelector('.help-icon')) return;
const icon = document.createElement('span');
icon.className = 'help-icon';
icon.setAttribute('data-section', sectionKey);
icon.setAttribute('title', 'Help');
icon.setAttribute('role', 'button');
icon.setAttribute('tabindex', '0');
icon.setAttribute('aria-label', `Help for ${this._sectionNames[sectionKey] || sectionKey}`);
icon.textContent = '?';
icon.addEventListener('click', (e) => {
e.stopPropagation();
this.showPopup(sectionKey, icon);
});
icon.addEventListener('keydown', (e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault();
e.stopPropagation();
this.showPopup(sectionKey, icon);
}
});
headerElement.appendChild(icon);
}
/**
* Show a help popup positioned near the anchor icon.
* @param {string} sectionKey - Key of the section
* @param {HTMLElement} anchorElement - The icon element to position popup near
*/
showPopup(sectionKey, anchorElement) {
// Close any existing popup
this.closePopup();
this._currentIconSection = sectionKey;
const popup = document.createElement('div');
popup.className = 'help-popup';
popup.setAttribute('role', 'dialog');
popup.setAttribute('aria-label', `Help: ${this._sectionNames[sectionKey] || sectionKey}`);
popup.innerHTML = this._buildPopupHTML(sectionKey);
document.body.appendChild(popup);
this._currentPopup = popup;
// Position popup near the icon
this._positionPopup(popup, anchorElement);
// Attach language button handlers
this._attachLangHandlers(popup, sectionKey);
// Attach close button handler
const closeBtn = popup.querySelector('.help-popup-close');
if (closeBtn) {
closeBtn.addEventListener('click', (e) => {
e.stopPropagation();
this.closePopup();
});
}
// Prevent clicks inside popup from closing it
popup.addEventListener('click', (e) => {
e.stopPropagation();
});
}
/**
* Close the current popup.
*/
closePopup() {
if (this._currentPopup && this._currentPopup.parentNode) {
this._currentPopup.parentNode.removeChild(this._currentPopup);
}
this._currentPopup = null;
this._currentIconSection = null;
}
/**
* Set the display language and persist to localStorage.
* @param {string} lang - Language code ('en', 'vi', 'ja')
*/
setLanguage(lang) {
if (['en', 'vi', 'ja'].indexOf(lang) === -1) return;
this._currentLang = lang;
this._saveLanguage(lang);
}
/**
* Get the current display language.
* @returns {string}
*/
getLanguage() {
return this._currentLang;
}
/**
* Destroy: remove event listeners, close popup, remove injected icons.
*/
destroy() {
this.closePopup();
document.removeEventListener('click', this._onDocumentClick);
// Remove all injected help icons
const icons = document.querySelectorAll('.help-icon');
icons.forEach((icon) => {
if (icon.parentNode) {
icon.parentNode.removeChild(icon);
}
});
}
// βββ Private ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
/**
* Load saved language from localStorage, or return default.
* @returns {string}
*/
_loadLanguage() {
try {
const saved = localStorage.getItem(this._storageKey);
if (saved && ['en', 'vi', 'ja'].indexOf(saved) !== -1) {
return saved;
}
} catch (e) {
// localStorage unavailable
}
return this._defaultLang;
}
/**
* Save language to localStorage.
* @param {string} lang
*/
_saveLanguage(lang) {
try {
localStorage.setItem(this._storageKey, lang);
} catch (e) {
// localStorage unavailable
}
}
/**
* Inject help icons into all known section headers.
*/
_injectAllIcons() {
for (const sectionKey of Object.keys(this._sectionMap)) {
const config = this._sectionMap[sectionKey];
const headerEl = this._findHeaderElement(sectionKey, config);
if (headerEl) {
this.injectIcon(sectionKey, headerEl);
}
}
// For sections without card wrappers, observe for dynamic content
this._observeDynamicSections();
}
/**
* Find the header element for a given section.
* @param {string} sectionKey
* @param {Object} config - { selector, headerText, noCard }
* @returns {HTMLElement|null}
*/
_findHeaderElement(sectionKey, config) {
// For sections with a container selector and card wrapper
if (config.selector) {
const container = document.querySelector(config.selector);
if (!container) return null;
if (config.noCard) {
// No card wrapper β look for a heading inside the container
const heading = container.querySelector('h5, h6, .card-header h5, .card-header h6');
if (heading) return heading;
// Will be handled by MutationObserver
return null;
}
// Find the .card-header ancestor and its h5/h6
const card = container.closest('.card');
if (card) {
const header = card.querySelector('.card-header h5, .card-header h6');
if (header) return header;
}
}
// For sections without a selector (modelGraph, nodeDetails) β search by header text
if (!config.selector || !document.querySelector(config.selector)) {
const allHeaders = document.querySelectorAll('.card-header h5, .card-header h6');
for (const h of allHeaders) {
if (h.textContent.trim() === config.headerText) {
return h;
}
}
}
return null;
}
/**
* Observe dynamic sections (layerStats, modelComplexity, opsetCompatibility)
* that render content after init. Inject icons when headings appear.
*/
_observeDynamicSections() {
const dynamicKeys = ['layerStats', 'modelComplexity', 'opsetCompatibility'];
dynamicKeys.forEach((sectionKey) => {
const config = this._sectionMap[sectionKey];
if (!config.selector) return;
const container = document.querySelector(config.selector);
if (!container) return;
// Already injected?
if (container.querySelector('.help-icon')) return;
const observer = new MutationObserver(() => {
// Check if a heading appeared
const heading = container.querySelector('h5, h6, .card-header h5, .card-header h6');
if (heading && !heading.querySelector('.help-icon')) {
this.injectIcon(sectionKey, heading);
observer.disconnect();
}
});
observer.observe(container, { childList: true, subtree: true });
});
}
/**
* Handle document click β close popup if click is outside popup and icon.
* @param {Event} e
*/
_onDocumentClick(e) {
if (!this._currentPopup) return;
// Check if click is inside popup
if (this._currentPopup.contains(e.target)) return;
// Check if click is on a help icon
if (e.target.classList && e.target.classList.contains('help-icon')) return;
this.closePopup();
}
/**
* Build the inner HTML for the popup.
* @param {string} sectionKey
* @returns {string}
*/
_buildPopupHTML(sectionKey) {
const sectionName = this._sectionNames[sectionKey] || sectionKey;
const bodyText = this._getHelpText(sectionKey);
const langs = ['en', 'vi', 'ja'];
const langLabels = { en: 'EN', vi: 'VI', ja: 'JA' };
let langButtons = '';
langs.forEach((lang) => {
const active = lang === this._currentLang ? ' active' : '';
langButtons += `<button class="help-lang-btn${active}" data-lang="${lang}" title="${langLabels[lang]}">${langLabels[lang]}</button>`;
});
return `
<div class="help-popup-header">
<span class="help-popup-title">${this._escapeHtml(sectionName)}</span>
<button class="help-popup-close" title="Close" aria-label="Close">×</button>
</div>
<div class="help-popup-body">${this._escapeHtml(bodyText)}</div>
<div class="help-popup-footer">${langButtons}</div>
`;
}
/**
* Get help text for a section in the current language.
* @param {string} sectionKey
* @returns {string}
*/
_getHelpText(sectionKey) {
if (!this._helpContent) {
return 'Help content unavailable';
}
const section = this._helpContent[sectionKey];
if (!section) {
return 'Help content unavailable';
}
return section[this._currentLang] || section[this._defaultLang] || section['en'] || 'Help content unavailable';
}
/**
* Position the popup near the anchor element, ensuring it stays within viewport.
* @param {HTMLElement} popup
* @param {HTMLElement} anchor
*/
_positionPopup(popup, anchor) {
const rect = anchor.getBoundingClientRect();
const scrollX = window.pageXOffset || document.documentElement.scrollLeft;
const scrollY = window.pageYOffset || document.documentElement.scrollTop;
// Default: position below the icon
let top = rect.bottom + scrollY + 6;
let left = rect.left + scrollX;
// Apply position so we can measure popup dimensions
popup.style.position = 'absolute';
popup.style.top = top + 'px';
popup.style.left = left + 'px';
// Adjust if popup overflows right edge
const popupRect = popup.getBoundingClientRect();
const viewportWidth = window.innerWidth;
if (popupRect.right > viewportWidth - 10) {
left = Math.max(10, viewportWidth - popupRect.width - 10 + scrollX);
popup.style.left = left + 'px';
}
// Adjust if popup overflows bottom edge
const viewportHeight = window.innerHeight;
if (popupRect.bottom > viewportHeight - 10) {
// Position above the icon instead
top = rect.top + scrollY - popupRect.height - 6;
if (top < scrollY + 10) {
top = scrollY + 10;
}
popup.style.top = top + 'px';
}
}
/**
* Attach click handlers to language buttons inside the popup.
* @param {HTMLElement} popup
* @param {string} sectionKey
*/
_attachLangHandlers(popup, sectionKey) {
const buttons = popup.querySelectorAll('.help-lang-btn');
buttons.forEach((btn) => {
btn.addEventListener('click', (e) => {
e.stopPropagation();
const lang = btn.getAttribute('data-lang');
this.setLanguage(lang);
// Update body text
const body = popup.querySelector('.help-popup-body');
if (body) {
body.textContent = this._getHelpText(sectionKey);
}
// Update active state on buttons
buttons.forEach((b) => b.classList.remove('active'));
btn.classList.add('active');
});
});
}
/**
* Escape HTML special characters.
* @param {string} str
* @returns {string}
*/
_escapeHtml(str) {
const div = document.createElement('div');
div.appendChild(document.createTextNode(String(str)));
return div.innerHTML;
}
}
window.HelpTooltip = HelpTooltip;
|