jsdoc

$.ui.simplicityFancyFacets

Namespace $.ui.simplicityFancyFacets

Composed variant of simplicityFancySelect with support for a flyout and selected area. A more complex extension of simplicityFancySelect that supports a flyout for extra options as well as a selected area for the current selection.
Defined in: ui.simplicityFancyFacets.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityFancyFacets.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityFancyFacets.closeOverflow()
Closes the overflow if it is open.
<static>  
$.ui.simplicityFancyFacets.openOverflow()
Opens the overflow if it is closed.
<static>  
$.ui.simplicityFancyFacets.select()
Returns the target select input.
<static>  
$.ui.simplicityFancyFacets.size()
Returns the total number of options currently displayed.
Namespace Detail
$.ui.simplicityFancyFacets
  <select id="mySelect" name="example">
    <option value="1">one</option>
    <option value="2">two</option>
    <option value="3">three</option>
  <select>
  <div id="myFancy"></div>
  <script type="text/javascript">
    $('#myFancy')
      .simplicityFancyFacets({
        select: '#mySelect',
      })
     .hide();
  </script>
Field Detail
<static> $.ui.simplicityFancyFacets.options
Widget options.
select
Mandatory option that points to the select input to be enhanced. Can be a DOM node, jQuery node or selector.
selectedArea
When true causes selected options to appear in the selected area. Defaults to false.
availableContainsSelected
When true causes selected options to appear in the available area. Defaults to true.
overflowContainsAvailable
When true causes availble options to appear in the overflow area. Defaults to false.
overflowContainsSelected
When true causes selected options to appear in the overflow area. Defaults to true.
availableLimit
Determines how many options should appear in the available area. A negative number indicates no limit. Defaults to 5.
hideWhenEmpty
When true the target element is hidden if the total number of options drops to zero and shown when it is larger. Defaults to false.
template
When '' falls back on the original DOM contents of the attached element. Replaces the contents otherwise. See source code for default value.
availableTemplate
The default template to use for the available facets block of simplicityFancySelect, (selector '.ui-simplicity-fancy-facets-available-container'). Also acts as the default for selectedTemplate and overflowTemplate.

Default:

<ul class="ui-simplicity-fancy-select-options ui-helper-clearfix">
 <li class="ui-simplicity-fancy-select-option ui-helper-clearfix">
   <a href="#" class="ui-simplicity-fancy-select-label"/>
   <span class="ui-simplicity-fancy-select-count"/>
 </li>
</ul>
selectedTemplate
When '' falls back to the value for option availableTemplate. Otherwise it determines the template to use for simplicityFancySelect when rendering the selected facets (selector '.ui-simplicity-fancy-facets-selected-container'). Default is ''.
overflowTemplate
When '' falls back to the value for option availableTemplate. Otherwise it determines the template to use for simplicityFancySelect when rendering the overflow facets (selector '.ui-simplicity-fancy-facets-overflow-container'). Default is ''.
pathTemplate
When '' falls back to the value for option availableTemplate. Otherwise it determines the template to use for simplicityFancySelect when rendering the facets navigation path (selector '.ui-simplicity-fancy-facets-path-container'). Default is ''.
Method Detail
<static> $.ui.simplicityFancyFacets.closeOverflow()
Closes the overflow if it is open.

<static> $.ui.simplicityFancyFacets.openOverflow()
Opens the overflow if it is closed.

<static> $.ui.simplicityFancyFacets.select()
Returns the target select input.

<static> $.ui.simplicityFancyFacets.size()
Returns the total number of options currently displayed.

Documentation generated by JsDoc Toolkit 2.4.0