twbs--bootstrap/docs/javascript/alerts.md

3.1 KiB
Raw Blame History

layout title
page Alerts

Add dismiss functionality to all alert messages with this plugin.

Examples

{% example html %}

Close Holy guacamole! Best check yo self, you're not looking too good.
{% endexample %}

When using a .close button, it must be the first child of the .alert-dismissible and no text content may come before it in the markup.

{% example html %}

Close

Oh snap! You got an error!

Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.

Take this action Or do this

{% endexample %}

Usage

Enable dismissal of an alert via JavaScript:

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

Markup

Just add data-dismiss="alert" to your close button to automatically give an alert close functionality. Closing an alert removes it from the DOM.

{% highlight html %} Close {% endhighlight %}

To have your alerts use animation when closing, make sure they have the .fade and .in classes already applied to them.

Methods

$().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 Type 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 %}