faded
faded
npm i faded
faded

faded

Standalone plugin for hinted lists.

by nelsoncash

0.1.1 (see all)License:MITTypeScript:Not Found
npm i faded
Readme

FADED

A standalone JavaScript plug-in for visually hinted lists. Yep, zero dependencies.

Demo

Have a look. ☁️ DEMO 🔦

Installation

Add ./dist/fog.min.js to your project.

Usage

Built with a UMD (Universal Module Definition) pattern.

Plain JavaScript

Insert script into your HTML.

<script type="text/javascript" src="./path/to/fog.min.js"></script>

Fog constructor is then attached to browser window global.

window.Fog("list_to_fog");

CommonJS

var Fog = require("./path/to/fog.min.js");

RequireJS

define('module/id/string', ["./path/to/fog.min.js"],
function(Fog){
  // Fog Usage
});

API

Fog(element[, opts])

element

Type: <String>|<HTMLElement>

Description: Reference to HTML DOM node

Restriction:

  • Only ONE HTMLElement node reference permitted
  • NO tree traversal (looks for element with all specified class's)

Ex:

// HTMLElement ID
Fog("#listID");

// HTMLElement class
Fog(".list_class_name.active");

// HTMLElement reference
var node = document.getElementById("listID");
Fog(node);

opts

Type: <Object>

Description: The selected element children style configuration

Ex:

var opts = {};
Fog("listID", opts);

opts.range

Type: <Number>

Default: 0.6

Ex:

var opts = {
  range: 0.6
};
Fog("listID", opts);

opts.style

Type: <AllStyle>

Default: {opacity: {min: 0.1, max: 1}}

Ex:

var opts = {
  color: {
    min: "rgba(12, 66, 144, 0.2)",
    max: "#FFF"
  }
};
Fog("listID", opts);

Type Definition

@typedef <Object> AllStyle
@prop <Style> 

@typedef <Object> Style
@property <Number|String> max
@property <Number|String> min

// Data Structure
{
  CSS_Property: {
    min: <Number|Color>,
    max: <Number|Color>
  }
}

AllStyle

Type: <Object>

Description: <AllStyle> is a collection <Style> definitions where each KEY represents a valid CSS property to modify on the <element>'s children.

Restriction:

  • KEY MUST reference a valid CSS style property
  • KEY REQUIRED as camelcase or hyphen separated words ('backgroundColor', 'border-color')

Ex:

var opts = {
  style: {
    color: {/*<Style>*/},
    backgroundColor: {/*<Style>*/},
    'border-radius': {/*<Style>*/}
  }
};

Style

Type: <Object>

Description: Configures the corresponding CSS property (KEY) to which it's assigned.

Restriction:

  • One or more declared properties
  • Single simple data type property - ONLY <Number|String>
  • (min,max) value should be selected CSS appropriate

Note: Use <String> to specify a color value. Accepts (hex, rgb, rgba).

Ex:

var opts = {
  style: {
    opacity: {
      min: 0.1,
    },
    color: {
      min: 'rgba(0,0,0,0.3)',
      max: 'black'
    },
    backgroundColor: {
      min: '#222',
      max: 'rgb(255,255,255)'
    }
  }
};

Style.min

Type: Number|String

Description: Edge styling for selected list.

Style.max

Type: <Number>|<String>

Description: Center styling for selected list

Contribution

Downloads/wk

4

GitHub Stars

16

LAST COMMIT

6yrs ago

MAINTAINERS

1

CONTRIBUTORS

3

OPEN ISSUES

2

OPEN PRs

0
VersionTagPublished
0.1.1
latest
7yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate