rollup-plugin-svg-sprites
Version:
Rollup plugin for creating SVG sprites.
950 lines (795 loc) • 24 kB
JavaScript
/* eslint-disable */
var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
var deepmerge = {exports: {}};
(function (module, exports) {
(function (root, factory) {
{
module.exports = factory();
}
}(commonjsGlobal, function () {
function isMergeableObject(val) {
var nonNullObject = val && typeof val === 'object';
return nonNullObject
&& Object.prototype.toString.call(val) !== '[object RegExp]'
&& Object.prototype.toString.call(val) !== '[object Date]'
}
function emptyTarget(val) {
return Array.isArray(val) ? [] : {}
}
function cloneIfNecessary(value, optionsArgument) {
var clone = optionsArgument && optionsArgument.clone === true;
return (clone && isMergeableObject(value)) ? deepmerge(emptyTarget(value), value, optionsArgument) : value
}
function defaultArrayMerge(target, source, optionsArgument) {
var destination = target.slice();
source.forEach(function(e, i) {
if (typeof destination[i] === 'undefined') {
destination[i] = cloneIfNecessary(e, optionsArgument);
} else if (isMergeableObject(e)) {
destination[i] = deepmerge(target[i], e, optionsArgument);
} else if (target.indexOf(e) === -1) {
destination.push(cloneIfNecessary(e, optionsArgument));
}
});
return destination
}
function mergeObject(target, source, optionsArgument) {
var destination = {};
if (isMergeableObject(target)) {
Object.keys(target).forEach(function (key) {
destination[key] = cloneIfNecessary(target[key], optionsArgument);
});
}
Object.keys(source).forEach(function (key) {
if (!isMergeableObject(source[key]) || !target[key]) {
destination[key] = cloneIfNecessary(source[key], optionsArgument);
} else {
destination[key] = deepmerge(target[key], source[key], optionsArgument);
}
});
return destination
}
function deepmerge(target, source, optionsArgument) {
var array = Array.isArray(source);
var options = optionsArgument || { arrayMerge: defaultArrayMerge };
var arrayMerge = options.arrayMerge || defaultArrayMerge;
if (array) {
return Array.isArray(target) ? arrayMerge(target, source, optionsArgument) : cloneIfNecessary(source, optionsArgument)
} else {
return mergeObject(target, source, optionsArgument)
}
}
deepmerge.all = function deepmergeAll(array, optionsArgument) {
if (!Array.isArray(array) || array.length < 2) {
throw new Error('first argument should be an array with at least two elements')
}
// we are sure there are at least 2 values, so it is safe to have no initial value
return array.reduce(function(prev, next) {
return deepmerge(prev, next, optionsArgument)
})
};
return deepmerge
}));
}(deepmerge));
var merge = deepmerge.exports;
//
// An event handler can take an optional event argument
// and should not return a value
// An array of all currently registered event handlers for a type
// A map of event types and their corresponding event handlers.
/** Mitt: Tiny (~200b) functional event emitter / pubsub.
* @name mitt
* @returns {Mitt}
*/
function mitt(all ) {
all = all || Object.create(null);
return {
/**
* Register an event handler for the given type.
*
* @param {String} type Type of event to listen for, or `"*"` for all events
* @param {Function} handler Function to call in response to given event
* @memberOf mitt
*/
on: function on(type , handler ) {
(all[type] || (all[type] = [])).push(handler);
},
/**
* Remove an event handler for the given type.
*
* @param {String} type Type of event to unregister `handler` from, or `"*"`
* @param {Function} handler Handler function to remove
* @memberOf mitt
*/
off: function off(type , handler ) {
if (all[type]) {
all[type].splice(all[type].indexOf(handler) >>> 0, 1);
}
},
/**
* Invoke all handlers for the given type.
* If present, `"*"` handlers are invoked after type-matched handlers.
*
* @param {String} type The event type to invoke
* @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
* @memberof mitt
*/
emit: function emit(type , evt ) {
(all[type] || []).map(function (handler) { handler(evt); });
(all['*'] || []).map(function (handler) { handler(type, evt); });
}
};
}
var namespaces$1 = {exports: {}};
(function (module, exports) {
const namespaces = {
svg: {
name: 'xmlns',
uri: 'http://www.w3.org/2000/svg'
},
xlink: {
name: 'xmlns:xlink',
uri: 'http://www.w3.org/1999/xlink'
}
};
exports.default = namespaces;
module.exports = exports.default;
}(namespaces$1, namespaces$1.exports));
var namespaces = namespaces$1.exports;
/**
* @param {Object} attrs
* @return {string}
*/
function objectToAttrsString (attrs) {
return Object.keys(attrs).map((attr) => {
const value = attrs[attr].toString().replace(/"/g, '"');
return `${attr}="${value}"`;
}).join(' ');
}
const { svg: svg$1, xlink: xlink$1 } = namespaces;
const defaultAttrs = {
[svg$1.name]: svg$1.uri,
[xlink$1.name]: xlink$1.uri
};
/**
* @param {string} [content]
* @param {Object} [attributes]
* @return {string}
*/
function wrapInSvgString (content = '', attributes) {
const attrs = merge(defaultAttrs, attributes || {});
const attrsRendered = objectToAttrsString(attrs);
return `<svg ${attrsRendered}>${content}</svg>`;
}
const { svg, xlink } = namespaces;
var defaultConfig$1 = {
attrs: {
[svg.name]: svg.uri,
[xlink.name]: xlink.uri,
style: ['position: absolute', 'width: 0', 'height: 0'].join('; '),
'aria-hidden': 'true'
}
};
class Sprite {
/**
* @param {Object} [config]
*/
constructor(config) {
this.config = merge(defaultConfig$1, config || {});
this.symbols = [];
}
/**
* Add new symbol. If symbol with the same id exists it will be replaced.
* @param {SpriteSymbol} symbol
* @return {boolean} `true` - symbol was added, `false` - replaced
*/
add(symbol) {
const { symbols } = this;
const existing = this.find(symbol.id);
if (existing) {
symbols[symbols.indexOf(existing)] = symbol;
return false;
}
symbols.push(symbol);
return true;
}
/**
* Remove symbol & destroy it
* @param {string} id
* @return {boolean} `true` - symbol was found & successfully destroyed, `false` - otherwise
*/
remove(id) {
const { symbols } = this;
const symbol = this.find(id);
if (symbol) {
symbols.splice(symbols.indexOf(symbol), 1);
symbol.destroy();
return true;
}
return false;
}
/**
* @param {string} id
* @return {SpriteSymbol|null}
*/
find(id) {
return this.symbols.filter(s => s.id === id)[0] || null;
}
/**
* @param {string} id
* @return {boolean}
*/
has(id) {
return this.find(id) !== null;
}
/**
* @return {string}
*/
stringify() {
const { attrs } = this.config;
const stringifiedSymbols = this.symbols.map(s => s.stringify()).join('');
return wrapInSvgString(stringifiedSymbols, attrs);
}
/**
* @return {string}
*/
toString() {
return this.stringify();
}
destroy() {
this.symbols.forEach(s => s.destroy());
}
}
class SpriteSymbol {
constructor({ id, viewBox, content }) {
this.id = id;
this.viewBox = viewBox;
this.content = content;
}
/**
* @return {string}
*/
stringify() {
return this.content;
}
/**
* @return {string}
*/
toString() {
return this.stringify();
}
destroy() {
['id', 'viewBox', 'content'].forEach(prop => delete this[prop]);
}
}
/**
* @param {string} content
* @return {Element}
*/
function parse (content) {
const hasImportNode = !!document.importNode;
const doc = new DOMParser().parseFromString(content, 'image/svg+xml').documentElement;
/**
* Fix for browser which are throwing WrongDocumentError
* if you insert an element which is not part of the document
* @see http://stackoverflow.com/a/7986519/4624403
*/
if (hasImportNode) {
return document.importNode(doc, true);
}
return doc;
}
class BrowserSpriteSymbol extends SpriteSymbol {
get isMounted() {
return !!this.node;
}
/**
* @param {Element} node
* @return {BrowserSpriteSymbol}
*/
static createFromExistingNode(node) {
return new BrowserSpriteSymbol({
id: node.getAttribute('id'),
viewBox: node.getAttribute('viewBox'),
content: node.outerHTML
});
}
destroy() {
if (this.isMounted) {
this.unmount();
}
super.destroy();
}
/**
* @param {Element|string} target
* @return {Element}
*/
mount(target) {
if (this.isMounted) {
return this.node;
}
const mountTarget = typeof target === 'string' ? document.querySelector(target) : target;
const node = this.render();
this.node = node;
mountTarget.appendChild(node);
return node;
}
/**
* @return {Element}
*/
render() {
const content = this.stringify();
return parse(wrapInSvgString(content)).childNodes[0];
}
unmount() {
this.node.parentNode.removeChild(this.node);
}
}
var defaultConfig = {
/**
* Should following options be automatically configured:
* - `syncUrlsWithBaseTag`
* - `locationChangeAngularEmitter`
* - `moveGradientsOutsideSymbol`
* @type {boolean}
*/
autoConfigure: true,
/**
* Default mounting selector
* @type {string}
*/
mountTo: 'body',
/**
* Fix disappearing SVG elements when <base href> exists.
* Executes when sprite mounted.
* @see http://stackoverflow.com/a/18265336/796152
* @see https://github.com/everdimension/angular-svg-base-fix
* @see https://github.com/angular/angular.js/issues/8934#issuecomment-56568466
* @type {boolean}
*/
syncUrlsWithBaseTag: false,
/**
* Should sprite listen custom location change event
* @type {boolean}
*/
listenLocationChangeEvent: true,
/**
* Custom window event name which should be emitted to update sprite urls
* @type {string}
*/
locationChangeEvent: 'locationChange',
/**
* Emit location change event in Angular automatically
* @type {boolean}
*/
locationChangeAngularEmitter: false,
/**
* Selector to find symbols usages when updating sprite urls
* @type {string}
*/
usagesToUpdate: 'use[*|href]',
/**
* Fix Firefox bug when gradients and patterns don't work if they are within a symbol.
* Executes when sprite is rendered, but not mounted.
* @see https://bugzilla.mozilla.org/show_bug.cgi?id=306674
* @see https://bugzilla.mozilla.org/show_bug.cgi?id=353575
* @see https://bugzilla.mozilla.org/show_bug.cgi?id=1235364
* @type {boolean}
*/
moveGradientsOutsideSymbol: false
};
/**
* @param {*} arrayLike
* @return {Array}
*/
function arrayFrom (arrayLike) {
return Array.prototype.slice.call(arrayLike, 0);
}
var browser = {
isChrome: () => /chrome/i.test(navigator.userAgent),
isFirefox: () => /firefox/i.test(navigator.userAgent),
// https://msdn.microsoft.com/en-us/library/ms537503(v=vs.85).aspx
isIE: () => /msie/i.test(navigator.userAgent) || /trident/i.test(navigator.userAgent),
isEdge: () => /edge/i.test(navigator.userAgent)
};
/**
* @param {string} name
* @param {*} data
*/
function dispatchEvent (name, data) {
const event = document.createEvent('CustomEvent');
event.initCustomEvent(name, false, false, data);
window.dispatchEvent(event);
}
/**
* IE doesn't evaluate <style> tags in SVGs that are dynamically added to the page.
* This trick will trigger IE to read and use any existing SVG <style> tags.
* @see https://github.com/iconic/SVGInjector/issues/23
* @see https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/10898469/
*
* @param {Element} node DOM Element to search <style> tags in
* @return {Array<HTMLStyleElement>}
*/
function evalStylesIEWorkaround (node) {
const updatedNodes = [];
arrayFrom(node.querySelectorAll('style'))
.forEach((style) => {
style.textContent += '';
updatedNodes.push(style);
});
return updatedNodes;
}
/**
* @param {string} [url] If not provided - current URL will be used
* @return {string}
*/
function getUrlWithoutFragment (url) {
return (url || window.location.href).split('#')[0];
}
/* global angular */
/**
* @param {string} eventName
*/
function locationChangeAngularEmitter (eventName) {
angular.module('ng').run(['$rootScope', ($rootScope) => {
$rootScope.$on('$locationChangeSuccess', (e, newUrl, oldUrl) => {
dispatchEvent(eventName, { oldUrl, newUrl });
});
}]);
}
const defaultSelector = 'linearGradient, radialGradient, pattern, mask, clipPath';
/**
* @param {Element} svg
* @param {string} [selector]
* @return {Element}
*/
function moveGradientsOutsideSymbol (svg, selector = defaultSelector) {
arrayFrom(svg.querySelectorAll('symbol')).forEach((symbol) => {
arrayFrom(symbol.querySelectorAll(selector)).forEach((node) => {
symbol.parentNode.insertBefore(node, symbol);
});
});
return svg;
}
/**
* @param {NodeList} nodes
* @param {Function} [matcher]
* @return {Attr[]}
*/
function selectAttributes(nodes, matcher) {
const attrs = arrayFrom(nodes).reduce((acc, node) => {
if (!node.attributes) {
return acc;
}
const arrayfied = arrayFrom(node.attributes);
const matched = matcher ? arrayfied.filter(matcher) : arrayfied;
return acc.concat(matched);
}, []);
return attrs;
}
const xLinkNS = namespaces.xlink.uri;
const xLinkAttrName = 'xlink:href';
// eslint-disable-next-line no-useless-escape
const specialUrlCharsPattern = /[{}|\\\^\[\]`"<>]/g;
function encoder(url) {
return url.replace(specialUrlCharsPattern, (match) => {
return `%${match[0].charCodeAt(0).toString(16).toUpperCase()}`;
});
}
function escapeRegExp(str) {
return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
}
/**
* @param {NodeList} nodes
* @param {string} startsWith
* @param {string} replaceWith
* @return {NodeList}
*/
function updateReferences(nodes, startsWith, replaceWith) {
arrayFrom(nodes).forEach((node) => {
const href = node.getAttribute(xLinkAttrName);
if (href && href.indexOf(startsWith) === 0) {
const newUrl = href.replace(startsWith, replaceWith);
node.setAttributeNS(xLinkNS, xLinkAttrName, newUrl);
}
});
return nodes;
}
/**
* List of SVG attributes to update url() target in them
*/
const attList = [
'clipPath',
'colorProfile',
'src',
'cursor',
'fill',
'filter',
'marker',
'markerStart',
'markerMid',
'markerEnd',
'mask',
'stroke',
'style'
];
const attSelector = attList.map(attr => `[${attr}]`).join(',');
/**
* Update URLs in svg image (like `fill="url(...)"`) and update referencing elements
* @param {Element} svg
* @param {NodeList} references
* @param {string|RegExp} startsWith
* @param {string} replaceWith
* @return {void}
*
* @example
* const sprite = document.querySelector('svg.sprite');
* const usages = document.querySelectorAll('use');
* updateUrls(sprite, usages, '#', 'prefix#');
*/
function updateUrls (svg, references, startsWith, replaceWith) {
const startsWithEncoded = encoder(startsWith);
const replaceWithEncoded = encoder(replaceWith);
const nodes = svg.querySelectorAll(attSelector);
const attrs = selectAttributes(nodes, ({ localName, value }) => {
return attList.indexOf(localName) !== -1 && value.indexOf(`url(${startsWithEncoded}`) !== -1;
});
attrs.forEach(attr => attr.value = attr.value.replace(new RegExp(escapeRegExp(startsWithEncoded), 'g'), replaceWithEncoded));
updateReferences(references, startsWithEncoded, replaceWithEncoded);
}
/**
* Internal emitter events
* @enum
* @private
*/
const Events = {
MOUNT: 'mount',
SYMBOL_MOUNT: 'symbol_mount'
};
class BrowserSprite extends Sprite {
constructor(cfg = {}) {
super(merge(defaultConfig, cfg));
const emitter = mitt();
this._emitter = emitter;
this.node = null;
const { config } = this;
if (config.autoConfigure) {
this._autoConfigure(cfg);
}
if (config.syncUrlsWithBaseTag) {
const baseUrl = document.getElementsByTagName('base')[0].getAttribute('href');
emitter.on(Events.MOUNT, () => this.updateUrls('#', baseUrl));
}
const handleLocationChange = this._handleLocationChange.bind(this);
this._handleLocationChange = handleLocationChange;
// Provide way to update sprite urls externally via dispatching custom window event
if (config.listenLocationChangeEvent) {
window.addEventListener(config.locationChangeEvent, handleLocationChange);
}
// Emit location change event in Angular automatically
if (config.locationChangeAngularEmitter) {
locationChangeAngularEmitter(config.locationChangeEvent);
}
// After sprite mounted
emitter.on(Events.MOUNT, (spriteNode) => {
if (config.moveGradientsOutsideSymbol) {
moveGradientsOutsideSymbol(spriteNode);
}
});
// After symbol mounted into sprite
emitter.on(Events.SYMBOL_MOUNT, (symbolNode) => {
if (config.moveGradientsOutsideSymbol) {
moveGradientsOutsideSymbol(symbolNode.parentNode);
}
if (browser.isIE() || browser.isEdge()) {
evalStylesIEWorkaround(symbolNode);
}
});
}
/**
* @return {boolean}
*/
get isMounted() {
return !!this.node;
}
/**
* Automatically configure following options
* - `syncUrlsWithBaseTag`
* - `locationChangeAngularEmitter`
* - `moveGradientsOutsideSymbol`
* @param {Object} cfg
* @private
*/
_autoConfigure(cfg) {
const { config } = this;
if (typeof cfg.syncUrlsWithBaseTag === 'undefined') {
config.syncUrlsWithBaseTag = typeof document.getElementsByTagName('base')[0] !== 'undefined';
}
if (typeof cfg.locationChangeAngularEmitter === 'undefined') {
config.locationChangeAngularEmitter = typeof window.angular !== 'undefined';
}
if (typeof cfg.moveGradientsOutsideSymbol === 'undefined') {
config.moveGradientsOutsideSymbol = browser.isFirefox();
}
}
/**
* @param {Event} event
* @param {Object} event.detail
* @param {string} event.detail.oldUrl
* @param {string} event.detail.newUrl
* @private
*/
_handleLocationChange(event) {
const { oldUrl, newUrl } = event.detail;
this.updateUrls(oldUrl, newUrl);
}
/**
* Add new symbol. If symbol with the same id exists it will be replaced.
* If sprite already mounted - `symbol.mount(sprite.node)` will be called.
* @fires Events#SYMBOL_MOUNT
* @param {BrowserSpriteSymbol} symbol
* @return {boolean} `true` - symbol was added, `false` - replaced
*/
add(symbol) {
const sprite = this;
const isNewSymbol = super.add(symbol);
if (this.isMounted && isNewSymbol) {
symbol.mount(sprite.node);
this._emitter.emit(Events.SYMBOL_MOUNT, symbol.node);
}
return isNewSymbol;
}
/**
* Attach to existing DOM node
* @param {string|Element} target
* @return {Element|null} attached DOM Element. null if node to attach not found.
*/
attach(target) {
const sprite = this;
if (sprite.isMounted) {
return sprite.node;
}
/** @type Element */
const node = typeof target === 'string' ? document.querySelector(target) : target;
sprite.node = node;
// Already added symbols needs to be mounted
this.symbols.forEach((symbol) => {
symbol.mount(sprite.node);
this._emitter.emit(Events.SYMBOL_MOUNT, symbol.node);
});
// Create symbols from existing DOM nodes, add and mount them
arrayFrom(node.querySelectorAll('symbol'))
.forEach((symbolNode) => {
const symbol = BrowserSpriteSymbol.createFromExistingNode(symbolNode);
symbol.node = symbolNode; // hack to prevent symbol mounting to sprite when adding
sprite.add(symbol);
});
this._emitter.emit(Events.MOUNT, node);
return node;
}
destroy() {
const { config, symbols, _emitter } = this;
symbols.forEach(s => s.destroy());
_emitter.off('*');
window.removeEventListener(config.locationChangeEvent, this._handleLocationChange);
if (this.isMounted) {
this.unmount();
}
}
/**
* @fires Events#MOUNT
* @param {string|Element} [target]
* @param {boolean} [prepend=false]
* @return {Element|null} rendered sprite node. null if mount node not found.
*/
mount(target = this.config.mountTo, prepend = false) {
const sprite = this;
if (sprite.isMounted) {
return sprite.node;
}
const mountNode = typeof target === 'string' ? document.querySelector(target) : target;
const node = sprite.render();
this.node = node;
if (prepend && mountNode.childNodes[0]) {
mountNode.insertBefore(node, mountNode.childNodes[0]);
} else {
mountNode.appendChild(node);
}
this._emitter.emit(Events.MOUNT, node);
return node;
}
/**
* @return {Element}
*/
render() {
return parse(this.stringify());
}
/**
* Detach sprite from the DOM
*/
unmount() {
this.node.parentNode.removeChild(this.node);
}
/**
* Update URLs in sprite and usage elements
* @param {string} oldUrl
* @param {string} newUrl
* @return {boolean} `true` - URLs was updated, `false` - sprite is not mounted
*/
updateUrls(oldUrl, newUrl) {
if (!this.isMounted) {
return false;
}
const usages = document.querySelectorAll(this.config.usagesToUpdate);
updateUrls(
this.node,
usages,
`${getUrlWithoutFragment(oldUrl)}#`,
`${getUrlWithoutFragment(newUrl)}#`
);
return true;
}
}
const spriteNodeId = '__SVG_SPRITE_NODE__';
const spriteGlobalVarName = '__SVG_SPRITE__';
const loadSprite = () => {
/**
* Check for page already contains sprite node
* If found - attach to and reuse it's content
* If not - render and mount the new sprite
*/
const existing = document.getElementById(spriteNodeId);
if (existing) {
sprite.attach(existing);
} else {
sprite.mount(document.body, true);
}
};
/*!
* domready (c) Dustin Diaz 2014 - License MIT
*/
const createDomReady = () => {
var fns = [],
listener,
doc = document,
hack = doc.documentElement.doScroll,
domContentLoaded = 'DOMContentLoaded',
loaded = (hack ? /^loaded|^c/ : /^loaded|^i|^c/).test(doc.readyState);
if (!loaded)
doc.addEventListener(
domContentLoaded,
(listener = function () {
doc.removeEventListener(domContentLoaded, listener);
loaded = 1;
while ((listener = fns.shift())) listener();
})
);
return function (fn) {
loaded ? setTimeout(fn, 0) : fns.push(fn);
}
};
let sprite = new BrowserSprite({
attrs: {
id: spriteNodeId,
'aria-hidden': 'true'
},
autoConfigure: typeof document !== 'undefined',
listenLocationChangeEvent: typeof window !== 'undefined'
});
const init = () => {
if (typeof window === 'undefined' || typeof document === 'undefined') {
return
}
if (window[spriteGlobalVarName]) {
sprite = window[spriteGlobalVarName];
} else {
window[spriteGlobalVarName] = sprite;
}
if (document.body) {
loadSprite();
} else {
createDomReady()(loadSprite);
}
};
init();
export { BrowserSpriteSymbol as SpriteSymbol, sprite };