Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
251 commits
Select commit Hold shift + click to select a range
0b76bfd
Merge branch 'master' of github.com:moovweb/uranium
kwliou Apr 5, 2012
f67ee15
Merge pull request #62 from kwliou/master
Apr 5, 2012
7cdd1f5
update config
Apr 5, 2012
1e1380e
Merge branch 'master' of github.com:moovweb/uranium
Apr 5, 2012
0ab7593
Broken links and re-centralising the top menu bar
malrase Apr 9, 2012
9537f8a
update the uranium version to the 85 from 46. which didn't support ma…
letrest Apr 23, 2012
2ad091e
Merge pull request #69 from letrest/master
Apr 23, 2012
cefa1ca
Download page styling
malrase Apr 25, 2012
ca73aed
Merge branch 'master' of github.com:moovweb/uranium
malrase Apr 25, 2012
fff33ee
fix carousel bug, add fill feature
kwliou Apr 26, 2012
502db18
Merge pull request #71 from kwliou/master
Apr 26, 2012
de95159
add reset to original font size to font resizer widget
Apr 27, 2012
125fe11
fix another click bug
kwliou Apr 27, 2012
c2261fe
update font resizer example with font size reset, change font resizer…
Apr 27, 2012
4c01e04
add beta fill, center features
kwliou Apr 27, 2012
cc21f43
Merge branch 'master' of github.com:moovweb/uranium
kwliou Apr 27, 2012
42bb139
update generated files
kwliou Apr 27, 2012
2f583a0
minor doc update
kwliou Apr 27, 2012
3b6e84c
Merge pull request #72 from honielui/master
Apr 27, 2012
bafe43f
Merge branch 'master' of github.com:moovweb/uranium
kwliou Apr 27, 2012
eec5eca
Merge pull request #74 from kwliou/master
Apr 27, 2012
cce9cb0
remove data-ur-maps
kwliou Apr 30, 2012
1b24fd6
remove map event handler
kwliou Apr 30, 2012
b2a66b0
Merge branch 'master' of github.com:moovweb/uranium
kwliou May 7, 2012
944be9c
tweak translate speed
kwliou May 7, 2012
3c5e5d9
forgot to remove statement
kwliou May 7, 2012
93b663b
Merge pull request #77 from kwliou/master
May 7, 2012
a363dd2
tweak tabs scroll
kwliou May 14, 2012
9c4d9f1
carousel cleanup
kwliou May 14, 2012
7426354
fix carousel double click
kwliou May 16, 2012
bb3c0f7
fix clone attribute bug
kwliou May 16, 2012
7e1fa1a
add beta zoom widget
kwliou May 16, 2012
d1c1ac7
fix zoom widget
kwliou May 16, 2012
2c0b8d6
error check carousel
kwliou May 16, 2012
fe8344d
add jasmine with syn unit tests
kwliou Jun 4, 2012
ff5bf0a
add another test
kwliou Jun 5, 2012
6b0f9c9
add another test
kwliou Jun 5, 2012
5df14a8
restructure carousel code
kwliou Jun 5, 2012
0b42187
add zoom widget documentation
kwliou Jun 8, 2012
b20e3b9
fix case when carousel is hidden while scrolling
kwliou Jun 9, 2012
0e69e2b
structure template site
kwliou Jun 20, 2012
b1b977c
small fix for zoom widget
kwliou Jun 21, 2012
c8f5b0a
style site
kwliou Jun 27, 2012
82ce97a
Merge branch 'master' of github.com:moovweb/uranium
kwliou Jun 27, 2012
65df1a0
fix small issue
kwliou Jun 27, 2012
2415b85
beta custom uranium
kwliou Jul 2, 2012
7fb380c
try to get uranium to build
kwliou Jul 17, 2012
a183370
Merge branch 'master' of github.com:moovweb/uranium
kwliou Jul 17, 2012
b0bd92b
speed up carousel on android
kwliou Jul 17, 2012
ae327e4
update carousel speed
kwliou Jul 17, 2012
5b974dc
fix typo
kwliou Jul 17, 2012
75f48fe
update carousel speed
kwliou Jul 17, 2012
6562da0
carousel speed only for android
kwliou Jul 17, 2012
c8419ea
fix geocode for ios5
Aug 9, 2012
b3862cc
changed the part where the hasAttribute method was being used. It was…
Aug 30, 2012
178e780
Merge pull request #81 from cagria/master
Aug 30, 2012
eedcaa6
fix carousel for ios 6
Sep 26, 2012
75d5b0f
fix carousel for ios 6
Sep 26, 2012
b238c31
minor site update
Oct 23, 2012
f17b069
fix carousel button
Oct 25, 2012
3d94df6
allow same zoom image
Nov 2, 2012
543bf77
minor cleanup
Nov 3, 2012
24684b4
tweak carousel code
Nov 7, 2012
087e3d4
fix button again
Nov 7, 2012
496b391
Update examples/site/widgets/carousel.html
Nov 7, 2012
d9f22ea
fix carousel bug
Nov 16, 2012
707ff9d
Update lib/geolocation.js
benbayard Jan 24, 2013
05a28fc
Merge pull request #84 from benbayard/master
Jan 24, 2013
618331d
quick dots fix
Feb 15, 2013
c6b4f5f
ignore remote downloads
Mar 11, 2013
0884938
include an external js build
Mar 11, 2013
b87f88b
create an example page to work off of
Mar 11, 2013
f2e751c
add in a toggler example widget
Mar 12, 2013
c1acc88
begin building out the jquery version
Mar 12, 2013
fe83c64
add in more examples to prove widgets are working
Mar 25, 2013
dbc66dc
add in the test css for the html page
Mar 25, 2013
1f1b763
another example
Mar 25, 2013
09393ff
toggler
Mar 25, 2013
b471828
add in some cleanup css
Mar 25, 2013
062384b
a bit more css
Mar 25, 2013
b993aed
general items
Apr 16, 2013
b78bc68
add a read me
Apr 16, 2013
daa0361
input clear
Apr 16, 2013
f5d89ae
update read me
Apr 16, 2013
af7b10d
input clear css
Apr 16, 2013
fb4061d
carousel hotfix
Apr 17, 2013
1002875
get the geolocation widget working
Apr 17, 2013
6f5d12a
Merge branch 'master' into jquery
Apr 17, 2013
0ccf967
add in the zoom widget
Apr 18, 2013
7ce885d
update readme
Apr 18, 2013
103ba52
get the zoom properly working with the button
Apr 18, 2013
53a91ad
begin carousel widget
May 29, 2013
77e5e1c
carousel items for testing
May 29, 2013
6f13fc4
basic jquerification of carousel - still need to debug some stuff
wonja May 31, 2013
d987016
xii fixes (mostly pushing for jessica)
wonja May 31, 2013
a181baa
and again (sorry)
wonja May 31, 2013
021093a
change .fire() to .trigger()
wonja Jun 1, 2013
142c246
got infinite scrolling working correctly kinda
wonja Jun 1, 2013
3796a10
carousel styling and autoscroll
wonja Jun 3, 2013
8e20f1d
carousel - tested: vertical scroll, autoscroll, autoscroll-delay, aut…
wonja Jun 3, 2013
7de0cf9
just getting rid of debugging logs
wonja Jun 3, 2013
748cc32
edge case where swipe distance at the beginning or end of the carouse…
wonja Jun 5, 2013
4d93507
fixed clone prepending and finite scrolling bugs. still some infinite…
wonja Jun 6, 2013
b740621
infinite scrolling tentatively working and tested with data-ur-center…
wonja Jun 7, 2013
ea51373
made infinite scrolling a little smoother when there's only one clone…
wonja Jun 7, 2013
8df6987
some cosmetic fixes
wonja Jun 7, 2013
71c2ea6
fixed autoscroll with data-ur-fill
wonja Jun 8, 2013
65fdc08
setting it back to a plain carousel on the migration index page
wonja Jun 8, 2013
515cb6e
updated migration README for carousel wish list features
wonja Jun 10, 2013
5d035f6
working version before i try to fix the carousel item width loading i…
wonja Jun 13, 2013
5463255
Merge pull request #87 from wonja/jquery
Jun 13, 2013
deee14e
move old files into a deprecated folder
Jun 13, 2013
15691e5
remove example files that are not required on this branch
Jun 13, 2013
1bd929e
remove unused bootstrap folder
Jun 13, 2013
88b8356
update the builds
Jun 13, 2013
cc04518
remove migration and make examples
Jun 13, 2013
cbd5eea
remove logs and add in ios6 var from pavan's pull request
Jun 13, 2013
108c97e
new builds
Jun 13, 2013
587bf7e
remove global var
Jun 13, 2013
868c2e7
weird width loading issue addressed, plus when swipe distance >> item…
wonja Jun 14, 2013
00ad59e
Merge branch 'jquery' of github.com:moovweb/uranium into jquery
wonja Jun 14, 2013
4aa0f2d
merge conflicts
wonja Jun 14, 2013
412cd8d
change $ to jquery
Jun 25, 2013
1c88985
Important note - dealing with two jQuery instances
Jun 26, 2013
ee4c776
jQuery uses .css(), not .getStyle()
moovchris Jul 2, 2013
01b4bba
avoid "Object #<Object> has no method 'filter'"
moovchris Jul 2, 2013
6d2628d
fix carousel displacementIndex
moovchris Jul 2, 2013
4d41f5c
better check for button presence
moovchris Jul 2, 2013
164b46b
Merge pull request #93 from moovchris/master
Jul 2, 2013
18dcafe
Merge pull request #90 from wonja/jquery
Jul 8, 2013
e27edbf
merge conflict resolution
Jul 8, 2013
26c6659
un() (xui) -> unbind() (jquery) in zoom
wonja Jul 22, 2013
8ff6d44
Merge pull request #94 from wonja/jquery
Jul 22, 2013
c1b2a8d
Merge branch 'jquery'
Jul 22, 2013
2d33fe2
add in more examples
Jul 26, 2013
c646598
tweak selector to insure that you can have items within items
Jul 26, 2013
7cdf159
update bundles
Jul 26, 2013
d9153af
Merge branch 'jquery'
Jul 26, 2013
91b9bc6
remove some logs
Aug 8, 2013
f0f82ca
fix for firefox, ie 10
Aug 9, 2013
3c76c53
tweak input clear
Aug 9, 2013
7492447
fix links in ie carousel
Aug 9, 2013
0ce1126
Merge pull request #95 from moovweb/firefox_fix
Aug 9, 2013
c840d4f
MVSDK-571 #comment Fixing input clear for mobile Safari
malrase Sep 11, 2013
41a7001
data-ur-id toggler fix
Sep 14, 2013
2e93276
update tabs
Sep 16, 2013
619c816
update input clear
Sep 16, 2013
c40f0c0
update geocode
Sep 16, 2013
38cbde0
allow duplicate components
Sep 17, 2013
f647802
update carousel
Sep 17, 2013
fcde97b
update zoom
Sep 17, 2013
b168298
revert small tweaks
Sep 17, 2013
eb7eae2
slight renaming
Sep 17, 2013
47be83a
remove old method
Sep 17, 2013
902e73f
Update README.md
HamptonMakes Sep 17, 2013
9764a76
remove old method
Sep 17, 2013
8f125a5
Merge branch 'master' of github.com:moovweb/uranium into ur_id_fix
Sep 17, 2013
e732127
fix dup naming
Sep 17, 2013
e2317ea
fix new zoom img bug
Sep 20, 2013
01783bc
fix MVSDK-632
Sep 21, 2013
87ee8d5
Merge pull request #98 from moovweb/zoom_fix
mdavidgreen Sep 23, 2013
62c88c9
update readme file and examples directory
mdavidgreen Sep 23, 2013
6034ccc
Merge branch 'master' into readme_updates
mdavidgreen Sep 23, 2013
1699ecf
improve readme for local examples
mdavidgreen Sep 23, 2013
91300cd
Small changes including capitalisation
malrase Sep 24, 2013
b33bd4b
Fixing an issue where the zoom out button on the zoom interaction did…
malrase Sep 26, 2013
0e70b36
Merge pull request #99 from moovweb/zoomout_button_fix
mdavidgreen Sep 26, 2013
6959c43
js should be Javascript plus small grammar mistake
malrase Sep 26, 2013
cdb1080
Slight changes to the readme
malrase Sep 27, 2013
4121e16
Small addition showing that the index.html file is where the examples…
malrase Sep 27, 2013
3719fea
Merge pull request #100 from moovweb/readme_updates
mdavidgreen Sep 30, 2013
d68af86
start carousel rewrite
Sep 30, 2013
89e289c
revise carousel
Oct 2, 2013
579e487
fix double init
Oct 2, 2013
385c0db
fix dots
Oct 2, 2013
5f006e2
allow margins, translate3d option
Oct 3, 2013
31f139e
remove unneeded method
Oct 3, 2013
07762d7
cleanup, fix margin js
Oct 3, 2013
a1cd906
minor renaming
Oct 3, 2013
60c81f0
fix centered snapping
Oct 4, 2013
8eab00b
remove margin calculations
Oct 4, 2013
70862de
handle late loading images
Oct 4, 2013
14429a3
shared touch vars
Oct 4, 2013
3ba3f21
add some comments
Oct 5, 2013
2566c81
reduce num of clones, change switching logic
Oct 7, 2013
0e9969f
reduce center clones
Oct 7, 2013
3087454
use totalwidth var, simplify looping logic
Oct 8, 2013
e2aa39d
simplify test3d
Oct 8, 2013
f773a21
allow button spamming
Oct 8, 2013
d9fe63d
name tweak
Oct 8, 2013
acdc4ac
shorten some code
Oct 8, 2013
65ff767
minor renaming
Oct 8, 2013
78bc29b
minor safari refix
Oct 8, 2013
32005c5
mobile device fix
Oct 8, 2013
82d4ec6
fix updating of centered carousels
Oct 8, 2013
8cc2547
update examples version of Uranium
mdavidgreen Oct 9, 2013
49a09e7
resurrect touch event fix for zoom button
mdavidgreen Oct 9, 2013
e80b444
use strict mode
Oct 9, 2013
a78fb1e
update version to 1.0
mdavidgreen Oct 9, 2013
93aa517
Merge pull request #101 from moovweb/carousel_fix
mdavidgreen Oct 9, 2013
02a181f
revert strict mode
mdavidgreen Oct 9, 2013
ecaac9b
Merge pull request #102 from moovweb/fix_strict
mdavidgreen Oct 9, 2013
20919c1
handle other clicks on carousel items
Oct 9, 2013
b67caa0
Merge pull request #104 from moovweb/release_1.0
mdavidgreen Oct 10, 2013
67dfc69
also look at initial elements
Oct 16, 2013
5fcceae
add drawer state
Oct 18, 2013
d3f5af2
Merge branch 'master' into carousel_click
mdavidgreen Oct 28, 2013
2c3f38e
merge init bug
mdavidgreen Oct 28, 2013
d21d932
merge drawer
mdavidgreen Oct 28, 2013
d2ff577
add example for toggler drawer
mdavidgreen Oct 29, 2013
0c0f574
Merge pull request #109 from moovweb/drawer-example
Oct 30, 2013
42fe080
add carousel counter template
Oct 30, 2013
921bdcc
Merge pull request #110 from moovweb/count_template
mdavidgreen Oct 30, 2013
a81c2e6
fix small drawer issue
Nov 1, 2013
d384af7
Merge pull request #111 from moovweb/drawer_patch
mdavidgreen Nov 1, 2013
2b70996
namespace events, check older jquery
Nov 2, 2013
6afb0df
shorten syntax
Nov 2, 2013
d79f3f6
fix typos
Nov 4, 2013
06423c8
backward compatible trigger
Nov 4, 2013
5cc6d4b
short syntax
Nov 4, 2013
1a69d5b
Merge pull request #112 from moovweb/events
mdavidgreen Nov 5, 2013
578cdc6
fix zoom in carousel, cleanup 3d
Nov 7, 2013
dd920da
counter patch
Nov 7, 2013
f7b4b38
add transform3d option to zoom
Nov 7, 2013
09bc9ee
Merge branch 'master' of github.com:moovweb/uranium into zoom
Nov 7, 2013
eef68e4
Merge pull request #113 from moovweb/zoom
mdavidgreen Nov 15, 2013
192a9c4
fix closeable tab functionality
mdavidgreen Nov 22, 2013
8bf9075
Merge pull request #115 from moovweb/fix-closeable
Nov 22, 2013
64e4ec3
separate files again
Dec 5, 2013
89890ad
Merge pull request #119 from moovweb/split_files
mdavidgreen Dec 9, 2013
5a8783a
jquery 1.6/7 fix
Dec 10, 2013
adb56ec
Merge pull request #120 from moovweb/old_jquery_fix
mdavidgreen Dec 10, 2013
f64e11d
fix geocode button
Dec 11, 2013
cc73025
Merge pull request #121 from moovweb/geocode_fix
mdavidgreen Dec 11, 2013
fed37e5
fix setting outerwidth on older jquery
Dec 14, 2013
9e1ff7f
Merge pull request #122 from moovweb/carousel_fix
mdavidgreen Dec 14, 2013
93f4faf
fix geocode callback
Feb 3, 2014
c547fef
Merge pull request #123 from moovweb/geocode_fix
mdavidgreen Feb 4, 2014
135672a
hackathon
Mar 6, 2014
8f78e11
clean up zoom
Mar 7, 2014
89a6ae6
zoom
Mar 8, 2014
77b8bb6
some zoom cleanup
Mar 11, 2014
a4aaae9
carousel options
Mar 12, 2014
891be7e
geocode, inputclear
Mar 12, 2014
92a0994
make js options work
Mar 12, 2014
6ae369b
update pure js init
Mar 18, 2014
69162ed
Fix gem stuff
jbussdieker Mar 25, 2014
3d7dca7
Merge pull request #124 from moovweb/hackathon
mdavidgreen Mar 26, 2014
bbc72cd
remove comment
Mar 26, 2014
00a8e1d
adding collapse / expand capability to toggler
letrest Apr 9, 2014
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ doc/*.html
examples/site/_site/*
.sass-cache/

build/.remote/
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
uraniumjs.com
uranium.io
5 changes: 3 additions & 2 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
source "http://gems.moovweb.org"
source "http://gems.moovweb.net"
source "http://rubygems.org"

gem "rake"
gem "manhattan_uploader", "0.2.24"
gem "fusion", "0.0.5"
gem "rdiscount"
gem "rdiscount"
3 changes: 2 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
GEM
remote: http://gems.moovweb.org/
remote: http://gems.moovweb.net/
remote: http://rubygems.org/
specs:
domain_name (0.5.2)
unf (~> 0.0.3)
Expand Down
135 changes: 63 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,134 +1,125 @@
# Overview
# Uranium

Uranium is meant to be :
## Overview

Uranium is a simple Javascript interaction library written in jQuery. It's meant to be...

- Lightweight
- Easy to use
- Declarative
- Interface Focused

That's it!

If given the choice between easy to use and powerful, ease of use is the greater goal. If you find yourself wanting something that a given widget will not do, you're encouraged to extend the widget yourself.
If given the choice between easy to use and powerful, ease of use is the greater goal.

It should be noted that since Uranium extends xui -- this library is geared for widgets that are useful on mobile devices. It also is designed to support mobile browsers (for now just webkit, but you can build it for blackberry/mobile IE as well).
View the [website](http://uranium.io/) for more details and demos.

View the [website](http://uraniumjs.com/) for more details and demos.

---

# Lightweight

**The whole library is 15 KB gzipped (including all widgets and xui) !**

- Uranium is based on [xui](http://xuijs.com/) -- the featherweight mobile js library
- Uranium is bundled with xui to make just one javascript file(uranium/raw/master/build/src/uranium.js).
- If you want it even lighter, you can make a custom [build](uranium/blob/master/doc/dev/build.md) yourself. Follow the instructions below.

---

# Easy to Use
## Easy to Use

**Uranium requires ZERO programming on your part.**

Uranium adopts the 'declarative' javascript style. Because of this, you can use the widgets without touching a single line of javascript.
Uranium adopts the 'declarative' Javascript style. Because of this, you can use the interactions just by editing your HTML and CSS, without touching a single line of Javascript.

**What is declarative javascript?**
**What is declarative Javascript?**

Declarative javascript is a model that looks for how html elements are formatted to construct all the necessary js magic to make those elements come to life.
Declarative Javascript is a model that looks for how html elements are formatted to construct all the necessary js magic to make those elements come to life.

---

# Get Started

There are two primary steps to make a widget:
## Uranium is not ...

**...designed for executing logic or site functions**

- Add special attributes to the html element you wish to make a widget
- Include [uranium.js](uranium/raw/master/build/src/uranium.js)
The declarative Javascript in Uranium is not designed for performing functions, but for enabling interactions. It's a bad idea to add attributes to an element to perform some Javascript logic. This is exactly why onclicks should be avoided. If you want to execute site logic or perform functions, that's what events / listeners / callbacks are for. The declarative approach promoted by Uranium makes the view (your UI/UX) rely on the model (your HTML).

View the [website](http://uraniumjs.com/) for a [tutorial](http://uraniumjs.com/tutorials.html) (we have videos!), more details, and awesome [demos](http://uraniumjs.com/widget_list.html).
**But I need to do x/y/z functions that Uranium doesn't handle !**

You're in luck! Uranium is designed to work with [jQuery](http://www.jquery.com) – which (we think) provides a great set of convenient Javascript functions along with some very useful cross-browser compatibility features. With this in mind, using Uranium gives you the best of both worlds – its primary purpose is to make it easy to add great interaction – but if you need to do something fancy, it makes sure the tools you need to do so concisely are also available.

- Read our [philosophy](http://uraniumjs.com/more.html) to understand our design goals and see how to implement a widget.
- Admire all the [widgets](http://uraniumjs.com/widget_list.html) available.

---

# Uranium is not ...
## Building Uranium

**... designed for executing logic or site functions**
If you're contributing to the code base, you need to test your changes and update the bundled Javascript.

Uranium makes the view (your UI/UX) rely on the model (your HTML). The declarative aspect is not designed for performing functions. You wouldn't want to add attributes to an element to perform some js logic (this is exactly why onclicks should be avoided) -- thats what events / listeners / callbacks are for.
**Bundling**

**But I need to do x/y/z functions that Uranium doesn't handle !**
Bundling uses [fusion](http://rubygems.org/gems/fusion) to bundle the Javascript. This means you have to install the fusion ruby gem before you can run the build process. To perform the default build from inside your local copy of the Uranium repository, just do:

gem install fusion
cd build
rake

This will read in the full Javascript source in the lib/jquery.uranium.js file, and place both full-source and minified copies of Uranium in build/src/.

You're in luck! Uranium bundles with xui -- which (we think) provides a great minimal set of convenient javascript functions (query, add-listeners, ajax, iterate, etc). With this in mind, Uranium is the best of both worlds -- its primary purpose is to make it easy to create great widgets UI/UX -- but if you need to do something fancy, it gives you the tools you need to do so concisely.
**Testing**

You need to go through all of the test cases in the /examples/index.html file and make sure that all the interactions still work. Of course, if you've added functionality, or a new interaction, you need to make a test example for your new cases as well and make sure those pass. It should be an example file that can be shown on the website.

---

# Building Uranium
## Building an Interaction

If you're contributing to the code base, you need to test your changes and update the bundled javascript.
Fork Uranium. Build your interaction. Issue a Pull Request. Revel in glory.

**Bundling**
If you're contributing to the code base, you need to test your changes and update the bundled Javascript.

Bundling uses the Google Closure Compiler to bundle the javascript. Don't worry -- part of the rake task is to install if for you! To perform the default build, just do:
**Technical**

cd build
rake
TODO: Information on how the code base should be structured, conventions, etc...

This will compile all the widgets with each flavor (BB/IE/webkit) of xui.
To get the examples running locally, start the jekyll server with:

**Custom Bundling**
`jekyll serve --watch`

The rake task really just reads the config files (e.g. webkit.yaml) to know how to bundle the javascript. The different versions also have different widget lists to reflect those widgets compatabile with that browser flavor.
In a separate terminal process, run

If you want to omit certain widgets or make a custom build, you're welcome to do so locally (and can do so by making your own custom yaml file / build task). This is a great way to only build a smaller version of the specific widgets that you'll need.
`sass --watch examples/scss:_examples/css --line-comments --compass`

**Testing**
on the stylesheets folder to compile your Sass files.

You need to go through all of the test cases under /examples and make sure that all the widgets still work. Of course, if you've added functionality or a new widget, you need to make a test example for your new cases as well and make sure those pass. It should be an example file that can be shown on the website.
You will be able to navigate to [localhost:4000](localhost:4000) to see the examples running in your browser.

---
**Documentation**

# Building a Widget
You'll need to generate a .html file demonstrating the use of your new interaction. It goes in the examples folder, and should do the following things

Fork Uranium. Build your widget. Issue a Pull Request. Revel in glory.
* Provide documentation of all the attributes, CSS, and JS required to make the interaction go.
* At least one example of how the interaction can be used.

If you're contributing to the code base, you need to test your changes and update the bundled javascript.
**Important Note**

**Technical**
If there are two versions of jQuery on a page, Uranium will break. To avoid this, try to only use 1 instance of jQuery. If that is not possible, you will need to use jQuery.noConflict() on both instances.

TODO: Information on how the code base should be structured, conventions, etc...
---

Start the jekyll server with `jekyll --server --pygments`
## Future Wishlist

Run `sass --watch stylesheets/sass:stylesheets --line-comments --compass` onteh stylesheets folder to compile your SASS files.
Uranium is an ongoing project and we're constantly looking to add useful features (that are within the scope of the ideals above).

**Documentation**
Additional features to current interactions:

- *Carousel*: "Stop autoscroll" button
- *Carousel*: Auto-populate clones on infinite scroll when container is larger than actual items
- *Geocode*: Entering zipcode should find address

You'll need to generate an .html file that goes in the _site/widgets folder that should do the following things
New interactions:

* Provide documentation of all the attributes, CSS, and JS required to make the widget go.
* At least one example of how the widget can be used.
- Validation interaction for form inputs

---

# MIT License
## MIT License

Copyright (C) 2011 by Moov Corporation (aka Moovweb)
Copyright (C) 2011-2013 by Moov Corporation (aka Moovweb)

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:
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 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 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.
1 change: 1 addition & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ task :upload => [:enrich] do
end

task :default => [:enrich]

2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1
1.0
8 changes: 4 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# url: "http://moovweb.github.com/uranium/"
source: "examples/site"
destination: "examples/site/_site"
auto: "true"
url: "http://moovweb.github.com/uranium/"
source: "examples/"
destination: "_examples"
pygments: true
5 changes: 0 additions & 5 deletions bootstrap/README.md

This file was deleted.

52 changes: 0 additions & 52 deletions bootstrap/css/scss/test.sass

This file was deleted.

Loading