From 42a621da34964eececd34fdbe4faa3a624566261 Mon Sep 17 00:00:00 2001 From: Rares Munteanu Date: Tue, 12 Nov 2024 18:40:33 +0100 Subject: [PATCH] Revert "MWPW-140452 - Icon authoring in milo using the federal repo and individual SVG assets (#2986)" This reverts commit f379815f307f03c8e42fca3b598e657716d34cd8. --- libs/blocks/text/text.css | 7 +- libs/features/georoutingv2/georoutingv2.css | 1 - libs/features/georoutingv2/georoutingv2.js | 2 +- libs/features/icons/icons.js | 118 ++++---------------- libs/styles/styles.css | 39 ++----- libs/utils/utils.js | 50 ++++----- test/features/icons/icons.test.js | 61 +++++----- test/features/icons/mocks/body.html | 4 +- 8 files changed, 84 insertions(+), 198 deletions(-) diff --git a/libs/blocks/text/text.css b/libs/blocks/text/text.css index f8cbefd365..6242f50132 100644 --- a/libs/blocks/text/text.css +++ b/libs/blocks/text/text.css @@ -100,7 +100,7 @@ position: relative; } -.text-block .icon-list-item .icon.node-index-first { +.text-block .icon-list-item .icon.margin-right:not(.margin-left) { /* target first node only */ position: absolute; inset: 0 100% auto auto; } @@ -122,6 +122,7 @@ .text-block .icon-area { display: flex; + column-gap: var(--spacing-xs); } .text-block p.icon-area { /* NOT tags with icons in them */ @@ -217,6 +218,10 @@ max-width: unset; } +.text-block .icon-area.con-button { + column-gap: unset; +} + .text-block .icon-area picture { line-height: 0em; height: inherit; /* Safari + FF bug fix */ diff --git a/libs/features/georoutingv2/georoutingv2.css b/libs/features/georoutingv2/georoutingv2.css index 09df2cba8b..255ba3f301 100644 --- a/libs/features/georoutingv2/georoutingv2.css +++ b/libs/features/georoutingv2/georoutingv2.css @@ -83,7 +83,6 @@ } .dialog-modal.locale-modal-v2 span.icon { - display: inline; vertical-align: middle; } diff --git a/libs/features/georoutingv2/georoutingv2.js b/libs/features/georoutingv2/georoutingv2.js index 236e9b685a..7213696f63 100644 --- a/libs/features/georoutingv2/georoutingv2.js +++ b/libs/features/georoutingv2/georoutingv2.js @@ -194,7 +194,7 @@ function buildContent(currentPage, locale, geoData, locales) { { once: true }, ); img.src = `${config.miloLibs || config.codeRoot}/img/georouting/${flagFile}`; - const span = createTag('span', { class: 'icon node-index-first' }, img); + const span = createTag('span', { class: 'icon margin-inline-end' }, img); const mainAction = createTag('a', { class: 'con-button blue button-l', lang, role: 'button', 'aria-haspopup': !!locales, 'aria-expanded': false, href: '#', }, span); diff --git a/libs/features/icons/icons.js b/libs/features/icons/icons.js index a39ff61e06..975c0625dc 100644 --- a/libs/features/icons/icons.js +++ b/libs/features/icons/icons.js @@ -1,9 +1,5 @@ -import { getFederatedContentRoot } from '../../utils/federated.js'; -import { loadLink, loadStyle } from '../../utils/utils.js'; - let fetchedIcons; let fetched = false; -const federalIcons = {}; async function getSVGsfromFile(path) { /* c8 ignore next */ @@ -26,7 +22,6 @@ async function getSVGsfromFile(path) { return miloIcons; } -// TODO: remove after all consumers have stopped calling this method // eslint-disable-next-line no-async-promise-executor export const fetchIcons = (config) => new Promise(async (resolve) => { /* c8 ignore next */ @@ -39,10 +34,10 @@ export const fetchIcons = (config) => new Promise(async (resolve) => { resolve(fetchedIcons); }); -async function decorateToolTip(icon) { +function decorateToolTip(icon) { const wrapper = icon.closest('em'); - if (!wrapper) return; wrapper.className = 'tooltip-wrapper'; + if (!wrapper) return; const conf = wrapper.textContent.split('|'); // Text is the last part of a tooltip const content = conf.pop().trim(); @@ -50,101 +45,30 @@ async function decorateToolTip(icon) { icon.dataset.tooltip = content; // Position is the next to last part of a tooltip const place = conf.pop()?.trim().toLowerCase() || 'right'; - const defaultIcon = 'info-outline'; - icon.className = `icon icon-${defaultIcon} milo-tooltip ${place}`; - icon.dataset.name = defaultIcon; + icon.className = `icon icon-info milo-tooltip ${place}`; wrapper.parentElement.replaceChild(icon, wrapper); } -export function getIconData(icon) { - const fedRoot = getFederatedContentRoot(); - const name = [...icon.classList].find((c) => c.startsWith('icon-'))?.substring(5); - const path = `${fedRoot}/federal/assets/icons/svgs/${name}.svg`; - return { path, name }; -} - -function preloadInViewIconResources(config) { - const { base } = config; - loadStyle(`${base}/features/icons/icons.css`); -} - -const preloadInViewIcons = async (icons = []) => icons.forEach((icon) => { - const { path } = getIconData(icon); - loadLink(path, { rel: 'preload', as: 'fetch', crossorigin: 'anonymous' }); -}); - -function filterDuplicatedIcons(icons) { - if (!icons.length) return []; - const uniqueIconKeys = new Set(); - const uniqueIcons = []; - for (const icon of icons) { - const key = [...icon.classList].find((c) => c.startsWith('icon-'))?.substring(5); - if (!uniqueIconKeys.has(key)) { - uniqueIconKeys.add(key); - uniqueIcons.push(icon); - } - } - return uniqueIcons; -} - -export async function decorateIcons(area, icons, config) { - if (!icons.length) return; - const uniqueIcons = filterDuplicatedIcons(icons); - if (!uniqueIcons.length) return; - preloadInViewIcons(uniqueIcons); - preloadInViewIconResources(config); - icons.forEach((icon) => { - const iconName = [...icon.classList].find((c) => c.startsWith('icon-'))?.substring(5); - if (!iconName) return; - icon.dataset.name = iconName; - }); -} - -export default async function loadIcons(icons) { - const fedRoot = getFederatedContentRoot(); - const iconRequests = []; - const iconsToFetch = new Map(); - +export default async function loadIcons(icons, config) { + const iconSVGs = await fetchIcons(config); + if (!iconSVGs) return; icons.forEach(async (icon) => { - const isToolTip = icon.classList.contains('icon-tooltip'); - if (isToolTip) decorateToolTip(icon); - const iconName = icon.dataset.name; - if (icon.dataset.svgInjected || !iconName) return; - if (!federalIcons[iconName] && !iconsToFetch.has(iconName)) { - const url = `${fedRoot}/federal/assets/icons/svgs/${iconName}.svg`; - iconsToFetch.set(iconName, fetch(url) - .then(async (res) => { - if (!res.ok) throw new Error(`Failed to fetch SVG for ${iconName}: ${res.statusText}`); - const text = await res.text(); - const parser = new DOMParser(); - const svgDoc = parser.parseFromString(text, 'image/svg+xml'); - const svgElement = svgDoc.querySelector('svg'); - if (!svgElement) { - window.lana?.log(`No SVG element found in fetched content for ${iconName}`); - return; - } - const svgClone = svgElement.cloneNode(true); - svgClone.classList.add('icon-milo', `icon-milo-${iconName}`); - federalIcons[iconName] = svgClone; - }) - /* c8 ignore next 3 */ - .catch((error) => { - window.lana?.log(`Error fetching SVG for ${iconName}:`, error); - })); - } - iconRequests.push(iconsToFetch.get(iconName)); + const { classList } = icon; + if (classList.contains('icon-tooltip')) decorateToolTip(icon); + const iconName = icon.classList[1].replace('icon-', ''); + const existingIcon = icon.querySelector('svg'); + if (!iconSVGs[iconName] || existingIcon) return; const parent = icon.parentElement; - if (parent && parent.parentElement.tagName === 'LI') parent.parentElement.classList.add('icon-list-item'); - }); - - await Promise.all(iconRequests); - - icons.forEach((icon) => { - const iconName = icon.dataset.name; - if (iconName && federalIcons[iconName] && !icon.dataset.svgInjected) { - const svgClone = federalIcons[iconName].cloneNode(true); - icon.appendChild(svgClone); - icon.dataset.svgInjected = 'true'; + if (parent.childNodes.length > 1) { + if (parent.lastChild === icon) { + icon.classList.add('margin-inline-start'); + } else if (parent.firstChild === icon) { + icon.classList.add('margin-inline-end'); + if (parent.parentElement.tagName === 'LI') parent.parentElement.classList.add('icon-list-item'); + } else { + icon.classList.add('margin-inline-start', 'margin-inline-end'); + } } + icon.insertAdjacentHTML('afterbegin', iconSVGs[iconName].outerHTML); }); } diff --git a/libs/styles/styles.css b/libs/styles/styles.css index 1bf6c4bb08..febdd75f5c 100644 --- a/libs/styles/styles.css +++ b/libs/styles/styles.css @@ -128,7 +128,6 @@ --icon-size-s: 32px; --icon-size-xs: 24px; --icon-size-xxs: 16px; - --icon-spacing: 8px; /* z-index */ --above-all: 9000; /* Used for page tools that overlay page content */ @@ -350,7 +349,6 @@ line-height: 20px; min-height: 21px; padding: 7px 18px 8px; - --icon-spacing: 12px; } .xl-button .con-button, @@ -360,17 +358,6 @@ line-height: 24px; min-height: 28px; padding: 10px 24px 8px; - --icon-spacing: 14px; -} - -.xxl-button .con-button, -.con-button.button-xxl { - border-radius: 30px; - font-size: 22px; - line-height: 27px; - min-height: 27px; - padding: 14px 30px 15px; - --icon-spacing: 14px; } .xxl-button .con-button, @@ -568,23 +555,19 @@ div[data-failed="true"]::before { color: var(--color-gray-300); } -span.icon { - width: 1em; - display: inline-block; - margin-inline: var(--icon-spacing); -} +span.icon.margin-right { margin-right: 8px; } -span.icon.node-index-first { margin-inline-start: unset; } -span.icon.node-index-middle { margin-inline: var(--icon-spacing); } -span.icon.node-index-last { margin-inline-end: unset; } -span.icon.node-index-only { margin-inline: unset; } +span.icon.margin-left { margin-left: 8px; } -span.icon svg { - height: 1em; - position: relative; - top: .1em; - width: auto; -} +span.icon.margin-inline-end { margin-inline-end: 8px; } + +span.icon.margin-inline-start { margin-inline-start: 8px; } + +.button-l .con-button span.icon.margin-left, +.con-button.button-l span.icon.margin-left { margin-left: 12px; } + +.button-xl .con-button span.icon.margin-left, +.con-button.button-xl span.icon.margin-left { margin-left: 14px; } /* Con Block Utils */ .con-block.xs-spacing { padding: var(--spacing-xs) 0; } diff --git a/libs/utils/utils.js b/libs/utils/utils.js index c29960c7de..baf303c781 100644 --- a/libs/utils/utils.js +++ b/libs/utils/utils.js @@ -311,7 +311,7 @@ export function localizeLink( const isLocalizedLink = path.startsWith(`/${LANGSTORE}`) || path.startsWith(`/${PREVIEW}`) || Object.keys(locales).some((loc) => loc !== '' && (path.startsWith(`/${loc}/`) - || path.endsWith(`/${loc}`))); + || path.endsWith(`/${loc}`))); if (isLocalizedLink) return processedHref; const urlPath = `${locale.prefix}${path}${url.search}${hash}`; return relative ? urlPath : `${url.origin}${urlPath}`; @@ -762,7 +762,7 @@ function decorateHeader() { } header.className = headerMeta || 'global-navigation'; const metadataConfig = getMetadata('breadcrumbs')?.toLowerCase() - || getConfig().breadcrumbs; + || getConfig().breadcrumbs; if (metadataConfig === 'off') return; const baseBreadcrumbs = getMetadata('breadcrumbs-base')?.length; @@ -775,6 +775,16 @@ function decorateHeader() { if (promo?.length) header.classList.add('has-promo'); } +async function decorateIcons(area, config) { + const icons = area.querySelectorAll('span.icon'); + if (icons.length === 0) return; + const { base } = config; + loadStyle(`${base}/features/icons/icons.css`); + loadLink(`${base}/img/icons/icons.svg`, { rel: 'preload', as: 'fetch', crossorigin: 'anonymous' }); + const { default: loadIcons } = await import('../features/icons/icons.js'); + await loadIcons(icons, config); +} + export async function customFetch({ resource, withCacheRules }) { const options = {}; if (withCacheRules) { @@ -814,8 +824,8 @@ async function decoratePlaceholders(area, config) { area.dataset.hasPlaceholders = 'true'; const placeholderPath = `${config.locale?.contentRoot}/placeholders.json`; placeholderRequest = placeholderRequest - || customFetch({ resource: placeholderPath, withCacheRules: true }) - .catch(() => ({})); + || customFetch({ resource: placeholderPath, withCacheRules: true }) + .catch(() => ({})); const { decoratePlaceholderArea } = await import('../features/placeholders.js'); await decoratePlaceholderArea({ placeholderPath, placeholderRequest, nodes }); } @@ -1185,8 +1195,9 @@ function decorateDocumentExtras() { decorateHeader(); } -async function documentPostSectionLoading(area, config) { +async function documentPostSectionLoading(config) { decorateFooterPromo(); + const appendage = getMetadata('title-append'); if (appendage) { import('../features/title-append/title-append.js').then((module) => module.default(appendage)); @@ -1250,18 +1261,6 @@ async function resolveInlineFrags(section) { section.preloadLinks = newlyDecoratedSection.preloadLinks; } -export function setIconsIndexClass(icons) { - [...icons].forEach((icon) => { - const parent = icon.parentNode; - const children = parent.childNodes; - const nodeIndex = [...children].indexOf.call(children, icon); - let indexClass = (nodeIndex === children.length - 1) ? 'last' : 'middle'; - if (nodeIndex === 0) indexClass = 'first'; - if (children.length === 1) indexClass = 'only'; - icon.classList.add(`node-index-${indexClass}`); - }); -} - async function processSection(section, config, isDoc) { await resolveInlineFrags(section); const firstSection = section.el.dataset.idx === '0'; @@ -1269,6 +1268,7 @@ async function processSection(section, config, isDoc) { preloadBlockResources(section.preloadLinks); await Promise.all([ decoratePlaceholders(section.el, config), + decorateIcons(section.el, config), ]); const loadBlocks = [...stylePromises]; if (section.preloadLinks.length) { @@ -1301,11 +1301,6 @@ export async function loadArea(area = document) { decorateDocumentExtras(); } - const allIcons = area.querySelectorAll('span.icon'); - if (allIcons.length) { - setIconsIndexClass(allIcons); - } - const sections = decorateSections(area, isDoc); const areaBlocks = []; @@ -1318,20 +1313,13 @@ export async function loadArea(area = document) { }); } - if (allIcons.length) { - const { default: loadIcons, decorateIcons } = await import('../features/icons/icons.js'); - await decorateIcons(area, allIcons, config); - await loadIcons(allIcons); - } - const currentHash = window.location.hash; if (currentHash) { scrollToHashedElement(currentHash); } - if (isDoc) { - await documentPostSectionLoading(area, config); - } + if (isDoc) await documentPostSectionLoading(config); + await loadDeferred(area, areaBlocks, config); } diff --git a/test/features/icons/icons.test.js b/test/features/icons/icons.test.js index cb3cb994db..cd355a0aff 100644 --- a/test/features/icons/icons.test.js +++ b/test/features/icons/icons.test.js @@ -1,56 +1,45 @@ import { readFile } from '@web/test-runner-commands'; import { expect } from '@esm-bundle/chai'; -import sinon, { stub } from 'sinon'; -import { waitForElement } from '../../helpers/waitfor.js'; +import { stub } from 'sinon'; +import { setConfig, getConfig, createTag } from '../../../libs/utils/utils.js'; -const { default: loadIcons, getIconData } = await import('../../../libs/features/icons/icons.js'); -const { setIconsIndexClass } = await import('../../../libs/utils/utils.js'); -const mockRes = ({ payload, status = 200, ok = true } = {}) => new Promise((resolve) => { - resolve({ - status, - ok, - json: () => payload, - text: () => payload, - }); -}); +const { default: loadIcons } = await import('../../../libs/features/icons/icons.js'); + +const codeRoot = '/libs'; +const conf = { codeRoot }; +setConfig(conf); +const config = getConfig(); document.body.innerHTML = await readFile({ path: './mocks/body.html' }); let icons; -const svgEx = ` - - -`; describe('Icon Suppprt', () => { - beforeEach(() => { - stub(window, 'fetch').callsFake(() => mockRes({})); - }); + let paramsGetStub; - afterEach(() => { - sinon.restore(); + before(() => { + paramsGetStub = stub(URLSearchParams.prototype, 'get'); + paramsGetStub.withArgs('cache').returns('off'); }); - it('Replaces span.icon', async () => { - const payload = svgEx; - window.fetch.returns(mockRes({ payload })); + after(() => { + paramsGetStub.restore(); + }); + before(async () => { icons = document.querySelectorAll('span.icon'); - icons.forEach((icon) => { - const { name } = getIconData(icon); - icon.dataset.name = name; - }); - await loadIcons(icons); + await loadIcons(icons, config); + await loadIcons(icons, config); // Test duplicate icon not created if run twice + }); - const selector = await waitForElement('span.icon svg'); - expect(selector).to.exist; + it('Fetches successfully with cache control enabled', async () => { + const otherIcons = [createTag('span', { class: 'icon icon-play' })]; + await loadIcons(otherIcons, config); }); - it('Sets icon index class', async () => { - icons = document.querySelectorAll('span.icon'); - setIconsIndexClass(icons); - const secondIconHasIndexClass = icons[2].classList.contains('node-index-last'); - expect(secondIconHasIndexClass).to.be.true; + it('Replaces span.icon', async () => { + const selector = icons[0].querySelector(':scope svg'); + expect(selector).to.exist; }); it('No duplicate icon', async () => { diff --git a/test/features/icons/mocks/body.html b/test/features/icons/mocks/body.html index 2d908a81ca..586013bf4f 100644 --- a/test/features/icons/mocks/body.html +++ b/test/features/icons/mocks/body.html @@ -1,6 +1,4 @@ -
- -
+