API

Full API documentation.

ch.Component

Description

Base class for all components.

How-to

// Create a new Component.
var component = new ch.Component();
var component = new ch.Component('.my-component', {'option': 'value'});
var component = new ch.Component('.my-component');
var component = new ch.Component({'option': 'value'});

Parameters

  • el - HTMLElement : It must be a HTMLElement.
  • options - Object : Configuration options.

Extends

  • tiny.EventEmitter

Properties

.Component#name String

The name of a component.

.uid Number

A unique id to identify the instance of a component.

Methods

.constructor()



    

Returns a reference to the constructor function.

.destroy()



    

Destroys an instance of Component and remove its data from asociated element.

// Destroy a component
component.destroy();
// Empty the component reference
component = undefined;

.disable() → {component}



    

Disables an instance of Component.

// Disabling an instance of Component.
component.disable();

.enable() → {component}



    

Enables an instance of Component.

// Enabling an instance of Component.
component.enable();

.require() → {component}



    

Adds functionality or abilities from other classes.

// You can require some abilitiest to use in your component.
// For example you should require the collpasible abitliy.
var component = new Component(element, options);
component.require('Collapsible');

Events

'destroy'



    

Emits when a component is destroyed.

// Subscribe to "destroy" event.
component.on('destroy', function () {
    // Some code here!
});

'disable'



    

Emits when a component is disable.

// Subscribe to "disable" event.
component.on('disable', function () {
    // Some code here!
});

'enable'



    

Emits when a component is enabled.

// Subscribe to "enable" event.
component.on('enable', function () {
    // Some code here!
});

'ready'



    

Event emitted when the component is ready to use.

// Subscribe to "ready" event.
component.on('ready', function () {
    // Some code here!
});