aurelia-semantic-ui

This plugin is for the Aurelia platform. It contains custom attributes for some of the Semantic UI widgets.

It isn't really even alpha quality right now, as I'm still figuring out how half of this stuff works, so don't depend on anything quite yet.

The major "to do" list:

TESTING. I have done very little, as I wasn't even sure this would be useful or implemented in a way that made sense. Now that I've used it in anger, though, I need get tests implemented ASAP.
Documentation via the demo app seems to be working well, but I've spent more time on layout and organization than content so far, so I need to catch up with the code so I can keep them in parity.
Finish making custom attributes for the rest of the Semantic widgets.
Figure out conventions for hooking up the Modules and Behaviors further into Aurelia. I haven't really used them enough to have a feel for what they might look like aside from calling $( this.element ).dropdown(); from attached() or whatever.

Installing

Again, this isn't production-ready yet, but once it is, this is how you'll install it.

In your Aurelia project install the plugin via jspm with following command

jspm install npm:aurelia-semantic-ui

Make sure you use manual bootstrapping. In order to do so open your index.html and locate the element with the attribute aurelia-app. Change it to look like this:

<body aurelia-app="main">

Create (if you haven't already) a file main.js in your src folder as described in the Boostrapping Aurelia section of the Aurelia documentation. Add this before you call aurelia.start() to install the plugin in your app:

aurelia.use.plugin( 'aurelia-semantic-ui' );

If you wish to test to see if the plugin is being installed correctly, you can add the following markup as a sample:

<div ui-card class="centered">
  <div class="image">
    <img src="/images/avatar2/large/elyse.png">
  </div>
  <div class="content">
    <a class="header">Elyse</a>
  </div>
</div>

Thanks

Many thanks to the aurelia-bs-modal plugin by Patrick Walters upon which this plugin is based. Used under the terms of The MIT License (MIT):

Copyright (c) 2014 Durandal Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

gitter-badger / aurelia-semantic-ui Goto Github PK