Added documentation for animations

Wtower · Dec 27, 2016 · 29c5cb7 · 29c5cb7
1 parent 19d0a8b
commit 29c5cb7
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/animations.rst b/docs/animations.rst
@@ -0,0 +1,27 @@
+Animations
+==========
+
+The following animations are currently supported.
+
+Table updates
+-------------
+
+A 500msec fade occurs when table rows change. This is useful when a list data is updated or filtered.
+
+View change
+-----------
+
+A 700 msec fade occurs when the angular view changes.
+
+Helper classes
+--------------
+
+Additionally, the following classes can be applied in any element.
+
+Spinning
+^^^^^^^^
+
+Add the ``spinning`` class to make an element spin. Useful for bootstrap or fa icons::
+
+    <span class="glyphicon glyphicon-refresh spinning">
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,6 +30,7 @@ are based on the markup by `Gentelella`_ bootstrap template.
    form-field-select
    form-field-checkbox
    form-field-image
+   animations
 
 Features and limitations
 ------------------------