aboutsummaryrefslogtreecommitdiff
path: root/docs/components/alerts.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/components/alerts.md')
-rw-r--r--docs/components/alerts.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/components/alerts.md b/docs/components/alerts.md
new file mode 100644
index 000000000..ff25de763
--- /dev/null
+++ b/docs/components/alerts.md
@@ -0,0 +1,66 @@
+---
+layout: page
+title: Alerts
+---
+
+Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. For inline dismissal, use the [alerts jQuery plugin]({{ site.baseurl }}javascript/#alerts).
+
+Wrap any text and an optional dismiss button in `.alert` and one of the four contextual classes (e.g., `.alert-success`) for basic alert messages.
+
+<div class="bs-callout bs-callout-info">
+ <h4>No default class</h4>
+ <p>Alerts don't have default classes, only base and modifier classes. A default gray alert doesn't make too much sense, so you're required to specify a type via contextual class. Choose from success, info, warning, or danger.</p>
+</div>
+
+{% example html %}
+<div class="alert alert-success" role="alert">
+ <strong>Well done!</strong> You successfully read this important alert message.
+</div>
+<div class="alert alert-info" role="alert">
+ <strong>Heads up!</strong> This alert needs your attention, but it's not super important.
+</div>
+<div class="alert alert-warning" role="alert">
+ <strong>Warning!</strong> Better check yourself, you're not looking too good.
+</div>
+<div class="alert alert-danger" role="alert">
+ <strong>Oh snap!</strong> Change a few things up and try submitting again.
+</div>
+{% endexample %}
+
+### Dismissing
+
+Build on any alert by adding an optional `.alert-dismissible` and [close button]().
+
+{% example html %}
+<div class="alert alert-warning alert-dismissible" role="alert">
+ <button type="button" class="close" data-dismiss="alert">
+ <span aria-hidden="true">&times;</span>
+ <span class="sr-only">Close</span>
+ </button>
+ <strong>Warning!</strong> Better check yourself, you're not looking too good.
+</div>
+{% endexample %}
+
+<div class="bs-callout bs-callout-warning">
+ <h4>Ensure proper behavior across all devices</h4>
+ <p>Be sure to use the <code>&lt;button&gt;</code> element with the <code>data-dismiss="alert"</code> data attribute.</p>
+</div>
+
+### Link color
+
+Use the `.alert-link` utility class to quickly provide matching colored links within any alert.
+
+{% example html %}
+<div class="alert alert-success" role="alert">
+ <strong>Well done!</strong> You successfully read <a href="#" class="alert-link">this important alert message</a>.
+</div>
+<div class="alert alert-info" role="alert">
+ <strong>Heads up!</strong> This <a href="#" class="alert-link">alert needs your attention</a>, but it's not super important.
+</div>
+<div class="alert alert-warning" role="alert">
+ <strong>Warning!</strong> Better check yourself, you're <a href="#" class="alert-link">not looking too good</a>.
+</div>
+<div class="alert alert-danger" role="alert">
+ <strong>Oh snap!</strong> <a href="#" class="alert-link">Change a few things up</a> and try submitting again.
+</div>
+{% endexample %}