Skip to content

README.md

Latest commit

 

History

History
43 lines (30 loc) · 1.21 KB

README.md

File metadata and controls

43 lines (30 loc) · 1.21 KB

Bits

Bits are basic, configurable web components, made with JavaScript. No external library dependencies.

Doesn't the web have enough of these?

Yes. The web has plenty of these. This is an exercise in simple, dependency-free, web component development. Modules are initialized on the DOM using a data-mod attribute, and can be passed an optional configuration object.

How do I intitialize a bit?

The data-mod attribute value needs to match the name of your constructor. The data-conf-[constructorname] passes a configuration object. The following snippet initializes a 'slideshow' module.

<section data-mod="slideshow" data-conf-slideshow="{'counter': true, 'navigation': true, 'animate': true}">
...
</section>

And the corresponding JavaScript constructor:

bit.slideshow = function (elem, config) {
...
}

How does it work?

The core.js scans the document, and locates all modules with the data-mod attribute. It then instantiates and renders each module, with it's (optional) configuration object.

Try it yourself

  1. npm install
  2. grunt
  3. navigate to http://localhost:9001

Completed modules:

  1. Slideshow
  2. Accordion
  3. Tabs
  4. Tooltips

In the pipe:

  1. Animation support for vendor-prefixes