Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Commit b1837c7

Browse files
author
Gabriel Schulhof
committed
[popup docs] Document new option "dismissable"
1 parent 22b486b commit b1837c7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/pages/popup/options.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ <h2>Popup</h2>
4747
<pre><code>$( ".selector" ).popup(<strong>{ corners: false }</strong>);</code></pre>
4848
</dd>
4949

50+
<dt><code>dismissable</code> <em>boolean</em></dt>
51+
<dd>
52+
<p class="default">default: true</p>
53+
<p>Sets whether clicking outside the popup or pressing Escape while the popup is open will close the popup. This option is also exposed as a data attribute: <code>data-dismissable=&quot;false&quot;</code></p>
54+
<p><em>Note:</em> When history support is turned on, pressing the browser's "Back" button will dismiss the popup even if this option is set to false.
55+
<pre><code>$( ".selector" ).popup(<strong>{ dismissable: false }</strong>);</code></pre>
56+
</dd>
57+
5058
<dt><code>history</code> <em>boolean</em></dt>
5159
<dd>
5260
<p class="default">default: true</p>

0 commit comments

Comments
 (0)