From 1d0f527249ffcad217c47701dab1c7872e85fb34 Mon Sep 17 00:00:00 2001 From: Pierre-Denis Vanduynslager Date: Mon, 16 Jan 2017 00:33:32 -0500 Subject: Add alert divider (
) example in docs (#21673) * Add alert divider (
)example in docs *
=>
per @vsn4ik suggestion --- docs/components/alerts.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/components/alerts.md') diff --git a/docs/components/alerts.md b/docs/components/alerts.md index da72e322e..dae4ec7d3 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -55,12 +55,13 @@ Use the `.alert-link` utility class to quickly provide matching colored links wi ### Additional content -Alerts can also contain additional HTML elements like headings and paragraphs. +Alerts can also contain additional HTML elements like headings, paragraphs and dividers. {% example html %} {% endexample %} -- cgit v1.2.3 From c72cc98bd56fb50259c84a1fced38751009eb930 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 27 May 2017 23:01:14 -0700 Subject: update components docs --- docs/components/alerts.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) (limited to 'docs/components/alerts.md') diff --git a/docs/components/alerts.md b/docs/components/alerts.md index dae4ec7d3..3acfd2a79 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -3,15 +3,9 @@ layout: docs title: Alerts description: Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. group: components +toc: true --- -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). -- cgit v1.2.3 From 3e76d6565603fafa2c85ad81d7b6345c4e279c72 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 22:50:57 -0700 Subject: Rearrange all the docs to allow for a docs/major.minor/ setup --- docs/components/alerts.md | 126 ---------------------------------------------- 1 file changed, 126 deletions(-) delete mode 100644 docs/components/alerts.md (limited to 'docs/components/alerts.md') diff --git a/docs/components/alerts.md b/docs/components/alerts.md deleted file mode 100644 index 3acfd2a79..000000000 --- a/docs/components/alerts.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -layout: docs -title: Alerts -description: Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. -group: 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 four **required** contextual classes (e.g., `.alert-success`). For inline dismissal, use the [alerts jQuery plugin](#dismissing). - -{% example html %} - - - - -{% 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 %} - - - - -{% endexample %} - -### Additional content - -Alerts can also contain additional HTML elements like headings, paragraphs and dividers. - -{% example html %} - -{% 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 ` - 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 `.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 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 %} -- cgit v1.2.3