Skip to content

hotoo/echo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

echo


spm version Build Status

Echo for web ui.


INSTALL

$ spm install echo

USAGE

var Echo = require('echo');

var echo = new Echo("#echo-container > .echo-item", {
  min: 1,
  max: 5
});

$("#btn-echo").click(function(){
  echo.echo();
});

API

new Echo(elements, options)

constructor.

params:

  • elements, [required], support following types.
    • {String} selector.
    • {HTMLElement} element.
    • {jQuery} jQuery element.
  • options, [optional]
    • min: {Number}, default: 0.
    • max: {Number}, default: Number.MAX_VALUE.
    • template: support following types.
      • {String}: template string, or selector.
      • {Function} return template string or selector.

.echo()

Append an echo element item at the end.

.echoAt(index)

Add or insert an echo element item at index.

.echoBefore(item)

Insert an echo element item before item.

.echoAfter(item)

Append an echo element item after item.

.remove(item)

Remove an echo element item.

.removeAt(index)

Remove an echo element at index.

.move(item, rel_index)

eg.

echo.move(item, 1); // move item down 1 row.
echo.move(item, -1); // move item up 1 row.

.moveTo(item, abs_index)

eg.

echo.moveTo(item, 1); // move item to row index 1.
echo.moveTo(item, -1); // move item to the bottom row.

.clear()

Clear all of echo elements.

.render()

Render Echo.

.on(eventName, handler)

Add event listener.

.off(eventName, handler)

Remove event listener.

EVENTS

min

When echo elements length less than or equal the min length, fire min event.

unmin

When before echo a new elements, echo elements length equal the min length, after echo new elements finished, fire unmin event.

max

When echo elements length great than or equal the min length, fire max event.

unmax

When before remove a echo elements, echo elements length equal the max length, after remove echo element item finished, fire unmax event.

echo

When echo a copy element, fire echo event.

remove

When remove an echo element, fire remove event.

move

When top echo item moved, fire move event.

top

When echo item changed to the top, fire top event.

untop

When top echo item changed from top to other position, fire untop event.

bottom

When echo item changed to bottom, fire bottom event.

unbottom

When echo item changed from bottom to other position, fire unbottom event.