aboutsummaryrefslogtreecommitdiff
path: root/docs/_includes/js
diff options
context:
space:
mode:
authorKyle <[email protected]>2014-07-26 17:55:18 -0400
committerChris Rebert <[email protected]>2014-08-04 09:07:19 -0700
commit333af7d371ee56db24030786c3036f3198fd3016 (patch)
treefea3f1ab90b988ae00120b13776693581e72bb66 /docs/_includes/js
parentc2f4e5fef1e9f11fa532cb98ccf088e8890e25fc (diff)
downloadbootstrap-333af7d371ee56db24030786c3036f3198fd3016.tar.xz
bootstrap-333af7d371ee56db24030786c3036f3198fd3016.zip
Add docs for how to change default JS plugin settings
Closes #14250.
Diffstat (limited to 'docs/_includes/js')
-rw-r--r--docs/_includes/js/overview.html6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/_includes/js/overview.html b/docs/_includes/js/overview.html
index 3aaba0980..2a3c41a8b 100644
--- a/docs/_includes/js/overview.html
+++ b/docs/_includes/js/overview.html
@@ -47,6 +47,12 @@ $('#myModal').modal('show') // initializes and invokes show immed
<p>Each plugin also exposes its raw constructor on a <code>Constructor</code> property: <code>$.fn.popover.Constructor</code>. If you'd like to get a particular plugin instance, retrieve it directly from an element: <code>$('[rel="popover"]').data('popover')</code>.</p>
+ <h4>Default settings</h4>
+ <p>You can change the default settings for a plugin by modifying the plugin's <code>Constructor.DEFAULTS</code> object:<p>
+{% highlight js %}
+$.fn.modal.Constructor.DEFAULTS.keyboard = false // changes default for the modal plugin's `keyboard` option to false
+{% endhighlight %}
+
<h3 id="js-noconflict">No conflict</h3>
<p>Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call <code>.noConflict</code> on the plugin you wish to revert the value of.</p>
{% highlight js %}