This Widget API displays Search Filter bar on UI. This widget works in conjunction with other widgets to provide different filters and sort options. Filters Widget can establish communication with another Widget so that when a filter is applying using Filters Widget, the filter information is passed to data Widgets to reload themselves with new filter parameters. This makes it easy to put together a site with all the extensive Search and Filter options available.

 

Note this filter can only work with Video filters.

 

Below is an example of how Filters widget can be used.  


Sample Code

 

<div class="filters"></div>
<div class="featured-videos"></div>
<script type="text/javascript" src="http://video.lexcorpinc.com/JavaScript/bundles/widgets.js"></script>
<script type="text/javascript">
    var videosFeaturedRef = vidizmo.videos.channel('.featured-videos');
    var filterRef = vidizmo.videos.filters('.filters');
    vidizmo.widgets.talk(videosFeaturedRef, filterRef);    
</script>

 

In this example, following API call, ‘vidizmo.widgets.talk’ establishes a communication channel between both Widgets and therefore any events raised by the ‘vidizmo.videos.filter’ the widget is handled by ‘vidizmo.videos.channel’ widget.  

 

vidizmo.widgets.talk(videosFeaturedRef, filterRef);

 

Likewise, such communication can be established between other widgets under ‘vidizmo.videos’ namespace, with the exception of ‘vidizmo.videos.embed’ widget. 


Properties


Video widgets expose following properties that can be overridden.

 

Properties
Description
default_text
Default text  on search box
background_color
Background  color of filter
display_refresh_button
Show refresh  button on filter
display_filter_button
Show filter  button on filter
display_search_type
Show search  type filter
display_view_buttons
Show view  buttons on filter
display_list_view
Show list  view button on filter
display_grid_view
Show grid  view button on filter
display_details_view
Show detail  view button on filter
display_categories
Show  categories on filter
display_mashuptype
Show mashup  type filter
display_mashup_format
Show mashup  format filter
display_search_box
Show search  box on filter
display_draft
Show draft  option on filter
display_createdby
Show created  by option on filter
display_review_filters
Show review  filter
display_review_filter_pending
Show review  filter pending option
display_review_filter_rejected
Show review  filter rejected option
display_review_filter_published
Show review  filter published option
display_live_filter
Show live  filter
display_purchase
Show purchase  filter
display_marketplace
Show  marketplace filter

 


To learn more how these Widgets work, click here on VIDIZMO Widgets API Implementation.

For a complete list of VIDIZMO APIs, click here on VIDIZMO Developer APIs.