diff --git a/docs/javascript/alerts.md b/docs/javascript/alerts.md index 43ef5a20bc..1704a664c8 100644 --- a/docs/javascript/alerts.md +++ b/docs/javascript/alerts.md @@ -3,74 +3,90 @@ layout: page title: Alerts --- -
-

Alert messages alert.js

+Add dismiss functionality to all alert messages with this plugin. -

Example alerts

-

Add dismiss functionality to all alert messages with this plugin.

-
- -
+## Examples -
- -
+{% example html %} + +{% endexample %} +{% example html %} + +{% endexample %} -

Usage

-

Enable dismissal of an alert via JavaScript:

- {% highlight js %}$(".alert").alert(){% endhighlight %} +## Usage -

Markup

-

Just add data-dismiss="alert" to your close button to automatically give an alert close functionality.

- {% highlight html %}{% endhighlight %} +Enable dismissal of an alert via JavaScript: -

Methods

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

$().alert()

-

Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the .fade and .in class already applied to them.

+### Markup -

.alert('close')

-

Closes an alert.

- {% highlight js %}$(".alert").alert('close'){% endhighlight %} +Just add `data-dismiss="alert"` to your close button to automatically give an alert close functionality. +{% highlight html %} + +{% endhighlight %} + +### Methods + +#### $().alert() + +Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the `.fade` and `.in` class already applied to them. + +#### .alert('close') + +Closes an alert. + +{% highlight js %}$(".alert").alert('close'){% endhighlight %} + +### Events + +Bootstrap's alert class exposes a few events for hooking into alert functionality. + +
+ + + + + + + + + + + + + + + + + +
Event TypeDescription
close.bs.alertThis event fires immediately when the close instance method is called.
closed.bs.alertThis event is fired when the alert has been closed (will wait for CSS transitions to complete).
+
-

Events

-

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

-
- - - - - - - - - - - - - - - - - -
Event TypeDescription
close.bs.alertThis event fires immediately when the close instance method is called.
closed.bs.alertThis event is fired when the alert has been closed (will wait for CSS transitions to complete).
-
{% highlight js %} $('#my-alert').on('closed.bs.alert', function () { // do something… }) {% endhighlight %} -