mirror of
https://github.com/twbs/bootstrap.git
synced 2025-01-10 03:46:13 +01:00
b46f05a948
This commit includes all the needed workarounds and most changes from the main branch for everything to work, like: * removing empty lines in raw HTML that break output * read .browserslistrc, CSS variables from disk instead of duplicating it * using Hugo mounts * using Hugo for the docs CSS/JS * move ToC Sass code to a separate file while adapting it for Hugo Thus, this patch makes our npm scripts faster since lint runs on one step and there's no separate docs assets processing.
123 lines
4.3 KiB
Markdown
123 lines
4.3 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
|
|
aliases:
|
|
- "/components/"
|
|
- "/docs/4.5/components/"
|
|
toc: true
|
|
---
|
|
|
|
## Examples
|
|
|
|
Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the eight **required** contextual classes (e.g., `.alert-success`). For inline dismissal, use the [alerts jQuery plugin](#dismissing).
|
|
|
|
{{< example >}}
|
|
{{< alerts.inline >}}
|
|
{{- range (index $.Site.Data "theme-colors") }}
|
|
<div class="alert alert-{{ .name }}" role="alert">
|
|
A simple {{ .name }} alert—check it out!
|
|
</div>{{- end -}}
|
|
{{< /alerts.inline >}}
|
|
{{< /example >}}
|
|
|
|
{{< callout warning >}}
|
|
{{< partial "callout-warning-color-assistive-technologies.md" >}}
|
|
{{< /callout >}}
|
|
|
|
### Link color
|
|
|
|
Use the `.alert-link` utility class to quickly provide matching colored links within any alert.
|
|
|
|
{{< example >}}
|
|
{{< alerts.inline >}}
|
|
{{- range (index $.Site.Data "theme-colors") }}
|
|
<div class="alert alert-{{ .name }}" role="alert">
|
|
A simple {{ .name }} alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
|
|
</div>{{ end -}}
|
|
{{< /alerts.inline >}}
|
|
{{< /example >}}
|
|
|
|
### Additional content
|
|
|
|
Alerts can also contain additional HTML elements like headings, paragraphs and dividers.
|
|
|
|
{{< example >}}
|
|
<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>
|
|
<hr>
|
|
<p class="mb-0">Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
|
|
### 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.
|
|
- If you're building our JavaScript from source, it [requires `util.js`]({{< docsref "/getting-started/javascript#util" >}}). The compiled version includes this.
|
|
- 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 >}}
|
|
<div class="alert alert-warning alert-dismissible fade show" role="alert">
|
|
<strong>Holy guacamole!</strong> You should check in on some of those fields below.
|
|
<button type="button" class="close" data-dismiss="alert" aria-label="Close">
|
|
<span aria-hidden="true">×</span>
|
|
</button>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
## JavaScript behavior
|
|
|
|
### Triggers
|
|
|
|
Enable dismissal of an alert via JavaScript:
|
|
|
|
```js
|
|
$('.alert').alert()
|
|
```
|
|
|
|
Or with `data` attributes on a button **within the alert**, as demonstrated above:
|
|
|
|
```html
|
|
<button type="button" class="close" data-dismiss="alert" aria-label="Close">
|
|
<span aria-hidden="true">×</span>
|
|
</button>
|
|
```
|
|
|
|
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. |
|
|
| `$().alert('dispose')` | Destroys an element's alert. |
|
|
|
|
```js
|
|
$('.alert').alert('close')
|
|
```
|
|
|
|
### 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). |
|
|
|
|
```js
|
|
$('#myAlert').on('closed.bs.alert', function () {
|
|
// do something...
|
|
})
|
|
```
|