|
525
|
1 |
<!DOCTYPE html> |
|
|
2 |
<html lang="en"> |
|
|
3 |
<head> |
|
|
4 |
<meta charset="utf-8"> |
|
|
5 |
<title>Example: Remote Data via DataSource</title> |
|
|
6 |
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic"> |
|
|
7 |
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css"> |
|
|
8 |
<link rel="stylesheet" href="../assets/css/main.css"> |
|
|
9 |
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
|
10 |
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
|
11 |
<script src="../../build/yui/yui-min.js"></script> |
|
|
12 |
|
|
|
13 |
</head> |
|
|
14 |
<body> |
|
|
15 |
<!-- |
|
|
16 |
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> |
|
|
17 |
--> |
|
|
18 |
<div id="doc"> |
|
|
19 |
<div id="hd"> |
|
|
20 |
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1> |
|
|
21 |
</div> |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
<h1>Example: Remote Data via DataSource</h1> |
|
|
25 |
<div class="yui3-g"> |
|
|
26 |
<div class="yui3-u-3-4"> |
|
|
27 |
<div id="main"> |
|
|
28 |
<div class="content"><style scoped> |
|
|
29 |
#ac-input { width: 250px; } |
|
|
30 |
</style> |
|
|
31 |
|
|
|
32 |
<div class="intro"> |
|
|
33 |
<p> |
|
|
34 |
This example demonstrates how to provide autocomplete suggestions using a <a href="../datasource/index.html">DataSource</a> instance. While AutoComplete supports a variety of result sources without requiring a DataSource, using a DataSource can give you more control over how results are retrieved and processed, and also allows you to share data with other DataSource-based widgets on the page. |
|
|
35 |
</p> |
|
|
36 |
|
|
|
37 |
<p> |
|
|
38 |
Type in the name of a city in the US to see the suggestions. Ex. New York, Chicago, etc. |
|
|
39 |
</p> |
|
|
40 |
</div> |
|
|
41 |
|
|
|
42 |
<div class="example"> |
|
|
43 |
<div id="demo" class="yui3-skin-sam"> <!-- You need this skin class --> |
|
|
44 |
<label for="ac-input">US city:</label><br> |
|
|
45 |
<input id="ac-input" type="text"> |
|
|
46 |
</div> |
|
|
47 |
|
|
|
48 |
<script> |
|
|
49 |
YUI().use('autocomplete', 'autocomplete-highlighters', 'datasource-get', function (Y) { |
|
|
50 |
// Create a DataSource instance. |
|
|
51 |
var ds = new Y.DataSource.Get({ |
|
|
52 |
source: 'http://query.yahooapis.com/v1/public/yql?format=json' |
|
|
53 |
}); |
|
|
54 |
|
|
|
55 |
Y.one('#ac-input').plug(Y.Plugin.AutoComplete, { |
|
|
56 |
maxResults: 10, |
|
|
57 |
resultHighlighter: 'phraseMatch', |
|
|
58 |
resultTextLocator: function (result) { |
|
|
59 |
return result.name + ', ' + result.admin1.content + ', ' + result.country.content; |
|
|
60 |
}, |
|
|
61 |
|
|
|
62 |
// Use the DataSource instance as the result source. |
|
|
63 |
source: ds, |
|
|
64 |
|
|
|
65 |
// YQL query to use for each request. This will be appended to the URL |
|
|
66 |
// that was supplied to the DataSource's "source" config above. |
|
|
67 |
requestTemplate: '&q=select * from geo.places where text="{query}" and placeTypeName.content="Town" and country.content="United States"', |
|
|
68 |
|
|
|
69 |
// Custom result list locator to parse the results out of the YQL response. |
|
|
70 |
// This is necessary because YQL sometimes returns an array of results, and |
|
|
71 |
// sometimes just a single result that isn't in an array. |
|
|
72 |
resultListLocator: function (response) { |
|
|
73 |
var results = response[0].query.results && |
|
|
74 |
response[0].query.results.place; |
|
|
75 |
|
|
|
76 |
if (results && !Y.Lang.isArray(results)) { |
|
|
77 |
results = [results]; |
|
|
78 |
} |
|
|
79 |
|
|
|
80 |
return results || []; |
|
|
81 |
} |
|
|
82 |
}); |
|
|
83 |
}); |
|
|
84 |
</script> |
|
|
85 |
|
|
|
86 |
</div> |
|
|
87 |
|
|
|
88 |
<h2>HTML</h2> |
|
|
89 |
<p> |
|
|
90 |
<strong>Note:</strong> be sure to add the <code>yui3-skin-sam</code> classname to the |
|
|
91 |
page's <code><body></code> element or to a parent element of the widget in order to apply |
|
|
92 |
the default CSS skin. See <a href="http://yuilibrary.com/yui/docs/tutorials/skins/">Understanding Skinning</a>. |
|
|
93 |
</p> |
|
|
94 |
<pre class="code prettyprint"><div id="demo" class="yui3-skin-sam"> <!-- You need this skin class --> |
|
|
95 |
<label for="ac-input">US city:</label><br> |
|
|
96 |
<input id="ac-input" type="text"> |
|
|
97 |
</div></pre> |
|
|
98 |
|
|
|
99 |
|
|
|
100 |
<h2>JavaScript</h2> |
|
|
101 |
|
|
|
102 |
<pre class="code prettyprint">YUI().use('autocomplete', 'autocomplete-highlighters', 'datasource-get', function (Y) { |
|
|
103 |
// Create a DataSource instance. |
|
|
104 |
var ds = new Y.DataSource.Get({ |
|
|
105 |
source: 'http://query.yahooapis.com/v1/public/yql?format=json' |
|
|
106 |
}); |
|
|
107 |
|
|
|
108 |
Y.one('#ac-input').plug(Y.Plugin.AutoComplete, { |
|
|
109 |
maxResults: 10, |
|
|
110 |
resultHighlighter: 'phraseMatch', |
|
|
111 |
resultTextLocator: function (result) { |
|
|
112 |
return result.name + ', ' + result.admin1.content + ', ' + result.country.content; |
|
|
113 |
}, |
|
|
114 |
|
|
|
115 |
// Use the DataSource instance as the result source. |
|
|
116 |
source: ds, |
|
|
117 |
|
|
|
118 |
// YQL query to use for each request. This will be appended to the URL |
|
|
119 |
// that was supplied to the DataSource's "source" config above. |
|
|
120 |
requestTemplate: '&q=select * from geo.places where text="{query}" and placeTypeName.content="Town" and country.content="United States"', |
|
|
121 |
|
|
|
122 |
// Custom result list locator to parse the results out of the YQL response. |
|
|
123 |
// This is necessary because YQL sometimes returns an array of results, and |
|
|
124 |
// sometimes just a single result that isn't in an array. |
|
|
125 |
resultListLocator: function (response) { |
|
|
126 |
var results = response[0].query.results && |
|
|
127 |
response[0].query.results.place; |
|
|
128 |
|
|
|
129 |
if (results && !Y.Lang.isArray(results)) { |
|
|
130 |
results = [results]; |
|
|
131 |
} |
|
|
132 |
|
|
|
133 |
return results || []; |
|
|
134 |
} |
|
|
135 |
}); |
|
|
136 |
});</pre> |
|
|
137 |
|
|
|
138 |
|
|
|
139 |
<h2>Complete Example Source</h2> |
|
|
140 |
|
|
|
141 |
<pre class="code prettyprint"><div id="demo" class="yui3-skin-sam"> <!-- You need this skin class --> |
|
|
142 |
<label for="ac-input">US city:</label><br> |
|
|
143 |
<input id="ac-input" type="text"> |
|
|
144 |
</div> |
|
|
145 |
|
|
|
146 |
<script> |
|
|
147 |
YUI().use('autocomplete', 'autocomplete-highlighters', 'datasource-get', function (Y) { |
|
|
148 |
// Create a DataSource instance. |
|
|
149 |
var ds = new Y.DataSource.Get({ |
|
|
150 |
source: 'http://query.yahooapis.com/v1/public/yql?format=json' |
|
|
151 |
}); |
|
|
152 |
|
|
|
153 |
Y.one('#ac-input').plug(Y.Plugin.AutoComplete, { |
|
|
154 |
maxResults: 10, |
|
|
155 |
resultHighlighter: 'phraseMatch', |
|
|
156 |
resultTextLocator: function (result) { |
|
|
157 |
return result.name + ', ' + result.admin1.content + ', ' + result.country.content; |
|
|
158 |
}, |
|
|
159 |
|
|
|
160 |
// Use the DataSource instance as the result source. |
|
|
161 |
source: ds, |
|
|
162 |
|
|
|
163 |
// YQL query to use for each request. This will be appended to the URL |
|
|
164 |
// that was supplied to the DataSource's "source" config above. |
|
|
165 |
requestTemplate: '&q=select * from geo.places where text="{query}" and placeTypeName.content="Town" and country.content="United States"', |
|
|
166 |
|
|
|
167 |
// Custom result list locator to parse the results out of the YQL response. |
|
|
168 |
// This is necessary because YQL sometimes returns an array of results, and |
|
|
169 |
// sometimes just a single result that isn't in an array. |
|
|
170 |
resultListLocator: function (response) { |
|
|
171 |
var results = response[0].query.results && |
|
|
172 |
response[0].query.results.place; |
|
|
173 |
|
|
|
174 |
if (results && !Y.Lang.isArray(results)) { |
|
|
175 |
results = [results]; |
|
|
176 |
} |
|
|
177 |
|
|
|
178 |
return results || []; |
|
|
179 |
} |
|
|
180 |
}); |
|
|
181 |
}); |
|
|
182 |
</script></pre> |
|
|
183 |
|
|
|
184 |
</div> |
|
|
185 |
</div> |
|
|
186 |
</div> |
|
|
187 |
|
|
|
188 |
<div class="yui3-u-1-4"> |
|
|
189 |
<div class="sidebar"> |
|
|
190 |
|
|
|
191 |
|
|
|
192 |
|
|
|
193 |
<div class="sidebox"> |
|
|
194 |
<div class="hd"> |
|
|
195 |
<h2 class="no-toc">Examples</h2> |
|
|
196 |
</div> |
|
|
197 |
|
|
|
198 |
<div class="bd"> |
|
|
199 |
<ul class="examples"> |
|
|
200 |
|
|
|
201 |
|
|
|
202 |
<li data-description="How to provide autocomplete suggestions from a local array."> |
|
|
203 |
<a href="ac-local.html">Basic Local Data</a> |
|
|
204 |
</li> |
|
|
205 |
|
|
|
206 |
|
|
|
207 |
|
|
|
208 |
<li data-description="How to provide autocomplete suggestions using a remote JSONP source."> |
|
|
209 |
<a href="ac-jsonp.html">Remote Data via JSONP</a> |
|
|
210 |
</li> |
|
|
211 |
|
|
|
212 |
|
|
|
213 |
|
|
|
214 |
<li data-description="How to provide autocomplete suggestions using a YQL query source."> |
|
|
215 |
<a href="ac-yql.html">Remote Data via YQL</a> |
|
|
216 |
</li> |
|
|
217 |
|
|
|
218 |
|
|
|
219 |
|
|
|
220 |
<li data-description="How to provide autocomplete suggestions using a DataSource instance."> |
|
|
221 |
<a href="ac-datasource.html">Remote Data via DataSource</a> |
|
|
222 |
</li> |
|
|
223 |
|
|
|
224 |
|
|
|
225 |
|
|
|
226 |
<li data-description="How to implement delimited tag completion."> |
|
|
227 |
<a href="ac-tagging.html">Tag Completion Using Query Delimiters</a> |
|
|
228 |
</li> |
|
|
229 |
|
|
|
230 |
|
|
|
231 |
|
|
|
232 |
<li data-description="How to find and select Flickr photos using a YQL source and a custom autocomplete result formatter."> |
|
|
233 |
<a href="ac-flickr.html">Find Photos on Flickr (Custom Formatting, YQL Source)</a> |
|
|
234 |
</li> |
|
|
235 |
|
|
|
236 |
|
|
|
237 |
|
|
|
238 |
<li data-description="How to use autocomplete-base to filter a set of existing items on a page."> |
|
|
239 |
<a href="ac-filter.html">Filter a Set of Existing Items on a Page</a> |
|
|
240 |
</li> |
|
|
241 |
|
|
|
242 |
|
|
|
243 |
|
|
|
244 |
<li data-description="How to find an address using a YQL source calling Google's Geocoding Service"> |
|
|
245 |
<a href="ac-geocode.html">Address Completion on Google's Geocoding Service</a> |
|
|
246 |
</li> |
|
|
247 |
|
|
|
248 |
|
|
|
249 |
</ul> |
|
|
250 |
</div> |
|
|
251 |
</div> |
|
|
252 |
|
|
|
253 |
|
|
|
254 |
|
|
|
255 |
</div> |
|
|
256 |
</div> |
|
|
257 |
</div> |
|
|
258 |
</div> |
|
|
259 |
|
|
|
260 |
<script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
|
261 |
<script>prettyPrint();</script> |
|
|
262 |
|
|
|
263 |
<script> |
|
|
264 |
YUI.Env.Tests = { |
|
|
265 |
examples: [], |
|
|
266 |
project: '../assets', |
|
|
267 |
assets: '../assets/autocomplete', |
|
|
268 |
name: 'ac-datasource', |
|
|
269 |
title: 'Remote Data via DataSource', |
|
|
270 |
newWindow: '', |
|
|
271 |
auto: false |
|
|
272 |
}; |
|
|
273 |
YUI.Env.Tests.examples.push('ac-local'); |
|
|
274 |
YUI.Env.Tests.examples.push('ac-jsonp'); |
|
|
275 |
YUI.Env.Tests.examples.push('ac-yql'); |
|
|
276 |
YUI.Env.Tests.examples.push('ac-datasource'); |
|
|
277 |
YUI.Env.Tests.examples.push('ac-tagging'); |
|
|
278 |
YUI.Env.Tests.examples.push('ac-flickr'); |
|
|
279 |
YUI.Env.Tests.examples.push('ac-filter'); |
|
|
280 |
YUI.Env.Tests.examples.push('ac-geocode'); |
|
|
281 |
|
|
|
282 |
</script> |
|
|
283 |
<script src="../assets/yui/test-runner.js"></script> |
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
</body> |
|
|
288 |
</html> |