Home

Latest Release Ember CLI version License Downloads

Dependencies Dev Dependencies

Build Status Code Climate

To see which issues are currently being worked on or are scheduled to be worked on next, visit https://huboard.com/softlayer/sl-ember-components/#/

Is currently in BETA

What sl-ember-components is

A UI components library compatible with Ember.js

Examples and documentation on how to use each component can be viewed at http://softlayer.github.io/sl-ember-components/ which is served from the gh-pages branch of this repository.

Components

  • sl-alert
  • sl-button
  • sl-calendar
  • sl-chart (only free for non-commercial use without a Highcharts license)
  • sl-checkbox
  • sl-date-picker
  • sl-date-range-picker
  • sl-date-time
  • sl-drop-button
  • sl-drop-option
  • sl-grid
  • sl-input
  • sl-loading-icon
  • sl-menu
  • sl-modal
  • sl-pagination
  • sl-panel
  • sl-progress-bar
  • sl-radio
  • sl-radio-group
  • sl-select
  • sl-span
  • sl-tab-pane
  • sl-tab-panel
  • sl-textarea
  • sl-tooltip

Mixins

sl-input-based

Provides state properties for input element based components.

sl-tooltip-enabled

Provides Bootstrap tooltip functionality bindings, for both popovers and plain tooltips.

Helpers

get-key

arguments: objectKey string, pathKey string, context object

Lookup a value on an object in the current context with passed-in objectKey and pathKey strings.

render-dynamic

Call the render handlebars helper with a key value for the template name lookup (render requires a string argument).

Utility Classes

sl-menu-key-adapter

Provides an abstraction between the events the sl-menu component listens for and the ability to associate any keyboard shortcuts in your application to trigger them.


All of this functionality is provided through a combination of leveraging the best-of-breed of other component offerings as well as our own implementations when the existing offerings were deficient. Existing offerings that were leveraged include:

LICENSE WARNING

While this library is MIT licensed not all of the third-party component libraries are. Specifically, Highcharts is only free for non-commercial use and requires a license for any other use. See this FAQ page for more information.

Other libraries that are not MIT licensed, though it should not pose a problem, are:

Supported browsers

See http://softlayer.github.io/sl-ember-components/browsers.html

Demo

Live

http://softlayer.github.io/sl-ember-components/#/demos

Development Environment

Installation

  • git clone this repository
  • npm install
  • bower install

Running

  • ember server
  • View the demo at http://localhost:4200

For more information on using ember-cli, visit http://www.ember-cli.com/.

Documentation

  • ember ember-cli-jsoc or npm run docs (shortcut setup in this repo)
  • Visit http://localhost:4200/docs

How to use this addon in your application

ember install sl-ember-components
npm install --save-dev ember-cli-less

Modify Brocfile.js file to add:

app.import({
    development : 'bower_components/bootstrap/dist/js/bootstrap.js',
    production  : 'bower_components/bootstrap/dist/js/bootstrap.min.js'
});

Create app/styles/app.less file. Then add to it:

@import 'sl-ember-components';

Examples and documentation on how to use each component

Examples and documentation on how to use each component can be viewed at http://softlayer.github.io/sl-ember-components

Versioning

Employs Semantic Versioning 2.0.0

Contribution

See CONTRIBUTING.md

Copyright and License

sl-ember-components and its source files are Copyright © 2014-2015 SoftLayer Technologies, Inc. The software is MIT Licensed

sl-ember-components leverages several third-party libraries which are not all MIT licensed. Specifically, Highcharts is only free for non-commercial use and requires a license for any other use. See this FAQ page for more information.

Other libraries that are not MIT licensed, though it should not pose a problem, are:

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.