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

Jump to bottom

OEL-2799: Svg sprite css attributes. #576

Open
wants to merge 5 commits into
base: development
Choose a base branch
from
Open

OEL-2799: Svg sprite css attributes. #576

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
41ac7f1
OEL-2799: POC svg sprite css classes.
tibi2303 Feb 6, 2024
c91e486
Merge branch 'development' into OEL-2799
tibi2303 May 23, 2024
13ed1e8
OEL-2799: Added icon classes.
tibi2303 May 28, 2024
86de5fb
OEL-2799: Fixed deploy demo.
tibi2303 Jun 11, 2024
e7531fc
OEL-2799: Improved demo.
tibi2303 Jun 11, 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
17 changes: 16 additions & 1 deletion builder/scripts/sprite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ const path = require("path");
const defaultPlugins = require("../conf/svgoDefaultPlugins");
const SVGSpriter = require("svg-sprite");

let svgMarkup;

const addSvgMarkup = (filePath) => {
drishu marked this conversation as resolved.
Show resolved Hide resolved
const fileContents = fs.readFileSync(filePath, { encoding: "utf-8" });
svgMarkup = svgMarkup += "</svg>"; // Closing svg tag.
const updatedContents = fileContents.replace("</svg>", svgMarkup);
drishu marked this conversation as resolved.
Show resolved Hide resolved
fs.writeFileSync(filePath, updatedContents);
};

module.exports = (entry, dest, options) => {
const iconList = Array.isArray(options.list)
? options.list.flat(1)
Expand Down Expand Up @@ -64,7 +73,7 @@ module.exports = (entry, dest, options) => {
},
},
});

let svgYPosition = 0;
files.forEach((file) => {
let filePath;
if (Array.isArray(entry)) {
Expand All @@ -75,6 +84,10 @@ module.exports = (entry, dest, options) => {
} else {
filePath = path.resolve(entry, file);
}
const id = path.basename(file, path.extname(file)); // Extracting file name without extension as id
svgMarkup =
svgMarkup += `<view id="${id}-view" viewBox="0 ${svgYPosition} 16 16"/><use xlink:href="#${id}" width="16" height="16" x="0" y="${svgYPosition}" id="${id}-use"/>`;
svgYPosition = svgYPosition + 16;
spriter.add(
filePath,
file,
Expand All @@ -90,6 +103,8 @@ module.exports = (entry, dest, options) => {
result[mode][resource].path,
result[mode][resource].contents
);
const outputPath = result[mode][resource].path;
addSvgMarkup(outputPath);
});
});
});
Expand Down
3 changes: 3 additions & 0 deletions src/compositions/bcl-icons-list/icons-list.story.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import icons_list from "@openeuropa/bcl-icons-list/icons-list.html.twig";
import icons_manager from "@openeuropa/bcl-icons-list/icons-manager.html.twig";
import icons from "@openeuropa/bcl-theme-default/src/icons/icons";
import customIcons from "@openeuropa/bcl-theme-default/src/icons/custom-icons";
import defaultSprite from "@openeuropa/bcl-theme-default/icons/bcl-default-icons.svg";
Expand All @@ -17,3 +18,5 @@ export default {

export const Default = () =>
icons_list({ icons: iconsList, path: defaultSprite });

export const Attribute = () => icons_manager({ icons: iconsList });
81 changes: 81 additions & 0 deletions src/compositions/bcl-icons-list/icons-manager.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
{% apply spaceless %}

{# Parameters:
- icons: (icon[]) (default: [])
- path (string) (default: '')
#}

{% set _icons = icons|default([]) %}
{% set _path = path|default('') %}

{% if _icons is not empty and _icons is iterable %}
<div class="px-4">
<div class="row">
<h3 class="mt-4"> Icon Colours </h3>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Default</p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-primary" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Primary<br><b>icon-color-primary</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-secondary" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Secondary<br><b>icon-color-secondary</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-success" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Success<br><b>icon-color-success</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-info" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Info<br><b>icon-color-info</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-warning" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Warning<br><b>icon-color-warning</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-danger" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Danger<br><b>icon-color-danger</b></p>
</div>
<div class="px-2 my-5 col">
<span class="icon mx-auto icon-xl icon-color-dark" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Dark<br><b>icon-color-dark</b></p>
</div>
<div class="px-2 my-5 col text-center">
<div class="p-3 bg-dark d-inline-block">
<span class="icon mx-auto icon-xl icon-color-light" data-icon="arrow-clockwise"></span>
</div>
<p class="text-center text-nowrap">Light<br><b>icon-color-light</b></p>
</div>
<div>
<div class="row">
<h3 class="mt-4"> Icon Sizes </h3>
<div class="px-3 my-5 col">
<span class="icon mx-auto" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">Default</p>
</div>
<div class="px-3 my-5 col">
<span class="icon mx-auto icon-lg" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">LG - <b>icon-lg</b></p>
</div>
<div class="px-3 my-5 col">
<span class="icon mx-auto icon-xl" data-icon="arrow-clockwise"></span>
<p class="text-center text-nowrap">XL - <b>icon-xl</b></p>
</div>
<div>
<div class="row">
<h3>Icons List</h3>
{% for _icon in _icons %}
<div class="px-3 my-5 col">
<span class="icon mx-auto icon-xl" data-icon="{{ _icon }}"></span>
<p class="text-center text-nowrap">{{ _icon }}</p>
</div>
{% endfor %}
</div>
</div>
{% endif %}

{% endapply %}
37 changes: 37 additions & 0 deletions src/themes/default/src/js/icon-manager/icon-manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/**
* --------------------------------------------------------------------------
* IconManager Class Documentation
* --------------------------------------------------------------------------
*
* Overview:
* The `IconManager` class is a utility for dynamically setting the `mask-image`
* of HTML elements based on custom data attributes. It uses CSS custom properties
* and JavaScript to ensure the correct SVG icon is applied to elements with the class `.icon`.
*
*/

import { defineJQueryPlugin } from '@openeuropa/bcl-bootstrap/js/src/util/index'

class IconManager {
initializeIcons() {
this.iconPath = getComputedStyle(document.body).getPropertyValue('--icon-path').trim().replace(/['"]/g, '');
document.querySelectorAll('.icon[data-icon]').forEach(icon => {
const iconId = icon.getAttribute('data-icon');
this.setIconMask(icon, iconId);
});
}

setIconMask(icon, iconId) {
icon.style.maskImage = `url(${this.iconPath}#${iconId}-view)`;
icon.style.webkitMaskImage = `url(${this.iconPath}#${iconId}-view)`;
}
}

document.addEventListener('DOMContentLoaded', () => {
const iconManager = new IconManager();
iconManager.initializeIcons();
});

defineJQueryPlugin(IconManager);

export default IconManager;
2 changes: 2 additions & 0 deletions src/themes/default/src/js/index.esm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import ScrollSpy from "@openeuropa/bcl-bootstrap/js/src/scrollspy-legacy";
import Tab from "@openeuropa/bcl-bootstrap/js/src/tab";
import Toast from "@openeuropa/bcl-bootstrap/js/src/toast";
import Tooltip from "@openeuropa/bcl-bootstrap/js/src/tooltip";
import IconManager from "@openeuropa/bcl-theme-default/src/js/icon-manager/icon-manager";

export {
Alert,
Expand All @@ -35,4 +36,5 @@ export {
Tab,
Toast,
Tooltip,
IconManager,
};
2 changes: 2 additions & 0 deletions src/themes/default/src/js/index.umd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import ScrollSpy from "@openeuropa/bcl-bootstrap/js/src/scrollspy-legacy";
import Tab from "@openeuropa/bcl-bootstrap/js/src/tab";
import Toast from "@openeuropa/bcl-bootstrap/js/src/toast";
import Tooltip from "@openeuropa/bcl-bootstrap/js/src/tooltip";
import IconManager from "@openeuropa/bcl-theme-default/src/js/icon-manager/icon-manager";

export default {
Alert,
Expand All @@ -35,4 +36,5 @@ export default {
Tab,
Toast,
Tooltip,
IconManager,
};
29 changes: 29 additions & 0 deletions src/themes/default/src/scss/_icon_manager.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
body {
--icon-path: "static/media/src/themes/default/icons/bcl-default-icons.svg";
}

.icon {
width: 1rem;
height: 1rem;
drishu marked this conversation as resolved.
Show resolved Hide resolved
display: block;
background-color: var(--bs-dark);
-webkit-mask-size: contain;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
mask-repeat: no-repeat;
}

@each $color, $value in $theme-colors {
.icon-color-#{$color} {
background-color: $value;
}
}

.icon-lg {
width: 1.5rem;
height: 1.5rem;
}
.icon-xl {
width: 2rem;
height: 2rem;
drishu marked this conversation as resolved.
Show resolved Hide resolved
}
1 change: 1 addition & 0 deletions src/themes/default/src/scss/oe-bcl-default.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@
@import "@openeuropa/bcl-theme-default/src/scss/carousel";
@import "@openeuropa/bcl-theme-default/src/scss/gallery";
@import "@openeuropa/bcl-theme-default/src/scss/pagination";
@import "@openeuropa/bcl-theme-default/src/scss/icon_manager";
Loading