Build “encapsulated” UI components mimicking web components (custom elements), such as dropdowns, popups, tooltips, etc.
JavaScript CSS

README.md

Shadow UI v0.6.0 Shadow UI build status

Build “encapsulated” UI components mimicking web components (custom elements), such as dropdowns, popups, tooltips, etc.

This project is in active development. The api is bound to be tweaked before v1 is ready.

Get started:

  • Download the package, or
  • git clone https://github.com/amsul/shadow-ui.git, or
  • bower install shadow-ui

Dependencies:

  • jQuery >=1.7

Browser support:

Aim for v1.0 is to support the following browsers:

  • IE 8+
  • Chrome
  • Safari
  • Firefox
  • Opera
  • Blackberry 6.0+
  • Android 3.2+
  • All other modern browsers


Building

Grunt ^0.4.4 is used to build the project files. To get started, clone the project and then run:

  • npm install to get the required node modules.
  • grunt strict --verbose to confirm you have all the dependencies.

Read the Gruntfile to see the build tasks and relative directories of the source files.


Versioning

In order to make it easy to understand the type of changes expected with each version bump, semantic versioning guidelines will be followed as closely as possible:

<major>.<minor>.<patch>

Where:

  • major: breaks backward compatibility (resets the minor and patch)
  • minor: new additions with backward compatibility (resets the patch)
  • patch: bug fixes and misc changes


© 2014 Amsul

Licensed under MIT