Skip to content
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

fix: svg polygons not showing up; using DOMParser for svg #192

Closed
wants to merge 8 commits into from
Closed

fix: svg polygons not showing up; using DOMParser for svg #192

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a104651
fix: svg polygons not showing up in some decorated svg elements; usin…
dicagno Mar 16, 2023
78711e5
chore: cleanup hxl base path for icons
dicagno Mar 17, 2023
91b3afc
fix: enhancements, usage of <symbol> for referenced svg icons
dicagno Mar 17, 2023
7691e92
chore: better syntax, cleanup
dicagno Mar 17, 2023
14d6cdd
fix: typo
dicagno Mar 17, 2023
3cb43cc
fix: typo in skipping attributes
dicagno Mar 17, 2023
7f3a73a
fix: using symbol tag; no XML namespace attrs
dicagno Mar 17, 2023
f859313
chore: minimal style fix to retrigger checks
dicagno Mar 28, 2023
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
63 changes: 43 additions & 20 deletions scripts/lib-franklin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,32 +141,46 @@ export async function decorateIcons(element) {
// Download all new icons
const icons = [...element.querySelectorAll('span.icon')];
await Promise.all(icons.map(async (span) => {
const iconName = Array.from(span.classList).find((c) => c.startsWith('icon-')).substring(5);
if (span.classList.length < 2 || !span.classList[1].startsWith('icon-')) {
return;
}

const iconName = span.classList[1].substring(5);
if (!ICONS_CACHE[iconName]) {
ICONS_CACHE[iconName] = true;
try {
const response = await fetch(`${window.hlx.codeBasePath}/icons/${iconName}.svg`);
if (!response.ok) {
ICONS_CACHE[iconName] = false;
return;
}
// Styled icons don't play nice with the sprite approach because of shadow dom isolation
const svg = await response.text();
if (svg.match(/(<style | class=)/)) {
ICONS_CACHE[iconName] = { styled: true, html: svg };
const svgSource = await response.text();
if (svgSource.match(/(<style | class=)/)) {
ICONS_CACHE[iconName] = { styled: true, html: svgSource };
} else {
const parser = new DOMParser();
const parsedSvg = parser.parseFromString(svgSource, 'image/svg+xml');
const svgSymbol = document.createElementNS('http://www.w3.org/2000/svg', 'symbol');

const { attributes } = parsedSvg.documentElement;

for (let i = 0; i < attributes.length; i += 1) {
const { name, value } = attributes[i];

// remove XML namespace-related attributes
if (!name.startsWith('xmlns:') && name !== 'xmlns') {
svgSymbol.setAttribute(name, value);
}
}
svgSymbol.setAttribute('id', `icons-sprite-${iconName}`);
svgSymbol.removeAttribute('width');
svgSymbol.removeAttribute('height');

svgSymbol.innerHTML = parsedSvg.documentElement.innerHTML;

ICONS_CACHE[iconName] = {
html: svg
.replace('<svg', `<symbol id="icons-sprite-${iconName}"`)
.replace(/ width=".*?"/, '')
.replace(/ height=".*?"/, '')
.replace('</svg>', '</symbol>'),
html: svgSymbol.outerHTML,
};
}
} catch (error) {
ICONS_CACHE[iconName] = false;
} catch (err) {
// eslint-disable-next-line no-console
console.error(error);
console.error(err);
}
}
}));
Expand All @@ -175,13 +189,22 @@ export async function decorateIcons(element) {
svgSprite.innerHTML += symbols;

icons.forEach((span) => {
const iconName = Array.from(span.classList).find((c) => c.startsWith('icon-')).split('-')[1];
if (span.classList.length < 2 || !span.classList[1].startsWith('icon-')) {
return;
}

const iconName = span.classList[1].substring(5);
const parent = span.firstElementChild?.tagName === 'A' ? span.firstElementChild : span;
// Styled icons need to be inlined as-is, while unstyled ones can leverage the sprite
if (ICONS_CACHE[iconName].styled) {
parent.innerHTML = ICONS_CACHE[iconName].html;
} else {
parent.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg"><use href="#icons-sprite-${iconName}"/></svg>`;
const svgElem = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
const useElem = document.createElement('use');

useElem.setAttribute('href', `#icons-sprite-${iconName}`);

svgElem.innerHTML = useElem.outerHTML;
parent.innerHTML = svgElem.outerHTML;
}
});
}
Expand Down