Skip to content

Commit 19861bf

Browse files
kevin-brownkevin-brown
committed
Merge pull request select2#3724 from select2/docs-faq
Switch option page to FAQ in docs
2 parents 8c26dff + 2b91ac0 commit 19861bf

38 files changed

Lines changed: 1363 additions & 378 deletions

‎docs/_includes/nav/options-old.html‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<nav class="s2-docs-sidebar hidden-print hidden-xs hidden-sm">
2+
<ul class="nav s2-docs-sidenav">
3+
<li>
4+
<a href="#core-options">Core Options</a>
5+
<ul class="nav">
6+
<li><a href="#data-attributes">Declaring configuration in the <code>data-*</code> attributes</a></li>
7+
<li><a href="#amd">AMD compatibility</a></li>
8+
<li><a href="#core-options-display">Displaying selections</a></li>
9+
<li><a href="#core-options-results">Returning and displaying results</a></li>
10+
</ul>
11+
</li>
12+
<li>
13+
<a href="#dropdown">Dropdown</a>
14+
<ul class="nav">
15+
<li><a href="#dropdownParent">Attached to body</a></li>
16+
<li><a href="#dropdown-attachContainer">Attached below the container</a></li>
17+
<li><a href="#dropdown-search">Search</a></li>
18+
<li><a href="#dropdown-select-on-close">Select the highlighted option on close</a></li>
19+
<li><a href="#closeOnSelect">Close the dropdown when a result is selected</a></li>
20+
</ul>
21+
</li>
22+
<li>
23+
<a href="#events">Events</a>
24+
<ul class="nav">
25+
<li><a href="#events-public">Public events</a></li>
26+
<li><a href="#events-internal">Internal events</a></li>
27+
</ul>
28+
</li>
29+
<li>
30+
<a href="#adapters">The plugin system (adapters)</a>
31+
<ul class="nav">
32+
<li><a href="#adapters-all">All adapters</a></li>
33+
<li><a href="#selectionAdapter">Container (selection)</a></li>
34+
<li><a href="#dataAdapter">Data set</a></li>
35+
<li><a href="#dropdownAdapter">Dropdown</a></li>
36+
<li><a href="#resultsAdapter">Results</a></li>
37+
</ul>
38+
</li>
39+
<li>
40+
<a href="#setting-default-options">Setting default options</a>
41+
</li>
42+
<li>
43+
<a href="#backwards-compatibility">Backwards compatibility</a>
44+
<ul class="nav">
45+
<li><a href="#compat-matcher">Simplified function for matching data objects</a></li>
46+
<li><a href="#initSelection">Old initial selections with <code>initSelection</code></a></li>
47+
<li><a href="#query">Querying old data with <code>query</code></a></li>
48+
<li><a href="#input-fallback">Compatibility with <code>&lt;input type="text" /&gt;</code></a></li>
49+
</ul>
50+
</li>
51+
</ul>
52+
<a class="back-to-top" href="#top">
53+
Back to top
54+
</a>
55+
</nav>

‎docs/_includes/nav/options.html‎

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,53 @@
11
<nav class="s2-docs-sidebar hidden-print hidden-xs hidden-sm">
22
<ul class="nav s2-docs-sidenav">
33
<li>
4-
<a href="#core-options">Core Options</a>
4+
<a href="#core-options">Core options</a>
55
<ul class="nav">
6-
<li><a href="#data-attributes">Declaring configuration in the <code>data-*</code> attributes</a></li>
6+
<li><a href="#setting-default-options">Changing default options</a></li>
7+
<li><a href="#data-attributes">Declaring configuration in the HTML</a></li>
78
<li><a href="#amd">AMD compatibility</a></li>
8-
<li><a href="#core-options-display">Displaying selections</a></li>
9-
<li><a href="#core-options-results">Returning and displaying results</a></li>
109
</ul>
1110
</li>
1211
<li>
13-
<a href="#dropdown">Dropdown</a>
12+
<a href="#data-adapters">Data adapters</a>
1413
<ul class="nav">
15-
<li><a href="#dropdownParent">Attached to body</a></li>
16-
<li><a href="#dropdown-attachContainer">Attached below the container</a></li>
17-
<li><a href="#dropdown-search">Search</a></li>
18-
<li><a href="#dropdown-select-on-close">Select the highlighted option on close</a></li>
19-
<li><a href="#closeOnSelect">Close the dropdown when a result is selected</a></li>
14+
<li>
15+
<a href="#data-adapters-select-tag">Using a <code>&lt;select&gt;</code></a>
16+
</li>
17+
<li>
18+
<a href="#data">Loading data from an array</a>
19+
</li>
20+
<li>
21+
<a href="#ajax">Connecting to a remote data source</a>
22+
</li>
23+
</ul>
24+
</li>
25+
<li>
26+
<a href="#selections">Displaying selections</a>
27+
<ul class="nav">
28+
<li>
29+
<a href="#placeholder">Showing a placeholder</a>
30+
</li>
31+
<li>
32+
<a href="#allowClear">Clearing selections</a>
33+
</li>
34+
<li>
35+
<a href="#templateSelection">Templating</a>
36+
</li>
37+
</ul>
38+
</li>
39+
<li>
40+
<a href="#results">Displaying results</a>
41+
<ul class="nav">
42+
<li><a href="#can-i-change-when-search-results-are-loaded">Controlling result loading</a></li>
43+
<li><a href="#can-i-change-how-selecting-results-works">Making selections</a></li>
44+
<li><a href="#can-i-change-how-the-dropdown-is-placed">Placement</a></li>
2045
</ul>
2146
</li>
2247
<li>
2348
<a href="#events">Events</a>
2449
<ul class="nav">
25-
<li><a href="#events-public">Public events</a></li>
50+
<li><a href="#events-public">Public jQuery events</a></li>
2651
<li><a href="#events-internal">Internal events</a></li>
2752
</ul>
2853
</li>
@@ -37,10 +62,7 @@
3762
</ul>
3863
</li>
3964
<li>
40-
<a href="#setting-default-options">Setting default options</a>
41-
</li>
42-
<li>
43-
<a href="#backwards-compatibility">Backwards compatibility</a>
65+
<a href="#backwards-compatibility">Deprecated options</a>
4466
<ul class="nav">
4567
<li><a href="#compat-matcher">Simplified function for matching data objects</a></li>
4668
<li><a href="#initSelection">Old initial selections with <code>initSelection</code></a></li>

docs/_includes/options/adapters.html renamed to docs/_includes/options-old/adapters.html

File renamed without changes.

docs/_includes/options/backwards-compatibility.html renamed to docs/_includes/options-old/backwards-compatibility.html

File renamed without changes.

docs/_includes/options/core-options.html renamed to docs/_includes/options-old/core-options.html

File renamed without changes.

0 commit comments

Comments
 (0)