Code Monkey home page Code Monkey logo

component's Introduction

Base visual component implementation

build status npm version dependencies status devDependencies status Gitter

Each component is an instance of Emitter module.

Installation

npm install spa-component

Usage

Add the singleton to the scope:

var Component = require('spa-component');

Create instance with custom config:

var component = new Component({
    $node: document.getElementById(id),
    className: 'bootstrap responsive',
    events: {
        click: function () { 
            // some you`r actions 
        }
    }
});
component.add( 
    new Button(), // The instance of Component
    new Button()  // [Button class](https://github.com/spasdk/component-button)
);
component.focus();

Constructor config

Name Type Default value Description
id Element cid(0-n) component unique identifier (generated if not set)
className String name space-separated list of classes for "className" property of this.$node
$node Element null DOM element/fragment to be a component outer container
$body Element null DOM element/fragment to be a component inner container (by default is the same as $node)
parent Component null link to the parent component which has this component as a child
children Array. [] list of components in this component
events Object.<string, function> {} list of event callbacks
visible Boolean true component initial visibility state flag
focusable Boolean true component can accept focus or not
propagate Boolean false allow to emit events to the parent component

Development mode

There is a global var DEVELOP which activates additional consistency checks and protection logic not available in release mode.

Contribution

If you have any problem or suggestion please open an issue here. Pull requests are welcomed with respect to the JavaScript Code Style.

License

spa-component is released under the MIT License.

component's People

Contributors

darkpark avatar rfbkak37y3kiy avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.