A JavaScript plugin that adds responsive, stylized speckles to any element; with no dependencies.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 62e937b Apr 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist/js Rebuilds all JS. Mar 2, 2018
docs Changes colophon links to dreamsicle.io Mar 17, 2018
src/js Adds destroy() and rerender() methods. Mar 2, 2018
.eslintrc Adds ESLint config. Feb 28, 2018
.gitignore Small change to .gitignore file. Apr 27, 2018
.npmignore Adds /docs and build files to .npmignore file. Feb 28, 2018
.sasslintrc Adds sassLint config. Feb 28, 2018
LICENSE Initial commit Feb 27, 2018
README.md Updates README.md Mar 4, 2018
gulpfile.js Creates pug build. Mar 3, 2018
package-lock.json 0.0.10 Apr 27, 2018
package.json 0.0.10 Apr 27, 2018

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.