kotovalexarian-likes-github/twbs--bootstrap
1
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2022-11-09 12:25:43 -05:00
Code Releases Activity
twbs--bootstrap/docs/components/alerts.md
Mark Otto c064eef67b Massive cleanup 
- Simpler main nav on all pages
- Back to purple masthead on homepage instead of dark graphite
- Active link styles on the main nav
- Cleaned up sidebar nav
- New docs layout name
- Homepage copy edits
- Updated bright purple docs color
2015-08-14 22:45:55 -07:00

4.3 KiB
Raw Blame History

layout title group
docs Alerts components

Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.

Contents

  • Will be replaced with the ToC, excluding the "Contents" header {:toc}

Examples

Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required contextual classes (e.g., .alert-success). For inline dismissal, use the alerts jQuery plugin.

{% example html %}

Well done! You successfully read this important alert message.
Heads up! This alert needs your attention, but it's not super important.
Warning! Better check yourself, you're not looking too good.
Oh snap! Change a few things up and try submitting again.
{% endexample %}

Link color

Use the .alert-link utility class to quickly provide matching colored links within any alert.

{% example html %}

Well done! You successfully read this important alert message.
Heads up! This alert needs your attention, but it's not super important.
Warning! Better check yourself, you're not looking too good.
Oh snap! Change a few things up and try submitting again.
{% endexample %}

Dismissing

Using the alert JavaScript plugin, it's possible to dismiss any alert inline. Here's how:

  • Be sure you've loaded the alert plugin, or the compiled Bootstrap JavaScript.
  • Add a dismiss button and the .alert-dismissible class, which adds extra padding to the right of the alert and positions the .close button.
  • On the dismiss button, add the data-dismiss="alert" attribute, which triggers the JavaScript functionality. Be sure to use the <button> element with it for proper behavior across all devices.
  • To animate alerts when dismissing them, be sure to add the .fade and .in classes.

You can see this in action with a live demo:

{% example html %}

Holy guacamole! You should check in on some of those fields below.
{% endexample %}

JavaScript behavior

Triggers

Enable dismissal of an alert via JavaScript:

{% highlight js %} $(".alert").alert() {% endhighlight %}

Or with data attributes on a button within the alert, as demonstrated above:

{% highlight html %} {% endhighlight %}

Note that closing an alert will remove it from the DOM.

Methods

Method Description
$().alert() Makes an alert listen for click events on descendant elements which have the data-dismiss="alert" attribute. (Not necessary when using the data-api's auto-initialization.)
$().alert('close') Closes an alert by removing it from the DOM. If the .fade and .in classes are present on the element, the alert will fade out before it is removed.

{% highlight js %}$(".alert").alert('close'){% endhighlight %}

Events

Bootstrap's alert plugin exposes a few events for hooking into alert functionality.

Event Description
close.bs.alert This event fires immediately when the close instance method is called.
closed.bs.alert This event is fired when the alert has been closed (will wait for CSS transitions to complete).

{% highlight js %} $('#myAlert').on('closed.bs.alert', function () { // do something… }) {% endhighlight %}