Merge afb-client
[src/app-framework-demo.git] / afb-client / bower_components / tether / docs / 2-Examples / 1-list_of_examples.md
diff --git a/afb-client/bower_components/tether/docs/2-Examples/1-list_of_examples.md b/afb-client/bower_components/tether/docs/2-Examples/1-list_of_examples.md
new file mode 100644 (file)
index 0000000..bbb7fd5
--- /dev/null
@@ -0,0 +1,27 @@
+### Examples
+
+It's our goal to create a wide variety of example of how Tether
+can be used.  Here's what we have so far, please send a PR with
+any examples you might create.
+
+#### Beginner
+
+- [simple](../../examples/simple): A simple example to get you started
+- [out-of-bounds](../../examples/out-of-bounds): How to hide the element when it would
+otherwise be offscreen
+- [pin](../../examples/pin): How to pin the element so it never goes offscreen
+- [enable-disable](../../examples/enable-disable): How to enable and disable the Tether
+in JavaScript
+
+#### Advanced
+
+- [content-visible](../../examples/content-visible): Demonstrates using the `'visible'`
+`targetModifier` to align an element with the visible portion of another.
+- [dolls](../../examples/dolls): A performance test to show several dozen elements,
+each tethered to the previous.  Try dragging the top left tether.
+- [element-scroll](../../examples/element-scroll): Demonstrates using the `'scroll-handle'`
+`targetModifier` to align an element with the scrollbar of an element.
+- [scroll](../../examples/scroll): Demonstrates using the `'scroll-handle'` `targetModifier`
+to align an element with the body's scroll handle.
+- [viewport](../../examples/viewport): Demonstrates aligning an element with the
+viewport by using the `'visible'` `targetModifier` when tethered to the body.