From cb52e65fe6419a0b900b6d1a4a160b1f9cac3232 Mon Sep 17 00:00:00 2001 From: jlukic Date: Sun, 13 Oct 2013 01:47:36 -0400 Subject: [PATCH] updates dimmer docs --- node/src/documents/modules/dimmer.html.eco | 108 ++++++++++++++++++--- 1 file changed, 97 insertions(+), 11 deletions(-) diff --git a/node/src/documents/modules/dimmer.html.eco b/node/src/documents/modules/dimmer.html.eco index 18f8f5a4e..5d8f265f3 100755 --- a/node/src/documents/modules/dimmer.html.eco +++ b/node/src/documents/modules/dimmer.html.eco @@ -31,6 +31,7 @@ type : 'UI Module' States Variations Behavior + Settings

Usage

@@ -156,9 +157,94 @@ type : 'UI Module'

Behavior

+

All the following behaviors can be called using the syntax $('.foo').dimmer('behavior name', argumentOne, argumentTwo)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
add content (element)Detatches a given element from DOM and reattaches element inside dimmer
showShows dimmer
hideHides dimmer
toggleToggles current dimmer visibility
get durationReturns current duration for show or hide event depending on current visibility
get dimmerReturbns DOM element for dimmer
has dimmerReturns whether current dimmable has a dimmer
is dimmerWhether current element is a dimmer
is dimamableWhether current element is a dimmable section
is activeWhether section's dimmer is active
is animatingWhether dimmer is animating
is pageWhether dimmable section is body
is enabledWhether dimmer is not disabled
is disabledWhether dimmer is disabled
is page dimmerWhether dimmer is a page dimmer
set activeSets page dimmer to active
set dimmableSets an element as a dimmable section
set dimmedSets a dimmable section as dimmed
set page dimmerSets current dimmer as a page dimmer
set disabledSets a dimmer as disabled
+
-

Display

+

Display

You can display a dimmer by either invoking dimmer show on a section or a dimmer itself. If you choose to dim a dimmable section, a dimmer will automatically be created.

// these two are the same @@ -179,25 +265,25 @@ type : 'UI Module'
-

Settings

- +

Settings

+
- + - + @@ -205,7 +291,7 @@ type : 'UI Module'
Popup SettingsDimmer Settings
closabletruetrue Whether clicking on the dimmer should close it automatically
duration
- duration : { - show : 500, - hide : 500 - }, + duration : { + show : 500, + hide : 500 + }
Animation duration of dimming. If an integer is used, that value will apply to both show and hide animations.
- +
@@ -228,7 +314,7 @@ type : 'UI Module'
Callbacks
- +
UI Module Settings