Swift Filter Cornerstone extension Documentation by SWTE v1.0


Swift Filter Cornerstone extension

Created: 07/10/2015
By: SWTE
Email: support@swte.ch

Thank you for purchasing our plugin. If you have any questions that are beyond the scope of this help file, please feel free to email us via our user page contact form here.


Table of Contents

  1. Overview
  2. Usage
  3. Attributes

A) Overview - top

Swift Filter Cornerstone extension helps you to insert Swfit Filter shortcodes into your WordPress page, so you will be able to use Swift Filter jQuery plugin in your WordPress projects.

With the Swift Filter plugin you can make any number of separate or connected custom filters on your WordPress site.

You can use any HTML input (text, radio, checkbox) or select elements as filter. You can set the container of the search, and the results by CSS selectors.


B) Usage - top

You can insert shortcodes from Cornerstone easily
Or you can use it as shortcode

[swiftfilter type="swf-text" container="#main" search_in="p" compare="in" child_only="false" autocomplete="true" name="test-filter" id="test-filter" show="fadeTo" hide="fadeTo" opacity="0.4"][/swiftfilter]


C) Attributes - top

Variable Default Type Description
container html string CSS selector for the container where the filtering will be applied
search_in article string CSS selector for elements where the filter will run. If the filter doesn't match the plugin will hide this container with the selected method. If the filter matches the plugin will unhide this element.
child string * CSS selector for child elements inside "search_in" container. By default the plugin search inside all child elements
child_only boolean false If this value is true the filter won't check the "search_in" container's content. The filtering will be applied only on child elements. If the filter doesn't matches in the childrens the plugin will hide the "search_in" container
autocomplete boolean true Autocomplete for text fields
type_end integer 0 Delaying the hide effect after the last keyup event. Every keyup event clears the timer. Works for text inputs only
show string fadeIn jQuery effect to show matched elements
custom_show_effect string empty string custom jQuery effect to show matched elements
hide string fadeOut jQuery effect to hide unmatched elements
custom_hide_effect string empty string custom jQuery effect to hide unmatched elements
duration_show integer 500 Duration for "show" jQuery effect
duration_hide integer 500 Duration for "hide" jQuery effect
show_param string|int empty string Custom parameter for custom "show" jQuery effect (eg: class name for addClass/removeClass)
hide_param string|int empty string Custom parameter for custom "hide" jQuery effect (eg: class name for addClass/removeClass)
opacity float 0.2 Opacity value for fadeTo effect
connect string|null null CSS selector of connected swiftfilter field(s)
compare string in Compare method:
  • in - contains the value
  • not_in - doesn't contain the value
  • equals - exact match
  • gt - grater than (numeric)
  • lt - less than (numeric)
  • gte - grater than or equals (numeric)
  • lte - less than or equals (numeric)
  • between - between the defined range eg: 10-20 (numeric)

SWTE

Go To Table of Contents