Labs/Ubiquity/Writing A Search Command: Difference between revisions

Line 142: Line 142:
==== title ====
==== title ====
Selector for the title of the result. If using the html parser, it can alternatively be a function that receives a single argument (the jQuery result object) and must return a string that will be used as title.
Selector for the title of the result. If using the html parser, it can alternatively be a function that receives a single argument (the jQuery result object) and must return a string that will be used as title.
'''NB:''' This options is required if you use the parser.


==== preview ====
==== preview ====
Selector for the preview of the result. If using the html parser, it can alternatively be a function that receives a single argument (the jQuery result object) and must return a string that will be used as preview.
Selector for the preview of the result. If using the html parser, it can alternatively be a function that receives a single argument (the jQuery result object) and must return a string that will be used as preview.
==== href ====
Selector for the preview of the result. If using the html parser, it can alternatively be a function that receives a single argument (the jQuery result object) and must return a string that will be used as preview.
'''NB:''' This option can usually be left out. If not present, mSC will attempt to find an anchor in the result matched by the [[#title]] option.


==== thumbnail ====
==== thumbnail ====
Selector for the preview of the result. If this does not match an image element, mSC will look for a child element that is an image, and use the first found as thumbnail.


==== maxResults ====
==== maxResults ====
 
Integer specifying the maximum number of results displayed in the Ubiquity preview. If not specified, it will default to 4.
==== href ====


==== baseurl ====
==== baseurl ====
String used as base url if [[#href]] is found to be relative.


== Examples ==
== Examples ==
47

edits