File: options.html

package info (click to toggle)
select2.js 4.0.1~dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,416 kB
  • ctags: 143
  • sloc: makefile: 7
file content (58 lines) | stat: -rw-r--r-- 1,637 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<section>
  <h2 id="options">
    How should Select2 be initialized?
  </h2>

  <h3 id="setting-default-options">
    Can default options be set for all dropdowns?
  </h3>

  <p>
    In some cases, you need to set the default options for all instances of
    Select2 in your web application. This is especially useful when you are
    migrating from past versions of Select2, or you are using non-standard
    options <a href="#amd">like custom AMD builds</a>. Select2 exposes the
    default options through <code>$.fn.select2.defaults</code>, which allows
    you to set them globally.
  </p>

  <p>
    When setting options globally, any past defaults that have been set will
    be overriden. Default options are only used when an option is requested
    that has not been set during initialization.
  </p>

  <p>
    <strong>You can set default options</strong> by calling
    <code>$.fn.select2.defaults.set("key", "value")</code>.
  </p>

<pre class="prettyprint">
$.fn.select2.defaults.set("theme", "classic");
</pre>

  <h3>
    How can I set a default value for a nested option?
  </h3>

  <p>
    The key that is
    set should take the same format as keys set using
    <a href="#data-attributes">HTML <code>data-*</code> attributes</a> which
    means that two dashes (<code>--</code>) will be replaced by a level of
    nesting, and a single dash (<code>-</code>) will convert it to a camelCase
    string.
  </p>

  <h3>
    How can I reset all of the global default options?
  </h3>

  <p>
    You can reset the default options by calling
  </p>

<pre class="prettyprint">
$.fn.select2.defaults.reset();
</pre>
</section>