svg-sprite-loader
Version:
SVG sprite loader for Webpack
810 lines (670 loc) • 21.7 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' && define.amd ? define(factory) :
(global.BrowserSprite = factory());
}(this, (function () { 'use strict';
var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
function createCommonjsModule(fn, module) {
return module = { exports: {} }, fn(module, module.exports), module.exports;
}
var index = createCommonjsModule(function (module, exports) {
(function (root, factory) {
if (typeof undefined === 'function' && undefined.amd) {
undefined(factory);
} else {
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
}));
});
//
// 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 = createCommonjsModule(function (module, exports) {
var 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;
});
/**
* @param {Object} attrs
* @return {string}
*/
var objectToAttrsString = function (attrs) {
return Object.keys(attrs).map(function (attr) {
var value = attrs[attr].toString().replace(/"/g, '"');
return (attr + "=\"" + value + "\"");
}).join(' ');
};
var svg = namespaces_1.svg;
var xlink = namespaces_1.xlink;
var defaultAttrs = {};
defaultAttrs[svg.name] = svg.uri;
defaultAttrs[xlink.name] = xlink.uri;
/**
* @param {string} [content]
* @param {Object} [attributes]
* @return {string}
*/
var wrapInSvgString = function (content, attributes) {
if ( content === void 0 ) content = '';
var attrs = index(defaultAttrs, attributes || {});
var attrsRendered = objectToAttrsString(attrs);
return ("<svg " + attrsRendered + ">" + content + "</svg>");
};
var svg$1 = namespaces_1.svg;
var xlink$1 = namespaces_1.xlink;
var defaultConfig = {
attrs: ( obj = {
style: ['position: absolute', 'width: 0', 'height: 0'].join('; ')
}, obj[svg$1.name] = svg$1.uri, obj[xlink$1.name] = xlink$1.uri, obj )
};
var obj;
var Sprite = function Sprite(config) {
this.config = index(defaultConfig, 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
*/
Sprite.prototype.add = function add (symbol) {
var ref = this;
var symbols = ref.symbols;
var 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
*/
Sprite.prototype.remove = function remove (id) {
var ref = this;
var symbols = ref.symbols;
var symbol = this.find(id);
if (symbol) {
symbols.splice(symbols.indexOf(symbol), 1);
symbol.destroy();
return true;
}
return false;
};
/**
* @param {string} id
* @return {SpriteSymbol|null}
*/
Sprite.prototype.find = function find (id) {
return this.symbols.filter(function (s) { return s.id === id; })[0] || null;
};
/**
* @param {string} id
* @return {boolean}
*/
Sprite.prototype.has = function has (id) {
return this.find(id) !== null;
};
/**
* @return {string}
*/
Sprite.prototype.stringify = function stringify () {
var ref = this.config;
var attrs = ref.attrs;
var stringifiedSymbols = this.symbols.map(function (s) { return s.stringify(); }).join('');
return wrapInSvgString(stringifiedSymbols, attrs);
};
/**
* @return {string}
*/
Sprite.prototype.toString = function toString () {
return this.stringify();
};
Sprite.prototype.destroy = function destroy () {
this.symbols.forEach(function (s) { return s.destroy(); });
};
var defaultConfig$1 = {
/**
* 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
};
var arrayFrom = function (arrayLike) {
return Array.prototype.slice.call(arrayLike, 0);
};
var ua = navigator.userAgent;
var browser = {
isChrome: /chrome/i.test(ua),
isFirefox: /firefox/i.test(ua),
isIE: /msie/i.test(ua),
isEdge: /edge/i.test(ua)
};
/**
* @param {string} name
* @param {*} data
*/
var dispatchEvent = function (name, data) {
var event = document.createEvent('CustomEvent');
event.initCustomEvent(name, false, false, data);
window.dispatchEvent(event);
};
/**
* @param {string} [url] If not provided - current URL will be used
* @return {string}
*/
var getUrlWithoutFragment = function (url) {
return (url || window.location.href).split('#')[0];
};
/* global angular */
/**
* @param {string} eventName
*/
var locationChangeAngularEmitter = function (eventName) {
angular.module('ng').run(['$rootScope', function ($rootScope) {
$rootScope.$on('$locationChangeSuccess', function (e, newUrl, oldUrl) {
dispatchEvent(eventName, { oldUrl: oldUrl, newUrl: newUrl });
});
}]);
};
var defaultSelector = 'linearGradient, radialGradient, pattern';
/**
* @param {Element} svg
* @param {string} [selector]
* @return {Element}
*/
var moveGradientsOutsideSymbol = function (svg, selector) {
if ( selector === void 0 ) selector = defaultSelector;
arrayFrom(svg.querySelectorAll('symbol')).forEach(function (symbol) {
arrayFrom(symbol.querySelectorAll(selector)).forEach(function (node) {
symbol.parentNode.insertBefore(node, symbol);
});
});
return svg;
};
/**
* @param {string} content
* @return {Element}
*/
var parse = function (content) {
var hasImportNode = !!document.importNode;
var 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;
};
/**
* @param {NodeList} nodes
* @param {Function} [matcher]
* @return {Attr[]}
*/
function selectAttributes(nodes, matcher) {
var attrs = arrayFrom(nodes).reduce(function (acc, node) {
if (!node.attributes) {
return acc;
}
var arrayfied = arrayFrom(node.attributes);
var matched = matcher ? arrayfied.filter(matcher) : arrayfied;
return acc.concat(matched);
}, []);
return attrs;
}
/**
* @param {NodeList|Node} nodes
* @param {boolean} [clone=true]
* @return {string}
*/
var xLinkNS = namespaces_1.xlink.uri;
var xLinkAttrName = 'xlink:href';
// eslint-disable-next-line no-useless-escape
var specialUrlCharsPattern = /[(){}|\\\^~\[\]`"<>]/g;
function encoder(url) {
return url.replace(specialUrlCharsPattern, function (match) {
return ("%" + (match[0].charCodeAt(0).toString(16).toUpperCase()));
});
}
/**
* @param {NodeList} nodes
* @param {string} startsWith
* @param {string} replaceWith
* @return {NodeList}
*/
function updateReferences(nodes, startsWith, replaceWith) {
arrayFrom(nodes).forEach(function (node) {
var href = node.getAttribute(xLinkAttrName);
if (href && href.indexOf(startsWith) === 0) {
var newUrl = href.replace(startsWith, replaceWith);
node.setAttributeNS(xLinkNS, xLinkAttrName, newUrl);
}
});
return nodes;
}
/**
* List of SVG attributes to update url() target in them
*/
var attList = [
'clipPath',
'colorProfile',
'src',
'cursor',
'fill',
'filter',
'marker',
'markerStart',
'markerMid',
'markerEnd',
'mask',
'stroke',
'style'
];
var attSelector = attList.map(function (attr) { return ("[" + 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#');
*/
var updateUrls = function (svg, references, startsWith, replaceWith) {
var startsWithEncoded = encoder(startsWith);
var replaceWithEncoded = encoder(replaceWith);
var nodes = svg.querySelectorAll(attSelector);
var attrs = selectAttributes(nodes, function (ref) {
var localName = ref.localName;
var value = ref.value;
return attList.indexOf(localName) !== -1 && value.indexOf(("url(" + startsWithEncoded)) !== -1;
});
attrs.forEach(function (attr) { return attr.value = attr.value.replace(startsWithEncoded, replaceWithEncoded); });
updateReferences(references, startsWithEncoded, replaceWithEncoded);
};
/**
* Internal emitter events
* @enum
* @private
*/
var Events = {
MOUNT: 'mount'
};
var BrowserSprite = (function (Sprite$$1) {
function BrowserSprite(cfg) {
var this$1 = this;
if ( cfg === void 0 ) cfg = {};
Sprite$$1.call(this, index(defaultConfig$1, cfg));
var emitter = mitt();
this._emitter = emitter;
this.node = null;
var ref = this;
var config = ref.config;
if (config.autoConfigure) {
this._autoConfigure(cfg);
}
if (config.syncUrlsWithBaseTag) {
var baseUrl = document.getElementsByTagName('base')[0].getAttribute('href');
emitter.on(Events.MOUNT, function () { return this$1.updateUrls('#', baseUrl); });
}
var 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);
}
if (config.moveGradientsOutsideSymbol) {
emitter.on(Events.MOUNT, function (node) {
moveGradientsOutsideSymbol(node);
});
}
}
if ( Sprite$$1 ) BrowserSprite.__proto__ = Sprite$$1;
BrowserSprite.prototype = Object.create( Sprite$$1 && Sprite$$1.prototype );
BrowserSprite.prototype.constructor = BrowserSprite;
var prototypeAccessors = { isMounted: {} };
/**
* @return {boolean}
*/
prototypeAccessors.isMounted.get = function () {
return !!this.node;
};
/**
* Automatically configure following options
* - `syncUrlsWithBaseTag`
* - `locationChangeAngularEmitter`
* - `moveGradientsOutsideSymbol`
* @param {Object} cfg
* @private
*/
BrowserSprite.prototype._autoConfigure = function _autoConfigure (cfg) {
var ref = this;
var config = ref.config;
if (typeof cfg.syncUrlsWithBaseTag === 'undefined') {
config.syncUrlsWithBaseTag = typeof document.getElementsByTagName('base')[0] !== 'undefined';
}
if (typeof cfg.locationChangeAngularEmitter === 'undefined') {
config.locationChangeAngularEmitter = 'angular' in window;
}
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
*/
BrowserSprite.prototype._handleLocationChange = function _handleLocationChange (event) {
var ref = event.detail;
var oldUrl = ref.oldUrl;
var newUrl = ref.newUrl;
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.
* @param {BrowserSpriteSymbol} symbol
* @return {boolean} `true` - symbol was added, `false` - replaced
*/
BrowserSprite.prototype.add = function add (symbol) {
var isNewSymbol = Sprite$$1.prototype.add.call(this, symbol);
if (this.isMounted && isNewSymbol) {
symbol.mount(this.node);
}
return isNewSymbol;
};
BrowserSprite.prototype.destroy = function destroy () {
var ref = this;
var config = ref.config;
var symbols = ref.symbols;
var _emitter = ref._emitter;
symbols.forEach(function (s) { return s.destroy(); });
_emitter.off('*');
window.removeEventListener(config.locationChangeEvent, this._handleLocationChange);
if (this.isMounted) {
this.unmount();
}
};
/**
* @param {Element|string} [target]
* @param {boolean} [prepend=false]
* @return {Element} rendered sprite node
* @fires Events#MOUNT
*/
BrowserSprite.prototype.mount = function mount (target, prepend) {
if ( prepend === void 0 ) prepend = false;
if (this.isMounted) {
return this.node;
}
var mountTarget = target || this.config.mountTo;
var parent = typeof mountTarget === 'string' ? document.querySelector(mountTarget) : mountTarget;
var node = this.render();
if (prepend && parent.childNodes[0]) {
parent.insertBefore(node, parent.childNodes[0]);
} else {
parent.appendChild(node);
}
this.node = node;
this._emitter.emit(Events.MOUNT, node);
return node;
};
/**
* @return {Element}
*/
BrowserSprite.prototype.render = function render () {
return parse(this.stringify());
};
/**
* Detach sprite from the DOM
*/
BrowserSprite.prototype.unmount = function 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
*/
BrowserSprite.prototype.updateUrls = function updateUrls$1 (oldUrl, newUrl) {
if (!this.isMounted) {
return false;
}
var usages = document.querySelectorAll(this.config.usagesToUpdate);
updateUrls(
this.node,
usages,
((getUrlWithoutFragment(oldUrl)) + "#"),
((getUrlWithoutFragment(newUrl)) + "#")
);
return true;
};
Object.defineProperties( BrowserSprite.prototype, prototypeAccessors );
return BrowserSprite;
}(Sprite));
var ready$1 = createCommonjsModule(function (module) {
/*!
* domready (c) Dustin Diaz 2014 - License MIT
*/
!function (name, definition) {
{ module.exports = definition(); }
}('domready', function () {
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);
}
});
});
var sprite = new BrowserSprite();
var loadSprite = function () {
var svg = sprite.mount(document.body, true);
// :WORKAROUND:
// 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.
//
// Reference: https://github.com/iconic/SVGInjector/issues/23
var ua = window.navigator.userAgent || '';
if (ua.indexOf('Trident') > 0 || ua.indexOf('Edge/') > 0) {
var styles = svg.querySelectorAll('style');
for (var i = 0, l = styles.length; i < l; i += 1) {
styles[i].textContent += '';
}
}
};
if (document.body) {
loadSprite();
} else {
ready$1(loadSprite);
}
return sprite;
})));