From 9499907b468e89fe864dcc503e20402f6e610901 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 13 Jul 2014 00:54:29 -0700 Subject: [PATCH] markdownify js modal --- docs/javascript/modal.md | 443 ++++++++++++++++++++------------------- 1 file changed, 233 insertions(+), 210 deletions(-) diff --git a/docs/javascript/modal.md b/docs/javascript/modal.md index bd430a8de4..5473296774 100644 --- a/docs/javascript/modal.md +++ b/docs/javascript/modal.md @@ -3,46 +3,45 @@ layout: page title: Modal --- -
-

Modals modal.js

+Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults. -

Examples

-

Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.

+
+

Overlapping modals not supported

+

Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.

+
+
+

Modal markup placement

+

Always try to place a modal's HTML code in a top-level position in your document to avoid other components affecting the modal's appearance and/or functionality.

+
+
+

Mobile device caveats

+

There are some caveats regarding using modals on mobile devices. See our browser support docs for details.

+
-
-

Overlapping modals not supported

-

Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.

-
-
-

Modal markup placement

-

Always try to place a modal's HTML code in a top-level position in your document to avoid other components affecting the modal's appearance and/or functionality.

-
-
-

Mobile device caveats

-

There are some caveats regarding using modals on mobile devices. See our browser support docs for details.

-
+### Static example + +A rendered modal with header, body, and set of actions in the footer.

+ +
+
+
+
+
+ +

Modal title

+
+
+

One fine body…

+
+
+ + +
+
+
+
+
-

Static example

-

A rendered modal with header, body, and set of actions in the footer.

-
-
-
-
-
- -

Modal title

-
-
-

One fine body…

-
-
- - -
-
-
-
-
{% highlight html %}
@@ -63,54 +62,56 @@ title: Modal
{% endhighlight %} -

Live demo

-

Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.

- - + +
+ +
-
- -
{% highlight html %}
{% endhighlight %} -
-

Make modals accessible

-

Be sure to add role="dialog" to .modal, aria-labelledby="myModalLabel" attribute to reference the modal title, and aria-hidden="true" to tell assistive technologies to skip the modal's DOM elements.

-

Additionally, you may give a description of your modal dialog with aria-describedby on .modal.

-
+
+

Make modals accessible

+

Be sure to add role="dialog" to .modal, aria-labelledby="myModalLabel" attribute to reference the modal title, and aria-hidden="true" to tell assistive technologies to skip the modal's DOM elements.

+

Additionally, you may give a description of your modal dialog with aria-describedby on .modal.

+
-
-

Embedding YouTube videos

-

Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. See this helpful Stack Overflow post for more information.

-
+
+

Embedding YouTube videos

+

Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. See this helpful Stack Overflow post for more information.

+
+ +## Optional sizes + +Modals have two optional sizes, available via modifier classes to be placed on a `.modal-dialog`. + +
+ + +
-

Optional sizes

-

Modals have two optional sizes, available via modifier classes to be placed on a .modal-dialog.

-
- - -
{% highlight html %} @@ -178,151 +182,170 @@ title: Modal
{% endhighlight %} - - + + +## Remove animation + +For modals that simply appear rather than fade in to view, remove the `.fade` class from your modal markup. -

Remove animation

-

For modals that simply appear rather than fade in to view, remove the .fade class from your modal markup.

{% highlight html %} {% endhighlight %} -

Usage

-

The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds .modal-open to the <body> to override default scrolling behavior and generates a .modal-backdrop to provide a click area for dismissing shown modals when clicking outside the modal.

+## Usage + +The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds `.modal-open` to the `` to override default scrolling behavior and generates a `.modal-backdrop` to provide a click area for dismissing shown modals when clicking outside the modal. + +### Via data attributes + +Activate a modal without writing JavaScript. Set `data-toggle="modal"` on a controller element, like a button, along with a `data-target="#foo"` or `href="#foo"` to target a specific modal to toggle. -

Via data attributes

-

Activate a modal without writing JavaScript. Set data-toggle="modal" on a controller element, like a button, along with a data-target="#foo" or href="#foo" to target a specific modal to toggle.

{% highlight html %} {% endhighlight %} -

Via JavaScript

-

Call a modal with id myModal with a single line of JavaScript:

- {% highlight js %}$('#myModal').modal(options){% endhighlight %} +### Via JavaScript -

Options

-

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-backdrop="".

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
backdropboolean or the string 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
showbooleantrueShows the modal when initialized.
-
+Call a modal with id `myModal` with a single line of JavaScript: -

Methods

+{% highlight js %}$('#myModal').modal(options){% endhighlight %} + +### Options + +Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-backdrop=""`. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Nametypedefaultdescription
backdropboolean or the string 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
showbooleantrueShows the modal when initialized.
+
+ +### Methods + +#### .modal(options) + +Activates your content as a modal. Accepts an optional options `object`. -

.modal(options)

-

Activates your content as a modal. Accepts an optional options object.

{% highlight js %} $('#myModal').modal({ keyboard: false }) {% endhighlight %} -

.modal('toggle')

-

Manually toggles a modal. Returns to the caller before the modal has actually been shown or hidden (i.e. before the shown.bs.modal or hidden.bs.modal event occurs).

- {% highlight js %}$('#myModal').modal('toggle'){% endhighlight %} +#### .modal('toggle') -

.modal('show')

-

Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs).

- {% highlight js %}$('#myModal').modal('show'){% endhighlight %} +Manually toggles a modal. **Returns to the caller before the modal has actually been shown or hidden** (i.e. before the `shown.bs.modal` or `hidden.bs.modal` event occurs). -

.modal('hide')

-

Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).

- {% highlight js %}$('#myModal').modal('hide'){% endhighlight %} +{% highlight js %}$('#myModal').modal('toggle'){% endhighlight %} + +#### .modal('show') + +Manually opens a modal. **Returns to the caller before the modal has actually been shown** (i.e. before the `shown.bs.modal` event occurs). + +{% highlight js %}$('#myModal').modal('show'){% endhighlight %} + +#### .modal('hide') + +Manually hides a modal. **Returns to the caller before the modal has actually been hidden** (i.e. before the `hidden.bs.modal` event occurs). + +{% highlight js %}$('#myModal').modal('hide'){% endhighlight %} + +### Events + +Bootstrap's modal class exposes a few events for hooking into modal functionality. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.modalThis event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modalThis event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
loaded.bs.modalThis event is fired when the modal has loaded content using the remote option.
+
-

Events

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.modalThis event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modalThis event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
loaded.bs.modalThis event is fired when the modal has loaded content using the remote option.
-
{% highlight js %} $('#myModal').on('hidden.bs.modal', function (e) { // do something... }) {% endhighlight %} -