Github地址： ShanaMaid/archer-svgs
哇哦!无限的svgs!你可以使用archer-svgs去异步加载svg并将它缓存在localStorage里，当你再次使用已经加载过的svg时将不需要再发起http请求。将svgs从你的js-bunlde里移除，并且永远减小js-bunlde的体积。（例子: 不需要因为1kb的svg更新而重新加载整个100kb的svg模块。）
如果你觉得这个项目还不错，可以给我一个star和follow来支持我
ps：archer命名取自fate里面archer的技能无限剑制
在线示例
安装
npm
npm install archer-svgsyarn
yarn add archer-svgs特性
- 使用
TypeScript进行, 提供d.ts文件提高开发效率。 - 异步加载
svg - 缓存
svg在localstorage或者disk-cache - 已经缓存
svg在再次使用的时候不用发起http请求 - 体积小
- 预加载
svg
设计思路
配置初始化
预加载
兼容性
archer-svgs 基于fetch和localStorage.针对fetch, 采用了 whatwg-fetch去做兼容!换句话说, 只要你的浏览器支持 xhr和localStorage，你就可以使用它!他们的兼容性如下图所示：
方法
init()
必须先调用 init()，然后才能使用其它的Archer方法!
import Archer from 'archer-svgs';Archer.init({svgs: {'ios-airplane': {url: 'https://unpkg.com/ionicons@4.4.2/dist/ionicons/svg/ios-airplane.svg',version: 1,},'md-airplane': {url: 'https://unpkg.com/ionicons@4.4.2/dist/ionicons/svg/md-airplane.svg',version: 1,cache: false,},}
})
config - paramas
export interface IConfig {svgs: ISVG;
}export interface ISVG {[index: string]: {version: number | string; // svg versionurl: string; // svg urlcache?: boolean; // default: true. false: not cache svg in localStorage }
}
startPrefetch()
startPrefetch会对config中的svg进行预加载!当你调用svg的时候将大大提高使用速度。
原因： - disk cache - localStorage cache
import Archer from 'archer-svgs';Archer.init(...);
Archer.startPrefetch();
downloadSvg()
params是config.svgs的key, 这个方法将返回svg的内容。
import Archer from 'archer-svgs';Archer.init({svgs: {'ios-airplane': {url: 'https://unpkg.com/ionicons@4.4.2/dist/ionicons/svg/ios-airplane.svg',version: 1,},}
})console.log(Archer.downloadSvg('ios-airplane'));
result:
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M407.7 224c-3.4 0-14.8.1-18 .3l-64.9 1.7c-.7 0-1.4-.3-1.7-.9L225.8 79.4c-2.9-4.6-8.1-7.4-13.5-7.4h-23.7c-5.6 0-7.5 5.6-5.5 10.8l50.1 142.8c.5 1.3-.4 2.7-1.8 2.7L109 230.1c-2.6.1-5-1.1-6.6-3.1l-37-45c-3-3.9-7.7-6.1-12.6-6.1H36c-2.8 0-4.7 2.7-3.8 5.3l19.9 68.7c1.5 3.8 1.5 8.1 0 11.9l-19.9 68.7c-.9 2.6 1 5.3 3.8 5.3h16.7c4.9 0 9.6-2.3 12.6-6.1L103 284c1.6-2 4.1-3.2 6.6-3.1l121.7 2.7c1.4.1 2.3 1.4 1.8 2.7L183 429.2c-2 5.2-.1 10.8 5.5 10.8h23.7c5.5 0 10.6-2.8 13.5-7.4L323.1 287c.4-.6 1-.9 1.7-.9l64.9 1.7c3.3.2 14.6.3 18 .3 44.3 0 72.3-14.3 72.3-32S452.1 224 407.7 224z"/></svg>
clearSvgCache()
清理掉localStorage中svg的缓存。
import Archer from 'archer-svgs';Archer.clearCache();
setMaxSize()
设置localStorage中svg的缓存最大值，单位是kb。
import Archer from 'archer-svgs';Archer.setMaxSize(1024); // 1024kb
setMax()
设置localStorage中svg的缓存数量。
import Archer from 'archer-svgs';Archer.setMax(10); // 你可以在loaclStorage中缓存10个svg
fetchSvg()
通过url加载svg。
import Archer from 'archer-svgs';const svg = Archer.fetchSvg('https://unpkg.com/ionicons@4.4.2/dist/ionicons/svg/ios-airplane.svg')console.log(svg);
result:
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M407.7 224c-3.4 0-14.8.1-18 .3l-64.9 1.7c-.7 0-1.4-.3-1.7-.9L225.8 79.4c-2.9-4.6-8.1-7.4-13.5-7.4h-23.7c-5.6 0-7.5 5.6-5.5 10.8l50.1 142.8c.5 1.3-.4 2.7-1.8 2.7L109 230.1c-2.6.1-5-1.1-6.6-3.1l-37-45c-3-3.9-7.7-6.1-12.6-6.1H36c-2.8 0-4.7 2.7-3.8 5.3l19.9 68.7c1.5 3.8 1.5 8.1 0 11.9l-19.9 68.7c-.9 2.6 1 5.3 3.8 5.3h16.7c4.9 0 9.6-2.3 12.6-6.1L103 284c1.6-2 4.1-3.2 6.6-3.1l121.7 2.7c1.4.1 2.3 1.4 1.8 2.7L183 429.2c-2 5.2-.1 10.8 5.5 10.8h23.7c5.5 0 10.6-2.8 13.5-7.4L323.1 287c.4-.6 1-.9 1.7-.9l64.9 1.7c3.3.2 14.6.3 18 .3 44.3 0 72.3-14.3 72.3-32S452.1 224 407.7 224z"/></svg>
更多相关内容请访问
ShanaMaid/archer-svgsgithub.com
