Skip to content
develop
Switch branches/tags
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Speckle

A JavaScript module that adds responsive, stylized speckles to any element; with no dependencies.

Getting Started

Installation

npm install speckle-js

Usage

Import the module.

// Import the module using ES6.
import Speckle from 'speckle-js';

// Import the module using CommonJS.
const Speckle = require('speckle-js');

Use the constructor by passing a valid HTML element as the first argument, and an options object of key: value pairs as the second argument.

new Speckle(element, options);

Documentation

Visit the documentation and examples for all options, methods, and how to use them.