dog@doggington.com
diff --git a/node/src/documents/guide/cssguide.html b/node/src/documents/guide/cssguide.html
index 58d568faa..67841dc4c 100755
--- a/node/src/documents/guide/cssguide.html
+++ b/node/src/documents/guide/cssguide.html
@@ -97,6 +97,38 @@ type : 'UI Guide'
}
New York Dog Fair
+ A fun day at the fair
+
+
+
+
+ Usage
+ +Initializing a rating
+To change the range of your rating, simply adjust the number of icons in the initialized html
+ +
+ $('.ui.rating')
+ .rating()
+ ;
+
+
+
+
+
+
+ Types
+ + +
+
+
+ Rating
+A basic rating
+ +
+
+
+ Star
+A star rating uses a set of star glyphs to show a rating
+ +
+
+ Heart
+A heart rating uses a set of heart glyphs to show a rating
+ +Examples
+ +
+
+
+
+ Setting existing values
+Starting ratings can be set either using metadata values or the setting initialRating.
+
+
+ 
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+ Dog Appreciation Day
+ I night to tell your dog he's great
+ Variations
+ +
+
+ Size
+A rating can vary in size
+ +
+
+
+
+ Behavior
+
+
+
+ Set Rating
+A rating can be set programatically
+
+ $('.ui.rating')
+ .rating('set rating', 3)
+ ;
+
+ Settings
+ +
+
+
+
+
+
+
+
+
+
+
+
+ Rating Settings
+Rating settings modify the rating's behavior
+| Setting | +Default | +Description | + + +
|---|---|---|
| initialRating | +0 | +A number representing the default rating to apply | +
| interactive | +true | +Whether to enable user's ability to rate | +
+
Callbacks
+Callback settings specify a function to occur after a specific behavior.
+ +| Setting | +Context | +Description | + + +
|---|---|---|
| onRate(value) | +Rating | +Is called after user selects a new rating | +
+
+
+
+
+
+
+
+ DOM Settings
+DOM settings specify how this module should interface with the DOM
+| Setting | +Default | +Description | + + +
|---|---|---|
| namespace | +rating | +Event namespace. Makes sure module teardown does not effect other events attached to an element. | +
| selector | +
+
+ selector : {
+ icon : '.icon'
+ }
+
+ |
+ |
| className | +
+
+ className : {
+ active : 'active',
+ hover : 'hover',
+ loading : 'loading'
+ },
+
+ |
+ |
+
+
+
+
+
+
+
+Debug Settings
+Debug settings controls debug output to the console
+| Setting | +Default | +Description | + + +
|---|---|---|
| name | +Rating | +Name used in debug logs | +
| debug | +True | +Provides standard debug output to console | +
| performance | +True | +Provides standard debug output to console | +
| verbose | +True | +Provides ancillary debug output to console | +
| error | +
+
+ error : {
+ action : 'You called a rating action that was not defined'
+ }
+
+ |
+ |