svg-loader-es6

SVG Loader Vanilla ES6


Keywords
svg, loader, es6, vanilla, js, vanilla js, vanilla es6, svg animation, es6-classes, es6-javascript, npm, npm-package, svg-animated-icons, svg-animations, svg-loader, vanilla-es6, vanilla-javascript, vanilla-js
License
GPL-3.0
Install
npm install svg-loader-es6@1.1.1

Documentation

SVG Loader ES6 GitHub license

A class to create customizable SVG loader with Vanilla ES6.

NPM
GitHub package version npm Npm downloads
Build Status
Sonar quality gate
Code Climate
Greenkeeper badge
Dependencies Status
DevDependencies Status
Maintenance
GitHub last commit
CodeClimate issues
Open issues
Complexity
Cognitive Complexity
Bugs
Code smells

Installation

# Yarn
yarn add --exact svg-loader-es6

# NPM
npm install --save --save-exact svg-loader-es6

Usage

Somewhere in your document:

<div id="your-container-id" />

Then in your javascript :

  • Import:
import { SVGLoader } from 'svg-loader-es6';
  • Instantiate:
new SVGLoader( {
  containerId: 'your-container-id'
} )

Settings

The constructor can accept more keys in the object as parameters.

Option Type Default Description
containerId String "loader-container" Required - The id of the element that will contain the SVG element
svgId String "loader" The id given to the created SVG element
nbRects int 3 Number of rectangle shapes in the SVG
margin int 2 Margin between the shapes (in px)
fill String (Hex, RGB, RGBA) "#000000" Color of the shapes in the SVG
size int 15 Height and width of each shape (rectangle) of the SVG (in px)
radius int 2 Value of the border radius of each rectangle shape of the SVG (in px)
minOpacity Number 0.25 Opacity to give to each shapes at the begin of the animation
maxOpacity Number 0.75 Opacity to give to each shapes at the end of the animation
duration int 1000 Duration of the animation of each shape from minOpacity to maxOpacity (in ms)

Properties of an instance

Property Type Description
settings Object The current options of the SVGLoader instance (read-only)
defaultOptions Object The default options for settings if there's no settings given to the constructor. This is a static method, so call it as follows: SVGLoader.defaultProperties

Methods

Property Parameters Default Description
toggle - - Hide or show the SVG Element
show - - Show the SVG Element
hide - - Hide the SVG Element
destroy - - Remove the SVG element from DOM and delete all properties or listeners

Demo

A complete demo is available here

Live Demo Examples

The source code of the demo is here

Use the settings generator here

Settings generator gif

Contributing

JavaScript Style Guide

The dashboard with CI and code quality indicators