mirror of
				https://github.com/twbs/bootstrap.git
				synced 2025-10-31 00:04:27 -04:00 
			
		
		
		
	
		
			
				
	
	
		
			132 lines
		
	
	
		
			5.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			132 lines
		
	
	
		
			5.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| ---
 | |
| layout: docs
 | |
| title: Alerts
 | |
| description: Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.
 | |
| group: 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](#dismissing).
 | |
| 
 | |
| {% 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 %}
 | |
| 
 | |
| {% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
 | |
| {{ callout-include | markdownify }}
 | |
| 
 | |
| ### 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 %}
 | |
| 
 | |
| ### Additional content
 | |
| 
 | |
| Alerts can also contain additional HTML elements like headings and paragraphs.
 | |
| 
 | |
| {% example html %}
 | |
| <div class="alert alert-success" role="alert">
 | |
|   <h4 class="alert-heading">Well done!</h4>
 | |
|   <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p>
 | |
|   <p class="mb-0">Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p>
 | |
| </div>
 | |
| {% 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 `.show` classes.
 | |
| 
 | |
| You can see this in action with a live demo:
 | |
| 
 | |
| {% example html %}
 | |
| <div class="alert alert-warning alert-dismissible fade show" role="alert">
 | |
|   <button type="button" class="close" data-dismiss="alert" aria-label="Close">
 | |
|     <span aria-hidden="true">×</span>
 | |
|   </button>
 | |
|   <strong>Holy guacamole!</strong> You should check in on some of those fields below.
 | |
| </div>
 | |
| {% 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 %}
 | |
| <button type="button" class="close" data-dismiss="alert" aria-label="Close">
 | |
|   <span aria-hidden="true">×</span>
 | |
| </button>
 | |
| {% 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 `.show` 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 <code>close</code> 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 %}
 |